ProcessFile
Description:
Processes a single file.
Input Properties
path
Description:
Full path to the directory that is searched for files. This can optionally include the filename. If so, the "filename" need not be specified.
Required:
Yes
filename
Description:
Name of the file to process.
Required:
No
tempid
Description:
ID of the temp file to process. Use instead of path and filename.
Required:
No
processactionid
Description:
Action that processes the file.
Required:
Yes
processactionversionid
Description:
Version number of the Action.
Required:
Yes
processpath
Description:
Full path to the directory in which the file is moved if it fails to be processed. If not specified, the file is deleted.
Required:
No
failpath
Description:
Full path to the directory in which the file is moved during processing.
Required:
No
successpath
Description:
Full path to the directory in which the file is moved if it is successfully processed. If not specified, the file is deleted.
Required:
No
readfilecontent
Description:
When used with the Sapphire Enterprise Connector, y/n determines whether or not the file content should be passed to the "Process Action".
Required:
No
encoding
Description:
When used with the Sapphire Enterprise Connector, determines the file content encoding. Defaults to UTF-8
Required:
No
filecontentpropertyid
Description:
When used with the Sapphire Enterprise Connector, identifier of the property that holds the file content (the default is filecontent).
Required:
No
readactionid
Description:
Identifier of the Action to be called that reads the file content and returns the "filecontent" property.
Required:
No
readactionversionid
Description:
Version of the Action specified by "readactionid" (above).
Required:
No
retainonsuccess
Description:
When succes path is not specified, the file is deleted unless retainonsuccess = Y.
Required:
No
retainonfailure
Description:
When failpath is not specified, the file is deleted unless retainonfailure = Y.
Required:
No
Output Properties
filecontent
Description:
Content of the file. This is returned by the Action specified by the "readactionid" property.
Additional Information
Additional information concerning this Action:
This Action searches directories specified by the "path" property.
During processing, files are moved to a directory specified by the "processpath" property. This seems to be missing from the interface, but there is no record of it being removed.
If "successpath" property is specified, successfully processed files are moved to a directory specified by that property.
If "failpath" property is specified, files that fail to process are moved to a directory specified by that property.
The Actions specified by the "processactionid" and "processactionversionid" properties are called to process the file.
Files are processed in ascending order of the 'lastmodified' date of the files in the directory, i.e., files created first are processed first.
This Action is called by the ProcessFiles Action.
Copyright © 1999-2016 LABVANTAGE Solutions, Inc.