ImportDataFile
Description:
-
Imports a Data File (for use with a Data File Definition).
Input Properties
path
Description:
-
Path to the file to be imported.
Required:
-
Only if "message" is not specified.
filename
Description:
-
Name of the file to be imported.
Required:
-
Only if "message" is not specified and "path" does not include the filename.
messagelogid
Description:
-
ID of the messagelog entry to process. Use instead of path and filename.
Required:
-
No
datafiledefid
Description:
-
Data File Definition to be used for import options.
Required:
-
Yes
datafiledefversionid
Description:
-
Version of the Data file Definition.
Required:
-
Yes
messagetypeid
Description:
-
Message Type corresponding to the Data File Definition for processing the Data File. This is used when calling the Action through the SEC route.
Required:
-
Yes
message
Description:
-
Property that has the dataset created by ReadDataFile.
Required:
-
Yes
worksheet
Description:
-
Overrides the default worksheet defined in the DFD
Required:
-
No
worksheetnumber
Description:
-
Worksheet specified as a number (For example: 0 for Sheet1, 1 for Sheet2 etc. Overrides the default worksheet defined in the DFD
Required:
-
No
commitscope
Description:
-
Specifies value none, all or default, if none - the commit scope is determined by the caller, all - the commit scope is overridden to end of worksheet
default or not specified - it uses the DFD process options
Required:
-
No
validateonly
Description:
-
Determines whether the validation rules are evaluated or not. possible values
Y - validate - do not run the processing scripts
N - validate and proces
Required:
-
No
deletefile
Description:
-
Determines whether or not (Y/N) the file is deleted after processing.
Required:
-
Yes
documentfield
Description:
-
Reference to a document file field. This property is typically only used in the GAP for file field processing.
Required:
-
No
verbose
Description:
-
Determines whether or not (Y/N) the file is deleted after processing.
Required:
-
Yes
locale
Description:
-
Determines the locale for the dates and number formats used in the Excel/Data file. Defaults to the user's locale
Required:
-
No
Output Properties
responsemessage
Description:
-
Message indicating whether or not the Data File was successfully processed.
log
Description:
-
Log of the import process.
validationlog
Description:
-
validation log created by checking the validation rules for each field
Additional Information
Additional information concerning this Action:
-
None.
Copyright © 1999-2016 LABVANTAGE Solutions, Inc.