|
Returns
|
Method
|
Description
|
|
Short
|
AddNewDocument
|
Description:
Adds a new document from a file
Parameters:
String file
|
|
Short
|
EntAddToEventLog
|
Description:
Adds a new entry in the ChronoScan Enterprise event log for the batch
Parameters:
String description
|
|
String
|
GetVariableValue
|
Description:
Returns a ChronoScan variable, it includes variables related with the batch
Parameters:
String variable - Requested variable to ChronoScan, for example "station_id"
You can see a complete variable list in the variables wizard window of ChronoScan.
Return value for the selected ChronoScan variable.
|
|
|
CancelProcess
|
Cancel current batch processing
|
|
Short
|
DeleteDocument
|
Deletes a single document
Parameters:
Short document number
|
|
Short
|
DeleteAllDocuments
|
Empty the Batch
|
|
Short
|
ExecuteInputModule
|
Parameters:
modname:
-
image_files (import image files)
-
pdf_files (import PDF files with text extraction and image conversion)
modparams:
-
ConfigName#parameter=value#parameter=value
Allowed parameters of pdf_files module:
-
-
extensions = *.pdf | onlythisfile.pdf | *.pdf;*.pdfx
-
-
-
-
-
extracmode = 0 (images) | 1 (convert to image)
-
resolution = 96|120|150|200|300|400|600
-
colortype = 0 (black and white) | 1 (color)
-
-
-
orientateauto = true|false
-
deleteonimport = true|false
-
-
movetofolder = <c:\process_folder> or <\process_folder>
-
for_fast_text_processing = 1 (speed up text extraction, warning: setting this parameter to 1 means that image quality will be lower)
-
debug = 1 (allows to view the import options before import)
Allowed parameters of image_files module:
-
-
-
-
-
-
-
-
importfromlastfile = true|false
-
deleteonimport = true|false
-
-
movetofolder = <c:\process_folder> or <\process_folder>
-
debug = 1 (allows to view the import options before import)
|
|
Short
|
ExecuteProcess
|
Parameters:
operations:
Use ; to execute more than one operation at once (ex: DESKEW;OCR)
If empty will use the configured options on the Batch.
|
|
Void
|
ExecuteBarcode
|
Executes the barcode configurations on all documents/pages. This function only update the barcode read, it won't split, delete, ignore, ect
|
|
short
|
ExternalDataImportExecute
|
Executes a configured external data import
Parameters:
String config name
|
|
String
|
GetConversionModule_File
|
Returns the file generated by specific conversion module
Parameters:
Short item number
String Export module name
|
|
long
|
GetConversionModule_FileCount
|
Returns the number of items generated by specific conversion module
Parameters:
String Export module name
|
|
long
|
GetDocCount
|
Returns the number of documents
|
|
long
|
GetDocCountStatus
|
Returns the number of documents with a specific status
Parameters:
Short status, 0=validated, 1=error
|
|
short
|
GetExportStatus
|
Returns the export status
-
-
-
2 = not exported because of not validated documents
-
-
|
|
short
|
SetExportStatus
|
Sets the export status
Parameters:
Short new status:
-
-
-
2 = not exported because of not validated documents
-
-
|
|
short
|
SetEntityID
|
Sets an entity to a batch
Parameters:
String new entity ID
|
|
String
|
GetEntityID
|
Returns the Batch Entity ID
|
|
String
|
GetEntityName
|
Returns the Batch Entity Name
|
|
String
|
GetEntityDescription
|
Returns the Batch Entity Description
|
|
long
|
GetLastInputCount
|
Returns the number of documents generated by last scan/import process
|
|
|
GetDocument
|
Parameters:
Short document number
|
|
String
|
GetJobName
|
Returns Job Name
|
|
String
|
GetName
|
Returns Batch Name
|
|
String
|
GetDateCreated
|
Returns Batch date creation
|
|
String
|
GetDateUpdated
|
Returns Batch date update
|
|
String
|
GetUserField
|
Returns the value of a specific row/field
Parameters:
Short document number
String Field name
|
|
String
|
GetSystemField
|
Returns the value of a specific system row/field
Parameters:
Short document number
String System Field name
|
|
String
|
GetXgridFieldValue
|
Returns the value of a specific capture grid field
Parameters:
Short document number
Short grid number
Short grid row number
String Field name
|
|
String
|
GetXgridColumnValue
|
Return the value of a specific capture grid field by column number
Parameters:
Short document number
Short grid number
Short grid row number
Short column number
|
|
Short
|
GetXgridFieldBitmap
|
Save the zone bitmap of a specific capture grid field to a file
Parameters:
Short document number
Short table number
Short talbe row number
String Field name
Return
TRUE if success
|
|
Short
|
GetXgridRowCount
|
Return the number of records of a specific capture grid
Parameters:
Short document number
Short table number
|
|
Short
|
GetXgridLastEdited
|
Return the number of last edited capture grid, This function can be used in OnXGridValueChanged event
|
|
String
|
GetXgridLastEditedField
|
Return the name of last edited capture grid, This function can be used in OnXGridValueChanged event
Parameters:
Short table number
|
|
Short
|
IsValidated
|
Return true if document is validated
Parameters:
Short row number
|
|
Short
|
MergeDocuments
|
Merge two documents
Parameters:
Short target document number
Short document number to merge
Return
TRUE if success
|
|
Short
|
Save
|
Save Changes on the Batch
Parameters:
Short, optional, default (1) synchronize the data in the database (ENT)
|
|
Short
|
SetUserField
|
Update Field value of a specific row/field
Parameters:
Short document number
String Field name
String new value
|
|
M-Files Server Application
|
GetOutModule_MFilesServerApplication
|
Returns the M-Files Server Application object linked to the specified M-Files export module configuration
Parameters:
String M-Files export module configuration
Sample:
Set oServerApp = Batch.GetOutModule_MFilesServerApplication("M-FILES")
'rest of the code goes here
|
|
short
|
SetEntStatus
|
Sets the batch status to an enterprise batch, 'processed', 'ready_to_index', 'processed', 'created', etc
Parameters:
string: status
Returns:
TRUE if success
|
|
String
|
GetEntStatus
|
Gets the batch status to an enterprise batch
Returns:
Status
|
|
short
|
IgnoreDocument
|
Ignores/ unignores a specific document
Parameters:
int docnumber (indexed from 1)
int mode:
0: Not ignored/ Unignore
1: Ignore
Returns:
TRUE if success
|
|
short
|
IsDocumentIgnored
|
Tells us if a specific document is ignored
Parameters:
int docnumber (indexed from 1)
Returns:
TRUE if ignored
FALSE if not ignored
|
|
|
getSelectedDocument
Since v1.0.2.85
|
Returns first selected found ChronoDocument object
|
