CaptureService

Atalasoft.Controls.Capture. CaptureService

This object is responsible for returning information from KIC, such as the content-types and content-type document descriptions, and for importing uploaded documents into Kofax Capture, and SharePoint.

Methods

(static) dispose() → {undefined}

Disposed the CaptureService. Removes auto-generated capture UI, if any.

Returns:
Type
undefined

(static) importDocument(filename, contentType, contentTypeDescriptionopt, onImportCompleted, onErrorImport)

Triggers document import.

Parameters:
Name Type Description
filename string

The file name of the document.

contentType string

Document content type.

[contentTypeDescription] string

Content type description.

onImportCompleted onCaptureCompleteCallback

callback to be called in case of successful import.

onErrorImport onCaptureErrorCallback

callback to be called in case of failed import.

(static) importIndexFieldDocument(filename, contentType, contentTypeDescriptionopt, indexFields, onImportCompleted, onErrorImport)

Triggers document import with the specified fields.

Parameters:
Name Type Description
filename string

The file name of the document.

contentType string

Document content type.

[contentTypeDescription] string

Content type description.

indexFields string

String batch and index fields representation.

onImportCompleted onCaptureCompleteCallback

callback to be called in case of successful import.

onErrorImport onCaptureErrorCallback

callback to be called in case of failed import.

(static) importLoosePageDocument(filename, contentType, batchFields, onImportCompleted, onErrorImport)

Triggers loose page document import to the Kofax Capture. See Connect to UI Controls.

Parameters:
Name Type Description
filename string

The file name of the document.

contentType string

Document content type. *

batchFields string

String batch filds representation.

onImportCompleted onCaptureCompleteCallback

callback to be called in case of successful import.

onErrorImport onCaptureErrorCallback

callback to be called in case of failed import.

(static) setBatchFieldValues(batchFieldValues)

Set batch fields outside of the initialization parameters. Currently this worksas it would if used in the initialization parameters, and is intended to be used when no UI for batch fields is present.

Parameters:
Name Type Description
batchFieldValues string

Comma separated list of batch fields name-value pairs. Format "Field1: Value1, Field2: Value2".

Returns:

undefined.

(static) setIndexFieldValues(indexFieldValues)

Sets index fields outside of the initialization parameters. Currently this works as it would if used in the initialization parameters, and is intended to be used when no UI for index fields is present.

Parameters:
Name Type Description
indexFieldValues string

Comma separated list of batch fields name-value pairs. Format "Field1: Value1, Field2: Value2".

Returns:

undefined.

Events

onBatchFieldCompleted :onFieldRenderCompleteCallback

Batch field rendering completed event.

onBatchFieldImportValidationError :onFieldsValidationErrorCallback

Batch fields validation error event.

onError :onCaptureError

Document import error event.

onImportComplete :onCaptureCompleteCallback

Document import complete event.

onIndexFieldCompleted :onFieldRenderCompleteCallback

Index field rendering completed event.

onIndexFieldImportValidationError :onFieldsValidationErrorCallback

Index fields validation error event.

onTrackStatus :onTrackStatusReceivedCallback

Document import status event.