Common Parameter: importOptions

CASL Syntax

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

Parameters for fileType="ANY"

contents=TRUE | FALSE

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default TRUE
fileExtList={"string-1" <, "string-2", ...>}

specifies the file extensions for subsetting the files to import.

recurse=TRUE | FALSE

recursively import files when the caslib definition permits access to subdirectories.

Default TRUE

Parameters for fileType="AUDIO" | "SOUND"

contents=TRUE | FALSE

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default TRUE
fileExtList={"WAV"}

specifies the file extensions for subsetting the files to import.

Default wav
recurse=TRUE | FALSE

recursively import files when the caslib definition permits access to subdirectories.

Default TRUE

Parameters for fileType="AUTO"

No parameters apply when you specify AUTO.

Parameters for fileType="BASESAS"

alter="string"

specifies the Alter password for the SAS data set.

charMultiplier=double

specifies a multiplier value to expand fixed-width character variables that might require transcoding. The lengths are increased to avoid character data truncation. The lengths are increased by multiplying the length by the specified value.

Default 1
Range 1–5
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

specifies how data is transferred between the data source and SAS Cloud Analytic Services.

Default AUTO
encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

password="string"

specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.

read="string"

specifies the Read password for the SAS data set.

varcharConversion=double

specifies the number of bytes to use as a threshold. When a column with the CHAR data type has a length that is equal to or exceeds the specified number of bytes, the VARCHAR data type is used.

Default 0
Range 1–32767
write="string"

specifies the Write password for the SAS data set.

Parameters for fileType="CSV" | "DELIMITED"

allowEmbeddedNewLines=TRUE | FALSE

when set to True, line feed and carriage return characters are ignored when they are in a field that is enclosed in quotation marks. A line feed character has the ASCII value 10 and the carriage return character has a value of 13. Only the double quotation mark character (") is supported for ignoring the two characters. By default, loadTable will not check for new lines within quoted strings.

Default FALSE
allowTruncation=TRUE | FALSE

specifies that truncation of character data that is too long for a given field is allowed.

Default TRUE
archiveType="string"

Specify compressed CSV archive type, valid archive types are 'gz' and 'zip'.

delimiter="string"

specifies the field delimiter. The delimiter can be a single 7-bit character, or 'TAB', or '^[@A-Z]', or one of [\\, \0, \a, \b, \t, \v, \f]. Multi-byte UTF-8 characters are not valid. The ^A value corresponds to the 0X01 that is commonly used with Apache Hive.

Default ","
encoding="string"

specifies the text encoding of the file. If you do not specify this parameter, then the session encoding is used.

Default "utf-8"
getNames=TRUE | FALSE

when set to True, the values in the first line of the file are used as variable names.

Default TRUE
guessRows=64-bit-integer

specifies the number of rows to scan in order to determine data types for variables.

Default 20
Minimum value 1
locale="string"

specifies the locale for interpreting data in the file

multiFile=TRUE | FALSE

when set to True, the server attempts to load all CSV files from the specified path into a single in-memory table. The files must have the same number of columns and the same column data types.

Default FALSE
nThreads=integer

specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.

Default 0
Minimum value 0
pathAsColumn=TRUE | FALSE

when set to True, path column/value pairs are added to table.

Default FALSE
quotedDataAsString=TRUE | FALSE

when set to True, quoted data are strings.

Default FALSE
readSequential=TRUE | FALSE

when set to True, the delimited file is read sequentially so that error messages from parsing can indicate the line number for the problem.

Default FALSE
recurse=TRUE | FALSE

recursively import files when the caslib definition permits access to subdirectories.

Default TRUE
showFile=TRUE | FALSE

when this parameter and multiFile are set to True, each row includes a column that identifies the CSV file name that contributed the row.

Default FALSE
showFullPath=TRUE | FALSE

when this parameter and multiFile are set to True, each row includes a column that identifies the fully-qualified path, including the file name, to the CSV file that contributed the row.

Default FALSE
showPath=TRUE | FALSE

when this parameter and multiFile are set to True, each row includes a column that identifies the fully-qualified directory path to the CSV file that contributed the row.

Default FALSE
stripBlanks=TRUE | FALSE

removes leading and trailing blanks from character variables.

Default FALSE
varChars=TRUE | FALSE

when set to True, variable-length strings are used for character variables.

Default TRUE
vars={{casvarcsvdesc-1} <, {casvarcsvdesc-2}, ...>}

specifies the names, types, formats, and other metadata for variables.

The casvarcsvdesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

informat="string"

specifies the informat to apply to the variable.

label="string"

specifies the descriptive label for the variable.

length=integer

specifies the unformatted length of the variable. This parameter applies to fixed-length character variables (type="CHAR") only.

Default 8
Minimum value 1
name="string"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

type="BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"

specifies the data type for the variable.

Default DOUBLE

Parameters for fileType="DOCUMENT"

contents=TRUE | FALSE

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default TRUE
fileExtList={"CSV", "DOC", "DOCX", "EPUB", "HTML", "KEY", "MBOX", "MSG", "NUMBERS", "ODP", "ODS", "ODT", "PAGES", "PDF", "PPT", "PPTX", "PST", "RTF", "TNEF", "TXT", "WPD", "XLS", "XLSX", "XML"}

specifies the file extensions for subsetting the files to import.

Default {'html','xml','doc','docx','xls','xlsx','ppt','pptx','odt','ods','odp','pages','numbers','key','wpd','pdf','epub','rtf','txt','mbox','msg','tnef','pst','csv'}
recurse=TRUE | FALSE

recursively import files when the caslib definition permits access to subdirectories.

Default TRUE
tikaConv=TRUE | FALSE

specifies to convert the documents with the Apache Tika document conversion library.

Default FALSE

Parameters for fileType="DTA"

No parameters apply when you specify DTA.

Parameters for fileType="ESP"

maxTime=integer

specifies the number of seconds to receive data from SAS Event Stream Processing before declaring an end of file on the stream. The data is read until an end of file is found, and then the action stops running.

Default 5
sasTypes=TRUE | FALSE

when set to True, the table is created with character and float data types only. When set to False, the table uses the same data types that are used in the ESP event.

Default FALSE

Parameters for fileType="EXCEL"

getNames=TRUE | FALSE

when set to True, the values in the first line of the file are used as variable names.

Default TRUE
getSheetNames=TRUE | FALSE

when set to True, the sheet names are written to a CAS table.

Default FALSE
range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

Parameters for fileType="FMT"

name="string"

specifies a file system path and filename. The file must be a SAS item store that includes the formats to import.

Parameters for fileType="HDAT"

backingStore="CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

specifies the backing store to use for an in-memory table. If you specify a setting when you load one table, it overrides the setting for the caslib. If you specify a setting when you add a caslib, it applies to all tables in the caslib.

Default INHERIT
CASDISKCACHE

specifies to make a copy of the blocks for an in-memory table. The blocks are stored in the directories identified by the CAS_DISK_CACHE environment variable at server start-up.

INHERIT

specifies to map the blocks for an in-memory table according to inherited rules of precedence. When used with loading tables, the backing store setting is inherited from the caslib. When adding a caslib, the setting is inherited from the server. The server setting can be specified in the CAS_LOADTABLEBACKINGSTORE environment variable. Valid values are CASDISKCACHE or INPLACEPREFERRED. The default value is CASDISKCACHE.

INPLACEPREFERRED

specifies to use the blocks from an existing SASHDAT file for memory mapping. If the existing blocks cannot be used, then copies of the blocks are used as described for CASDISKCACHE. The most common reason that prevent using existing blocks is when the SASHDAT file is encrypted. This setting prevents removing or replacing a SASHDAT file when the server is running Microsoft Windows.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for fileType="IMAGE"

contents=TRUE | FALSE

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default TRUE
decode=TRUE | FALSE

when set to True, the server attempts to determine the dimensions, resolution, and format of each file.

Default FALSE
fileExtList={"BMP", "DIB", "JP2", "JPE", "JPEG", "JPG", "PBM", "PGM", "PIF", "PNG", "PNM", "PPM", "PXM", "TIF", "TIFF", "WEB", "WEBP"}

specifies the file extensions for subsetting the files to import.

Default {'web','pgm','bmp','jpg','jpeg','tif','pbm','pif','webp','jpe','jp2','dib','pnm','pxm','png','ppm','tiff'}
recurse=TRUE | FALSE

recursively import files when the caslib definition permits access to subdirectories.

Default TRUE

Parameters for fileType="JMP"

No parameters apply when you specify JMP.

Parameters for fileType="LASR"

compPgm="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

compVars={"string-1" <, "string-2", ...>}

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

nThreads=integer

specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.

Default 0
Minimum value 0
parallelMode="FALLBACK" | "FORCE" | "NONE"

specifies how the table is transferred from SAS LASR Analytic Server to SAS Cloud Analytic Services.

Default FALLBACK
FALLBACK

specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

FORCE

specifies to perform a parallel load. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

NONE

specifies to perform a serial load.

preserveOrder=TRUE | FALSE

when set to True, the rows are inserted into the new table in the same order as they are received from the SAS LASR Analytic Server. Creating the table is less efficient when this parameter is used.

Default FALSE
varchars=TRUE | FALSE

when set to True, variable-length strings are used for character variables.

Default FALSE
vars={"string-1" <, "string-2", ...>}

specifies the variables to use in the action.

where="where-expression"

specifies an expression for subsetting the input data.

Parameters for fileType="PARQUET"

varChars=TRUE | FALSE

when set to True, variable-length strings are used for character variables.

Default FALSE

Parameters for fileType="SPSS"

No parameters apply when you specify SPSS.

Parameters for fileType="VIDEO"

contents=TRUE | FALSE

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default TRUE
fileExtList={"AVI", "MOV", "MP4", "MPG", "WMV"}

specifies the file extensions for subsetting the files to import.

Default {'mpg','wmv','mov','mp4','avi'}
recurse=TRUE | FALSE

recursively import files when the caslib definition permits access to subdirectories.

Default TRUE

Parameters for fileType="XLS"

getNames=TRUE | FALSE

when set to True, the values in the first line of the file are used as variable names.

Default TRUE
range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

Lua Syntax

importOptions={fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

Parameters for fileType="ANY"

contents=true | false

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default true
fileExtList={"string-1" <, "string-2", ...>}

specifies the file extensions for subsetting the files to import.

recurse=true | false

recursively import files when the caslib definition permits access to subdirectories.

Default true

Parameters for fileType="AUDIO" | "SOUND"

contents=true | false

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default true
fileExtList={"WAV"}

specifies the file extensions for subsetting the files to import.

Default wav
recurse=true | false

recursively import files when the caslib definition permits access to subdirectories.

Default true

Parameters for fileType="AUTO"

No parameters apply when you specify AUTO.

Parameters for fileType="BASESAS"

alter="string"

specifies the Alter password for the SAS data set.

charMultiplier=double

specifies a multiplier value to expand fixed-width character variables that might require transcoding. The lengths are increased to avoid character data truncation. The lengths are increased by multiplying the length by the specified value.

Default 1
Range 1–5
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

specifies how data is transferred between the data source and SAS Cloud Analytic Services.

Default AUTO
encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

password="string"

specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.

read="string"

specifies the Read password for the SAS data set.

varcharConversion=double

specifies the number of bytes to use as a threshold. When a column with the CHAR data type has a length that is equal to or exceeds the specified number of bytes, the VARCHAR data type is used.

Default 0
Range 1–32767
write="string"

specifies the Write password for the SAS data set.

Parameters for fileType="CSV" | "DELIMITED"

allowEmbeddedNewLines=true | false

when set to True, line feed and carriage return characters are ignored when they are in a field that is enclosed in quotation marks. A line feed character has the ASCII value 10 and the carriage return character has a value of 13. Only the double quotation mark character (") is supported for ignoring the two characters. By default, loadTable will not check for new lines within quoted strings.

Default false
allowTruncation=true | false

specifies that truncation of character data that is too long for a given field is allowed.

Default true
archiveType="string"

Specify compressed CSV archive type, valid archive types are 'gz' and 'zip'.

delimiter="string"

specifies the field delimiter. The delimiter can be a single 7-bit character, or 'TAB', or '^[@A-Z]', or one of [\\, \0, \a, \b, \t, \v, \f]. Multi-byte UTF-8 characters are not valid. The ^A value corresponds to the 0X01 that is commonly used with Apache Hive.

Default ","
encoding="string"

specifies the text encoding of the file. If you do not specify this parameter, then the session encoding is used.

Default "utf-8"
getNames=true | false

when set to True, the values in the first line of the file are used as variable names.

Default true
guessRows=64-bit-integer

specifies the number of rows to scan in order to determine data types for variables.

Default 20
Minimum value 1
locale="string"

specifies the locale for interpreting data in the file

multiFile=true | false

when set to True, the server attempts to load all CSV files from the specified path into a single in-memory table. The files must have the same number of columns and the same column data types.

Default false
nThreads=integer

specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.

Default 0
Minimum value 0
pathAsColumn=true | false

when set to True, path column/value pairs are added to table.

Default false
quotedDataAsString=true | false

when set to True, quoted data are strings.

Default false
readSequential=true | false

when set to True, the delimited file is read sequentially so that error messages from parsing can indicate the line number for the problem.

Default false
recurse=true | false

recursively import files when the caslib definition permits access to subdirectories.

Default true
showFile=true | false

when this parameter and multiFile are set to True, each row includes a column that identifies the CSV file name that contributed the row.

Default false
showFullPath=true | false

when this parameter and multiFile are set to True, each row includes a column that identifies the fully-qualified path, including the file name, to the CSV file that contributed the row.

Default false
showPath=true | false

when this parameter and multiFile are set to True, each row includes a column that identifies the fully-qualified directory path to the CSV file that contributed the row.

Default false
stripBlanks=true | false

removes leading and trailing blanks from character variables.

Default false
varChars=true | false

when set to True, variable-length strings are used for character variables.

Default true
vars={{casvarcsvdesc-1} <, {casvarcsvdesc-2}, ...>}

specifies the names, types, formats, and other metadata for variables.

The casvarcsvdesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

informat="string"

specifies the informat to apply to the variable.

label="string"

specifies the descriptive label for the variable.

length=integer

specifies the unformatted length of the variable. This parameter applies to fixed-length character variables (type="CHAR") only.

Default 8
Minimum value 1
name="string"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

type="BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"

specifies the data type for the variable.

Default DOUBLE

Parameters for fileType="DOCUMENT"

contents=true | false

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default true
fileExtList={"CSV", "DOC", "DOCX", "EPUB", "HTML", "KEY", "MBOX", "MSG", "NUMBERS", "ODP", "ODS", "ODT", "PAGES", "PDF", "PPT", "PPTX", "PST", "RTF", "TNEF", "TXT", "WPD", "XLS", "XLSX", "XML"}

specifies the file extensions for subsetting the files to import.

Default {'html','xml','doc','docx','xls','xlsx','ppt','pptx','odt','ods','odp','pages','numbers','key','wpd','pdf','epub','rtf','txt','mbox','msg','tnef','pst','csv'}
recurse=true | false

recursively import files when the caslib definition permits access to subdirectories.

Default true
tikaConv=true | false

specifies to convert the documents with the Apache Tika document conversion library.

Default false

Parameters for fileType="DTA"

No parameters apply when you specify DTA.

Parameters for fileType="ESP"

maxTime=integer

specifies the number of seconds to receive data from SAS Event Stream Processing before declaring an end of file on the stream. The data is read until an end of file is found, and then the action stops running.

Default 5
sasTypes=true | false

when set to True, the table is created with character and float data types only. When set to False, the table uses the same data types that are used in the ESP event.

Default false

Parameters for fileType="EXCEL"

getNames=true | false

when set to True, the values in the first line of the file are used as variable names.

Default true
getSheetNames=true | false

when set to True, the sheet names are written to a CAS table.

Default false
range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

Parameters for fileType="FMT"

name="string"

specifies a file system path and filename. The file must be a SAS item store that includes the formats to import.

Parameters for fileType="HDAT"

backingStore="CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

specifies the backing store to use for an in-memory table. If you specify a setting when you load one table, it overrides the setting for the caslib. If you specify a setting when you add a caslib, it applies to all tables in the caslib.

Default INHERIT
CASDISKCACHE

specifies to make a copy of the blocks for an in-memory table. The blocks are stored in the directories identified by the CAS_DISK_CACHE environment variable at server start-up.

INHERIT

specifies to map the blocks for an in-memory table according to inherited rules of precedence. When used with loading tables, the backing store setting is inherited from the caslib. When adding a caslib, the setting is inherited from the server. The server setting can be specified in the CAS_LOADTABLEBACKINGSTORE environment variable. Valid values are CASDISKCACHE or INPLACEPREFERRED. The default value is CASDISKCACHE.

INPLACEPREFERRED

specifies to use the blocks from an existing SASHDAT file for memory mapping. If the existing blocks cannot be used, then copies of the blocks are used as described for CASDISKCACHE. The most common reason that prevent using existing blocks is when the SASHDAT file is encrypted. This setting prevents removing or replacing a SASHDAT file when the server is running Microsoft Windows.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for fileType="IMAGE"

contents=true | false

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default true
decode=true | false

when set to True, the server attempts to determine the dimensions, resolution, and format of each file.

Default false
fileExtList={"BMP", "DIB", "JP2", "JPE", "JPEG", "JPG", "PBM", "PGM", "PIF", "PNG", "PNM", "PPM", "PXM", "TIF", "TIFF", "WEB", "WEBP"}

specifies the file extensions for subsetting the files to import.

Default {'web','pgm','bmp','jpg','jpeg','tif','pbm','pif','webp','jpe','jp2','dib','pnm','pxm','png','ppm','tiff'}
recurse=true | false

recursively import files when the caslib definition permits access to subdirectories.

Default true

Parameters for fileType="JMP"

No parameters apply when you specify JMP.

Parameters for fileType="LASR"

compPgm="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

compVars={"string-1" <, "string-2", ...>}

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

nThreads=integer

specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.

Default 0
Minimum value 0
parallelMode="FALLBACK" | "FORCE" | "NONE"

specifies how the table is transferred from SAS LASR Analytic Server to SAS Cloud Analytic Services.

Default FALLBACK
FALLBACK

specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

FORCE

specifies to perform a parallel load. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

NONE

specifies to perform a serial load.

preserveOrder=true | false

when set to True, the rows are inserted into the new table in the same order as they are received from the SAS LASR Analytic Server. Creating the table is less efficient when this parameter is used.

Default false
varchars=true | false

when set to True, variable-length strings are used for character variables.

Default false
vars={"string-1" <, "string-2", ...>}

specifies the variables to use in the action.

where="where-expression"

specifies an expression for subsetting the input data.

Parameters for fileType="PARQUET"

varChars=true | false

when set to True, variable-length strings are used for character variables.

Default false

Parameters for fileType="SPSS"

No parameters apply when you specify SPSS.

Parameters for fileType="VIDEO"

contents=true | false

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default true
fileExtList={"AVI", "MOV", "MP4", "MPG", "WMV"}

specifies the file extensions for subsetting the files to import.

Default {'mpg','wmv','mov','mp4','avi'}
recurse=true | false

recursively import files when the caslib definition permits access to subdirectories.

Default true

Parameters for fileType="XLS"

getNames=true | false

when set to True, the values in the first line of the file are used as variable names.

Default true
range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

Python Syntax

importOptions={"fileType":"ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters}

Parameters for fileType="ANY"

"contents":True | False

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default True
"fileExtList":["string-1" <, "string-2", ...>]

specifies the file extensions for subsetting the files to import.

"recurse":True | False

recursively import files when the caslib definition permits access to subdirectories.

Default True

Parameters for fileType="AUDIO" | "SOUND"

"contents":True | False

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default True
"fileExtList":["WAV"]

specifies the file extensions for subsetting the files to import.

Default wav
"recurse":True | False

recursively import files when the caslib definition permits access to subdirectories.

Default True

Parameters for fileType="AUTO"

No parameters apply when you specify AUTO.

Parameters for fileType="BASESAS"

"alter":"string"

specifies the Alter password for the SAS data set.

"charMultiplier":double

specifies a multiplier value to expand fixed-width character variables that might require transcoding. The lengths are increased to avoid character data truncation. The lengths are increased by multiplying the length by the specified value.

Default 1
Range 1–5
"dataTransferMode":"AUTO" | "PARALLEL" | "SERIAL"

specifies how data is transferred between the data source and SAS Cloud Analytic Services.

Default AUTO
"encryptionPassword":"string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

"password":"string"

specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.

"read":"string"

specifies the Read password for the SAS data set.

"varcharConversion":double

specifies the number of bytes to use as a threshold. When a column with the CHAR data type has a length that is equal to or exceeds the specified number of bytes, the VARCHAR data type is used.

Default 0
Range 1–32767
"write":"string"

specifies the Write password for the SAS data set.

Parameters for fileType="CSV" | "DELIMITED"

"allowEmbeddedNewLines":True | False

when set to True, line feed and carriage return characters are ignored when they are in a field that is enclosed in quotation marks. A line feed character has the ASCII value 10 and the carriage return character has a value of 13. Only the double quotation mark character (") is supported for ignoring the two characters. By default, loadTable will not check for new lines within quoted strings.

Default False
"allowTruncation":True | False

specifies that truncation of character data that is too long for a given field is allowed.

Default True
"archiveType":"string"

Specify compressed CSV archive type, valid archive types are 'gz' and 'zip'.

"delimiter":"string"

specifies the field delimiter. The delimiter can be a single 7-bit character, or 'TAB', or '^[@A-Z]', or one of [\\, \0, \a, \b, \t, \v, \f]. Multi-byte UTF-8 characters are not valid. The ^A value corresponds to the 0X01 that is commonly used with Apache Hive.

Default ","
"encoding":"string"

specifies the text encoding of the file. If you do not specify this parameter, then the session encoding is used.

Default "utf-8"
"getNames":True | False

when set to True, the values in the first line of the file are used as variable names.

Default True
"guessRows":64-bit-integer

specifies the number of rows to scan in order to determine data types for variables.

Default 20
Minimum value 1
"locale":"string"

specifies the locale for interpreting data in the file

"multiFile":True | False

when set to True, the server attempts to load all CSV files from the specified path into a single in-memory table. The files must have the same number of columns and the same column data types.

Default False
"nThreads":integer

specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.

Default 0
Minimum value 0
"pathAsColumn":True | False

when set to True, path column/value pairs are added to table.

Default False
"quotedDataAsString":True | False

when set to True, quoted data are strings.

Default False
"readSequential":True | False

when set to True, the delimited file is read sequentially so that error messages from parsing can indicate the line number for the problem.

Default False
"recurse":True | False

recursively import files when the caslib definition permits access to subdirectories.

Default True
"showFile":True | False

when this parameter and multiFile are set to True, each row includes a column that identifies the CSV file name that contributed the row.

Default False
"showFullPath":True | False

when this parameter and multiFile are set to True, each row includes a column that identifies the fully-qualified path, including the file name, to the CSV file that contributed the row.

Default False
"showPath":True | False

when this parameter and multiFile are set to True, each row includes a column that identifies the fully-qualified directory path to the CSV file that contributed the row.

Default False
"stripBlanks":True | False

removes leading and trailing blanks from character variables.

Default False
"varChars":True | False

when set to True, variable-length strings are used for character variables.

Default True
"vars":[{casvarcsvdesc-1} <, {casvarcsvdesc-2}, ...>]

specifies the names, types, formats, and other metadata for variables.

The casvarcsvdesc value can be one or more of the following:

"format":"string"

specifies the format to apply to the variable.

"formattedLength":integer

specifies the length of the format field plus the length of the format precision.

"informat":"string"

specifies the informat to apply to the variable.

"label":"string"

specifies the descriptive label for the variable.

"length":integer

specifies the unformatted length of the variable. This parameter applies to fixed-length character variables (type="CHAR") only.

Default 8
Minimum value 1
"name":"string"

specifies the name for the variable.

"nfd":integer

specifies the length of the format precision.

"nfl":integer

specifies the length of the format field.

"type":"BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"

specifies the data type for the variable.

Default DOUBLE

Parameters for fileType="DOCUMENT"

"contents":True | False

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default True
"fileExtList":["CSV", "DOC", "DOCX", "EPUB", "HTML", "KEY", "MBOX", "MSG", "NUMBERS", "ODP", "ODS", "ODT", "PAGES", "PDF", "PPT", "PPTX", "PST", "RTF", "TNEF", "TXT", "WPD", "XLS", "XLSX", "XML"]

specifies the file extensions for subsetting the files to import.

Default {'html','xml','doc','docx','xls','xlsx','ppt','pptx','odt','ods','odp','pages','numbers','key','wpd','pdf','epub','rtf','txt','mbox','msg','tnef','pst','csv'}
"recurse":True | False

recursively import files when the caslib definition permits access to subdirectories.

Default True
"tikaConv":True | False

specifies to convert the documents with the Apache Tika document conversion library.

Default False

Parameters for fileType="DTA"

No parameters apply when you specify DTA.

Parameters for fileType="ESP"

"maxTime":integer

specifies the number of seconds to receive data from SAS Event Stream Processing before declaring an end of file on the stream. The data is read until an end of file is found, and then the action stops running.

Default 5
"sasTypes":True | False

when set to True, the table is created with character and float data types only. When set to False, the table uses the same data types that are used in the ESP event.

Default False

Parameters for fileType="EXCEL"

"getNames":True | False

when set to True, the values in the first line of the file are used as variable names.

Default True
"getSheetNames":True | False

when set to True, the sheet names are written to a CAS table.

Default False
"range":"string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

"sheet":"string"

specifies the name of the worksheet to import.

Parameters for fileType="FMT"

"name":"string"

specifies a file system path and filename. The file must be a SAS item store that includes the formats to import.

Parameters for fileType="HDAT"

"backingStore":"CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

specifies the backing store to use for an in-memory table. If you specify a setting when you load one table, it overrides the setting for the caslib. If you specify a setting when you add a caslib, it applies to all tables in the caslib.

Default INHERIT
CASDISKCACHE

specifies to make a copy of the blocks for an in-memory table. The blocks are stored in the directories identified by the CAS_DISK_CACHE environment variable at server start-up.

INHERIT

specifies to map the blocks for an in-memory table according to inherited rules of precedence. When used with loading tables, the backing store setting is inherited from the caslib. When adding a caslib, the setting is inherited from the server. The server setting can be specified in the CAS_LOADTABLEBACKINGSTORE environment variable. Valid values are CASDISKCACHE or INPLACEPREFERRED. The default value is CASDISKCACHE.

INPLACEPREFERRED

specifies to use the blocks from an existing SASHDAT file for memory mapping. If the existing blocks cannot be used, then copies of the blocks are used as described for CASDISKCACHE. The most common reason that prevent using existing blocks is when the SASHDAT file is encrypted. This setting prevents removing or replacing a SASHDAT file when the server is running Microsoft Windows.

"encryptionPassword":"string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for fileType="IMAGE"

"contents":True | False

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default True
"decode":True | False

when set to True, the server attempts to determine the dimensions, resolution, and format of each file.

Default False
"fileExtList":["BMP", "DIB", "JP2", "JPE", "JPEG", "JPG", "PBM", "PGM", "PIF", "PNG", "PNM", "PPM", "PXM", "TIF", "TIFF", "WEB", "WEBP"]

specifies the file extensions for subsetting the files to import.

Default {'web','pgm','bmp','jpg','jpeg','tif','pbm','pif','webp','jpe','jp2','dib','pnm','pxm','png','ppm','tiff'}
"recurse":True | False

recursively import files when the caslib definition permits access to subdirectories.

Default True

Parameters for fileType="JMP"

No parameters apply when you specify JMP.

Parameters for fileType="LASR"

"compPgm":"string"

specifies an expression for each computed variable that you include in the computedVars parameter.

"compVars":["string-1" <, "string-2", ...>]

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

"nThreads":integer

specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.

Default 0
Minimum value 0
"parallelMode":"FALLBACK" | "FORCE" | "NONE"

specifies how the table is transferred from SAS LASR Analytic Server to SAS Cloud Analytic Services.

Default FALLBACK
FALLBACK

specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

FORCE

specifies to perform a parallel load. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

NONE

specifies to perform a serial load.

"preserveOrder":True | False

when set to True, the rows are inserted into the new table in the same order as they are received from the SAS LASR Analytic Server. Creating the table is less efficient when this parameter is used.

Default False
"varchars":True | False

when set to True, variable-length strings are used for character variables.

Default False
"vars":["string-1" <, "string-2", ...>]

specifies the variables to use in the action.

"where":"where-expression"

specifies an expression for subsetting the input data.

Parameters for fileType="PARQUET"

"varChars":True | False

when set to True, variable-length strings are used for character variables.

Default False

Parameters for fileType="SPSS"

No parameters apply when you specify SPSS.

Parameters for fileType="VIDEO"

"contents":True | False

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default True
"fileExtList":["AVI", "MOV", "MP4", "MPG", "WMV"]

specifies the file extensions for subsetting the files to import.

Default {'mpg','wmv','mov','mp4','avi'}
"recurse":True | False

recursively import files when the caslib definition permits access to subdirectories.

Default True

Parameters for fileType="XLS"

"getNames":True | False

when set to True, the values in the first line of the file are used as variable names.

Default True
"range":"string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

"sheet":"string"

specifies the name of the worksheet to import.

R Syntax

importOptions=list(fileType="ANY" | "AUDIO" | "AUTO" | "BASESAS" | "CSV" | "DELIMITED" | "DOCUMENT" | "DTA" | "ESP" | "EXCEL" | "FMT" | "HDAT" | "IMAGE" | "JMP" | "LASR" | "PARQUET" | "SOUND" | "SPSS" | "VIDEO" | "XLS", fileType-specific-parameters)

Parameters for fileType="ANY"

contents=TRUE | FALSE

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default TRUE
fileExtList=list("string-1" <, "string-2", ...>)

specifies the file extensions for subsetting the files to import.

recurse=TRUE | FALSE

recursively import files when the caslib definition permits access to subdirectories.

Default TRUE

Parameters for fileType="AUDIO" | "SOUND"

contents=TRUE | FALSE

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default TRUE
fileExtList=list("WAV")

specifies the file extensions for subsetting the files to import.

Default wav
recurse=TRUE | FALSE

recursively import files when the caslib definition permits access to subdirectories.

Default TRUE

Parameters for fileType="AUTO"

No parameters apply when you specify AUTO.

Parameters for fileType="BASESAS"

alter="string"

specifies the Alter password for the SAS data set.

charMultiplier=double

specifies a multiplier value to expand fixed-width character variables that might require transcoding. The lengths are increased to avoid character data truncation. The lengths are increased by multiplying the length by the specified value.

Default 1
Range 1–5
dataTransferMode="AUTO" | "PARALLEL" | "SERIAL"

specifies how data is transferred between the data source and SAS Cloud Analytic Services.

Default AUTO
encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

password="string"

specifies the password for a password-protected data set. Use this parameter if the data set is password-protected or uses SAS proprietary encryption.

read="string"

specifies the Read password for the SAS data set.

varcharConversion=double

specifies the number of bytes to use as a threshold. When a column with the CHAR data type has a length that is equal to or exceeds the specified number of bytes, the VARCHAR data type is used.

Default 0
Range 1–32767
write="string"

specifies the Write password for the SAS data set.

Parameters for fileType="CSV" | "DELIMITED"

allowEmbeddedNewLines=TRUE | FALSE

when set to True, line feed and carriage return characters are ignored when they are in a field that is enclosed in quotation marks. A line feed character has the ASCII value 10 and the carriage return character has a value of 13. Only the double quotation mark character (") is supported for ignoring the two characters. By default, loadTable will not check for new lines within quoted strings.

Default FALSE
allowTruncation=TRUE | FALSE

specifies that truncation of character data that is too long for a given field is allowed.

Default TRUE
archiveType="string"

Specify compressed CSV archive type, valid archive types are 'gz' and 'zip'.

delimiter="string"

specifies the field delimiter. The delimiter can be a single 7-bit character, or 'TAB', or '^[@A-Z]', or one of [\\, \0, \a, \b, \t, \v, \f]. Multi-byte UTF-8 characters are not valid. The ^A value corresponds to the 0X01 that is commonly used with Apache Hive.

Default ","
encoding="string"

specifies the text encoding of the file. If you do not specify this parameter, then the session encoding is used.

Default "utf-8"
getNames=TRUE | FALSE

when set to True, the values in the first line of the file are used as variable names.

Default TRUE
guessRows=64-bit-integer

specifies the number of rows to scan in order to determine data types for variables.

Default 20
Minimum value 1
locale="string"

specifies the locale for interpreting data in the file

multiFile=TRUE | FALSE

when set to True, the server attempts to load all CSV files from the specified path into a single in-memory table. The files must have the same number of columns and the same column data types.

Default FALSE
nThreads=integer

specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.

Default 0
Minimum value 0
pathAsColumn=TRUE | FALSE

when set to True, path column/value pairs are added to table.

Default FALSE
quotedDataAsString=TRUE | FALSE

when set to True, quoted data are strings.

Default FALSE
readSequential=TRUE | FALSE

when set to True, the delimited file is read sequentially so that error messages from parsing can indicate the line number for the problem.

Default FALSE
recurse=TRUE | FALSE

recursively import files when the caslib definition permits access to subdirectories.

Default TRUE
showFile=TRUE | FALSE

when this parameter and multiFile are set to True, each row includes a column that identifies the CSV file name that contributed the row.

Default FALSE
showFullPath=TRUE | FALSE

when this parameter and multiFile are set to True, each row includes a column that identifies the fully-qualified path, including the file name, to the CSV file that contributed the row.

Default FALSE
showPath=TRUE | FALSE

when this parameter and multiFile are set to True, each row includes a column that identifies the fully-qualified directory path to the CSV file that contributed the row.

Default FALSE
stripBlanks=TRUE | FALSE

removes leading and trailing blanks from character variables.

Default FALSE
varChars=TRUE | FALSE

when set to True, variable-length strings are used for character variables.

Default TRUE
vars=list( list(casvarcsvdesc-1) <, list(casvarcsvdesc-2), ...>)

specifies the names, types, formats, and other metadata for variables.

The casvarcsvdesc value can be one or more of the following:

format="string"

specifies the format to apply to the variable.

formattedLength=integer

specifies the length of the format field plus the length of the format precision.

informat="string"

specifies the informat to apply to the variable.

label="string"

specifies the descriptive label for the variable.

length=integer

specifies the unformatted length of the variable. This parameter applies to fixed-length character variables (type="CHAR") only.

Default 8
Minimum value 1
name="string"

specifies the name for the variable.

nfd=integer

specifies the length of the format precision.

nfl=integer

specifies the length of the format field.

type="BINARY" | "CHAR" | "DATE" | "DATETIME" | "DECQUAD" | "DECSEXT" | "DOUBLE" | "INT32" | "INT64" | "TIME" | "VARBINARY" | "VARCHAR"

specifies the data type for the variable.

Default DOUBLE

Parameters for fileType="DOCUMENT"

contents=TRUE | FALSE

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default TRUE
fileExtList=list("CSV", "DOC", "DOCX", "EPUB", "HTML", "KEY", "MBOX", "MSG", "NUMBERS", "ODP", "ODS", "ODT", "PAGES", "PDF", "PPT", "PPTX", "PST", "RTF", "TNEF", "TXT", "WPD", "XLS", "XLSX", "XML")

specifies the file extensions for subsetting the files to import.

Default {'html','xml','doc','docx','xls','xlsx','ppt','pptx','odt','ods','odp','pages','numbers','key','wpd','pdf','epub','rtf','txt','mbox','msg','tnef','pst','csv'}
recurse=TRUE | FALSE

recursively import files when the caslib definition permits access to subdirectories.

Default TRUE
tikaConv=TRUE | FALSE

specifies to convert the documents with the Apache Tika document conversion library.

Default FALSE

Parameters for fileType="DTA"

No parameters apply when you specify DTA.

Parameters for fileType="ESP"

maxTime=integer

specifies the number of seconds to receive data from SAS Event Stream Processing before declaring an end of file on the stream. The data is read until an end of file is found, and then the action stops running.

Default 5
sasTypes=TRUE | FALSE

when set to True, the table is created with character and float data types only. When set to False, the table uses the same data types that are used in the ESP event.

Default FALSE

Parameters for fileType="EXCEL"

getNames=TRUE | FALSE

when set to True, the values in the first line of the file are used as variable names.

Default TRUE
getSheetNames=TRUE | FALSE

when set to True, the sheet names are written to a CAS table.

Default FALSE
range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

Parameters for fileType="FMT"

name="string"

specifies a file system path and filename. The file must be a SAS item store that includes the formats to import.

Parameters for fileType="HDAT"

backingStore="CASDISKCACHE" | "INHERIT" | "INPLACEPREFERRED"

specifies the backing store to use for an in-memory table. If you specify a setting when you load one table, it overrides the setting for the caslib. If you specify a setting when you add a caslib, it applies to all tables in the caslib.

Default INHERIT
CASDISKCACHE

specifies to make a copy of the blocks for an in-memory table. The blocks are stored in the directories identified by the CAS_DISK_CACHE environment variable at server start-up.

INHERIT

specifies to map the blocks for an in-memory table according to inherited rules of precedence. When used with loading tables, the backing store setting is inherited from the caslib. When adding a caslib, the setting is inherited from the server. The server setting can be specified in the CAS_LOADTABLEBACKINGSTORE environment variable. Valid values are CASDISKCACHE or INPLACEPREFERRED. The default value is CASDISKCACHE.

INPLACEPREFERRED

specifies to use the blocks from an existing SASHDAT file for memory mapping. If the existing blocks cannot be used, then copies of the blocks are used as described for CASDISKCACHE. The most common reason that prevent using existing blocks is when the SASHDAT file is encrypted. This setting prevents removing or replacing a SASHDAT file when the server is running Microsoft Windows.

encryptionPassword="string" | binary-large-object

specifies a password for encrypting or decrypting stored data.

Parameters for fileType="IMAGE"

contents=TRUE | FALSE

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default TRUE
decode=TRUE | FALSE

when set to True, the server attempts to determine the dimensions, resolution, and format of each file.

Default FALSE
fileExtList=list("BMP", "DIB", "JP2", "JPE", "JPEG", "JPG", "PBM", "PGM", "PIF", "PNG", "PNM", "PPM", "PXM", "TIF", "TIFF", "WEB", "WEBP")

specifies the file extensions for subsetting the files to import.

Default {'web','pgm','bmp','jpg','jpeg','tif','pbm','pif','webp','jpe','jp2','dib','pnm','pxm','png','ppm','tiff'}
recurse=TRUE | FALSE

recursively import files when the caslib definition permits access to subdirectories.

Default TRUE

Parameters for fileType="JMP"

No parameters apply when you specify JMP.

Parameters for fileType="LASR"

compPgm="string"

specifies an expression for each computed variable that you include in the computedVars parameter.

compVars=list("string-1" <, "string-2", ...>)

specifies the names of the computed variables to create. Specify an expression for each variable in the computedVarsProgram parameter. If you do not specify this parameter, then all variables from computedVarsProgram are automatically included.

nThreads=integer

specifies the number of threads to use on each machine in the server. By default, the server uses one thread for each CPU that is licensed to use SAS software.

Default 0
Minimum value 0
parallelMode="FALLBACK" | "FORCE" | "NONE"

specifies how the table is transferred from SAS LASR Analytic Server to SAS Cloud Analytic Services.

Default FALLBACK
FALLBACK

specifies to attempt a parallel load. If the parallel load does not succeed, then a serial load is performed.

FORCE

specifies to perform a parallel load. If the parallel load cannot be performed, such as for network connectivity issues, then the load fails.

NONE

specifies to perform a serial load.

preserveOrder=TRUE | FALSE

when set to True, the rows are inserted into the new table in the same order as they are received from the SAS LASR Analytic Server. Creating the table is less efficient when this parameter is used.

Default FALSE
varchars=TRUE | FALSE

when set to True, variable-length strings are used for character variables.

Default FALSE
vars=list("string-1" <, "string-2", ...>)

specifies the variables to use in the action.

where="where-expression"

specifies an expression for subsetting the input data.

Parameters for fileType="PARQUET"

varChars=TRUE | FALSE

when set to True, variable-length strings are used for character variables.

Default FALSE

Parameters for fileType="SPSS"

No parameters apply when you specify SPSS.

Parameters for fileType="VIDEO"

contents=TRUE | FALSE

when set to False, the server does not load the contents of the files into a column in the output table. This can be useful to determine the number of files and file types. By default, the contents of the files are loaded into a column.

Default TRUE
fileExtList=list("AVI", "MOV", "MP4", "MPG", "WMV")

specifies the file extensions for subsetting the files to import.

Default {'mpg','wmv','mov','mp4','avi'}
recurse=TRUE | FALSE

recursively import files when the caslib definition permits access to subdirectories.

Default TRUE

Parameters for fileType="XLS"

getNames=TRUE | FALSE

when set to True, the values in the first line of the file are used as variable names.

Default TRUE
range="string"

specifies a subset of the cells to import. For example, the range B2..E8 is the range address for a rectangular block of 12 cells, where the top left cell is B2 and the bottom right cell is E8.

sheet="string"

specifies the name of the worksheet to import.

Last updated: November 23, 2025