pdf to jpg c# : Creating a secure pdf document control application system azure web page winforms console Kofax_Administrators_Guide_v1025-part468

The XML Import Connector Module
Kofax Capture Administrator's Guide
251
Attribute Name/
(Read/Write)
Type
Description
DeleteBatchOnError
(Read)
0/1
Changes the default behavior of deleting batches with errors.
Set DeleteBatchOnError to “0” to allow batches with errors to
be retained, if possible, and sent to Quality Control.
Batch deletion behavior can also be specified as a
command line option (the 
-n
option). If specified for
<ImportSession>
, the setting overrides the command line
setting.
Note that for some types of errors, batches are always
deleted, regardless of the DeleteBatchOnError or command
line settings.
LogFileName
(Read)
String
Specifies the name of the XML Import Connector log file.
If not specified, or if the specified file cannot be opened or
accessed, events are logged to 
C:\Acxmlail.txt
. See
Event Logging
for more information about logging events and
the XML Import Connector log file.
The XML log file name can alternatively be specified as a
command line option (the 
-l
or 
-LogMonthly
option). If
specified for 
<ImportSession>
, this setting overrides the
command line setting.
In addition to the log file, XML errors are written to the Kofax
Capture log file. Most types of XML errors are also written
back to the XML Import Connector file. See Error Handling
for more information.
LastErrorCode
(Write)
Integer
The XML Import Connector application (Acxmlai.exe) adds
this attribute to the 
<ImportSession>
element if an error
occurs during the import process. The value of the attribute is
the number of the last error that occurred.
If no error occurs, this attribute is not present.
LastErrorMessage
(Write)
String
The XML Import Connector application (Acxmlai.exe) adds
this attribute to the 
<ImportSession>
element if an error
occurs during the import process. The value of the attribute is
the number of the last error that occurred.
If no error occurs, this attribute is not present.
<Batches> ... </Batches>
The 
<Batches>
element is a container for zero or more 
<Batch>
elements, which define the
batches to be created. No attributes are supported. You can have at most one 
<Batches>
element in an XML Import Connector file.
<Batch> ... </Batch>
Each 
<Batch>
element contains information about a single batch to create, and serves as
a container for 
<BatchFields>
<ExpectedBatchTotals>
<Documents>
<Folders>
, and
<Pages>
elements. The order in which the 
<Batch>
elements are listed defines the order
the batches are processed. Note that some of the attributes are read during the XML Import
Connector operation. Other attributes are written by the operation.
Creating a secure pdf document - C# PDF Digital Signature Library: add, remove, update PDF digital signatures in C#.net, ASP.NET, MVC, WPF
Help to Improve the Security of Your PDF File by Adding Digital Signatures
decrypt pdf password online; can print pdf security
Creating a secure pdf document - VB.NET PDF Digital Signature Library: add, remove, update PDF digital signatures in vb.net, ASP.NET, MVC, WPF
Guide VB.NET Programmers to Improve the Security of Your PDF File by Adding Digital Signatures
add security to pdf in reader; creating secure pdf files
The XML Import Connector Module
252
Kofax Capture Administrator's Guide
Attribute Name/
(Read/Write)
Type
Description
Name
(Read)
String(128)
A unique identifier for the batch. You can specify
up to 128 characters, and the name is not case-
sensitive. If not specified, the date and time when
the batch is created is used.
If the batch name is a duplicate name, the error
“Duplicate batch name” is logged and the batch is
not created.
If the specified name is too long (more than 128
characters), the error “Illegal batch name” is logged
and the batch is not created.
BatchClassName
(Read)
String
The name of the batch class that defines how the
batch is to be processed in the Kofax Capture
workflow. This must match a valid Kofax Capture
batch class.
If the batch class is not found, the error “Batch class
not found” is logged and the batch is not created.
Description
(Read)
String(80)
An optional description of the batch. You can specify
up to 80 characters.
If the description string is too long (more than 80
characters), the error “Illegal batch description” is
logged and processing continues for the batch.
Priority
(Read)
Integer
The priority level for the batch, which impacts the
order in which the batch is processed by Kofax
Capture modules. You can specify a value from 1
to 10, with 1 being the highest priority and 10 the
lowest.
If specified, the value overrides the priority set
in the batch class definition. If the value is out of
range, the error “Illegal batch priority” is logged and
processing continues for the batch. The priority
specified in the batch class is used. If not specified,
the priority specified in the batch class definition is
used.
C# Create PDF Library SDK to convert PDF from other file formats
C#.NET PDF document file creating library control, RasterEdge XDoc for C# developers to create a highly-secure and industry-standard PDF document file.
change security settings pdf; convert secure webpage to pdf
C# Word - Word Creating in C#.NET
C#.NET Word document file creating library control, RasterEdge XDoc for C# developers to create a highly-secure and industry-standard Word document file
change pdf document security; create pdf the security level is set to high
The XML Import Connector Module
Kofax Capture Administrator's Guide
253
Attribute Name/
(Read/Write)
Type
Description
EnableAutomaticSeparationAndFormID
(Read)
0/1
This attribute allows automatic document separation
and form identification to occur during the import
process. It is used for batch classes that specify
document separation and form identification
methods normally performed at Scan time. Scan
time separation includes separating documents
based on a fixed number of pages, reading a
particular bar code or patch code, or detecting a
document separator sheet. Automatic scan-time
form identification occurs when only one form type
is defined for the batch class or the form type is
specified on a document separator sheet.
Set this attribute to “1” to allow automatic document
separation and form identification to occur during
the import process. If the batch class is not set up to
perform scan time separation or form identification,
this attribute is ignored and no error is logged.
Set this attribute to “0” to ignore any scan time
document separation and form identification defined
for the batch class.
For more information, see XML Import Connector
File Examples
for two sample XML Import
Connector files, each using a different method for
separating documents and identifying forms during
the import process.
EnableSingleDocProcessing
(Read)
0/1
When this attribute is enabled, as separation occurs
in the Scan module each document is converted
into and processed as an individual batch. This
single document batch inherits all the attributes and
values assigned to the 
<Batch>
element.
If the chosen method of separation does not occur
in the Scan module, an error occurs. Therefore,
only enable this attribute if document separation
occurs in the Scan module (for example, fixed page
separation).
Set this attribute to “1” to allow single document
processing to occur in the Scan module. Set this
attribute to “0” to ignore single document processing
if it is defined in the batch class.
C# PowerPoint - PowerPoint Creating in C#.NET
C#.NET PowerPoint document file creating library control, RasterEdge developers to create a highly-secure and industry-standard PowerPoint document file
decrypt a pdf file online; pdf file security
C# Word - Word Create or Build in C#.NET
approach for C# developers to create a highly-secure and industry a Word document in C#.NET using this Word document creating toolkit, if Create Word From PDF.
convert locked pdf to word; secure pdf file
The XML Import Connector Module
254
Kofax Capture Administrator's Guide
Attribute Name/
(Read/Write)
Type
Description
RelativeImageFilePath
(Read)
String(256)
Specifies the relative path of each image file from
the directory that contains the XML file.
It is important to understand that the path where
the image files are located must be based off the
relative location of the XML file. Then, with the
ImportFileName element, you can specify a file
name without giving a complete path.
You can specify up to 256 characters, and the path
is not case-sensitive. File names/paths containing
spaces must be enclosed in quotation marks.
If a folder is specified without a path, it is assumed
that the folder exists in the directory where the
XML file is located. For example, if the XML
file is located at 
C:\Polling Dir
and the
RelativeImageFilePath
is identified as
“Images”, then the application looks in 
C:\Polling
Dir\Images
for the image files.
Processed
(Write)
0/1
The XML Import Connector application adds this
attribute to the 
<Batch>
element to signify that
processing has been attempted for the batch. It
is set to “1” regardless of whether the batch is
successfully created or processed with errors.
If the XML Import Connector file is re-submitted,
the XML Import Connector application skips any
batches for which Processed=1. This prevents a
batch from being duplicated or an error situation
repeated.
Note that this attribute is never cleared or set to
“0” by the XML Import Connector application. If
Processed is set to “0” (manually or by another
application), and the XML Import Connector file is
resubmitted, the XML Import Connector application
attempts to process the batch. If Processed is not
specified, it behaves as if it has a value of “0”.
ErrorCode
(Write)
Integer
The XML Import Connector application
(Acxmlai.exe) adds this attribute to the 
<Batch>
element if a batch-level error occurs. The value of
the attribute is the number of the error.
Note that if ErrorCode exists for the 
<Batch>
element, the XML Import Connector application
(Acxmlai.exe) will clear it before processing the
batch.
If no error occurs, this attribute is not present.
ErrorMessage
(Write)
String
The XML Import Connector application
(Acxmlai.exe) adds this attribute to the 
<Batch>
element if a batch-level error occurs. The value of
the attribute is the error message text.
Note that if ErrorMessage exists for the 
<Batch>
element, the XML Import Connector application
(Acxmlai.exe) will clear it before processing the
batch.
If no error occurs, this attribute is not present.
C# Excel - Excel Creating in C#.NET
C#.NET Excel document file creating library control, RasterEdge XDoc C# developers to create a highly-secure and industry-standard Excel document file.
cannot print pdf security; convert secure pdf to word
XDoc.HTML5 Viewer for .NET, All Mature Features Introductions
By creating, loading, and modifying annotations, you can for text selecting in order to secure your web & profession imaging controls, PDF document, image to
add security to pdf file; copy locked pdf
The XML Import Connector Module
Kofax Capture Administrator's Guide
255
<BatchFields> ... </BatchFields>
The 
<BatchFields>
element is a container for zero or more 
<BatchField>
elements. You can
have at most one 
<BatchFields>
element for a 
<Batch>
element.
<BatchField>
Each 
<BatchField>
element contains information about a batch field, and supports the
following attributes. Note that some of the attributes are read during the XML Import
Connector operation. Other attributes are written by the operation.
Attribute Name/
(Read/Write)
Type
Description
Name
(Read)
String
The name of the batch field to fill. If the name is not
found in the batch class, the error “Field name not
found” is logged.
Value
(Read)
String(254)
The value for the batch field. The value can be up to
254 characters in length. If the value is too long, or
otherwise invalid, the error “Invalid field value” is logged.
ErrorCode
(Write)
Integer
The XML Import Connector application (Acxmlai.exe)
adds this attribute to the 
<BatchField>
element if an
error occurs. The value of the attribute is the number of
the error.
Note that if ErrorCode exists for the 
<BatchField>
element, the XML Import Connector application
(Acxmlai.exe) clears it before processing the field. In
addition, certain errors (such as “Required batch field
missing”) are reported on the parent 
<Batch>
element,
rather than 
<BatchField>
.
If no error occurs, this attribute is not present.
ErrorMessage
(Write)
String
The XML Import Connector application (Acxmlai.exe)
adds this attribute to the 
<BatchField>
element if
an error occurs. The value of the attribute is the error
message text.
Note that if ErrorMessage exists for the 
<BatchField>
element, the XML Import Connector application
(Acxmlai.exe) clears it before processing the field. In
addition, certain errors (such as “Required batch field
missing”) are reported on the parent 
<Batch>
element,
rather than 
<BatchField>
.
If no error occurs, this attribute is not present.
<ExpectedBatchTotals> ... </ExpectedBatchTotals>
The 
<ExpectedBatchTotals>
element is a container for zero or more
<ExpectedBatchTotal>
elements, which define batch total values and behavior. You can
have at most one 
<ExpectedBatchTotals>
element for a 
<Batch>
element.
VB.NET Word: VB Tutorial to Convert Word to Other Formats in .NET
But if you want to share the Word information with others across platforms, then converting Word to a more secure document format PDF will be greatly favored.
decrypt pdf with password; change security settings on pdf
PDF Image Viewer| What is PDF
software; Open standard for more secure, dependable electronic version among a suite of PDF-based standards to develop specifications for creating, viewing, and
pdf secure; copy paste encrypted pdf
The XML Import Connector Module
256
Kofax Capture Administrator's Guide
<ExpectedBatchTotal>
Each 
<ExpectedBatchTotal>
element contains a batch total field value, and supports
the following attributes. Note that some of the attributes are read during the XML Import
Connector operation. Other attributes are written by the operation.
<Folders> ... </Folders>
The 
<Folders>
element is a container for zero or more 
<Folder>
elements. You can have at
most one 
<Folders>
element for a 
<Batch>
element, or for a 
<Folder>
element. The order of
the folder elements defines the order in which the folders are processed.
Attribute Name/
(Read/Write)
Type
Description
Name
(Read)
String
The name of the batch total field to fill. If the name is not found
in the batch class, the error “Field name not found” is logged.
Value
(Read)
Numeric
The value of the batch total field. If the value is too long, or
otherwise invalid, the error “Invalid field value” is logged.
The actual type of the field is specified in the batch class.
ErrorCode
(Write)
Integer
The XML Import Connector application (Acxmlai.exe) adds this
attribute to the 
<ExpectedBatchTotal>
element if an error
occurs. The value of the attribute is the number of the error.
Note that if ErrorCode exists for the 
<ExpectedBatchTotal>
element, the XML Import Connector application (Acxmlai.exe)
clears it before processing the field.
If no error occurs, this attribute is not present.
ErrorMessage
(Write)
String
The XML Import Connector application (Acxmlai.exe) adds this
attribute to the 
<ExpectedBatchTotal>
element if an error
occurs. The value of the attribute is the error message text.
Note that if ErrorMessage exists for the
<ExpectedBatchTotal>
element, the XML Import Connector
application (Acxmlai.exe) clears it before processing the field.
If no error occurs, this attribute is not present.
<Folder> ... </Folder>
Each 
<Folder>
element is a container for a set of Index Fields and/or Documents and/or
Folders elements, and supports the following attributes. Note that some of the attributes
are read during the XML Import Connector operation. Other attributes are written by the
operation.
Attribute Name/
(Read/Write)
Type
Description
FolderClassName
(Read)
String
The name of the Kofax Capture folder class that defines how the
folder is to be processed.
If the folder class is not found, then the error “Folder class not
found” is thrown.
VB.NET Word: How to Convert Word Document to PNG Image Format in
document formats, including converting Word to PDF in VB password can't be removed from the Word document. is equipped with a more secure document protection by
advanced pdf encryption remover; copy text from encrypted pdf
The XML Import Connector Module
Kofax Capture Administrator's Guide
257
Attribute Name/
(Read/Write)
Type
Description
ErrorCode
(Write)
Integer
This attribute is cleared before processing the folder. After
processing the folder successfully, the attribute is not present. If
an error occurs while processing the folder, this attribute contains
the number of the error. Error numbers and strings are defined in
the section below.
ErrorMessage
(Write)
String
This attribute mimics the functionality of ErrorCode, except that
the error message is deposited here.
<Documents> ... </Documents>
The 
<Documents>
element is a container for zero or more 
<Document>
elements, which
specify the documents to be imported. You can have at most one 
<Documents>
element for a
<Batch>
element, or for a 
<Folder>
element.
<Document> ... </Document>
Each 
<Document>
element contains information about a single document to import, and
serves as a container for 
<Pages>
<Tables>
, and 
<IndexFields>
elements. The order that
the 
<Document>
elements are listed defines the order that documents are imported. Note that
some of the attributes are read during the XML Import Connector operation. Other attributes
are written by the operation.
Attribute Name/
(Read/Write)
Type
Description
FormTypeName
(Read)
String
The name of the Kofax Capture form type associated with the
document. If this attribute is specified, but assigned an empty
string, the document is created with no form type.
If the form type is not found, the error “Illegal Form Type” is
logged.
If this attribute is not specified, and only one form type is possible
for the batch class, that form type is assigned to the document. If
not specified and multiple form types are possible, the document
is created with no form type.
ErrorCode
(Write)
Integer
The XML Import Connector application (Acxmlai.exe) adds this
attribute to the 
<Document>
element if an error occurs. The
value of the attribute is the error number.
Note that if ErrorCode exists for the 
<Document>
element, the
XML Import Connector application (Acxmlai.exe) will clear it
before processing the document.
If no error occurs, this attribute is not present.
ErrorMessage
(Write)
String
The XML Import Connector application (Acxmlai.exe) adds this
attribute to the 
<Document>
element if a document-level error
occurs. The value of the attribute is the error message text.
Note that if ErrorMessage exists for the 
<Document>
element,
the XML Import Connector application (Acxmlai.exe) clears it
before processing the document.
If no error occurs, this attribute is not present.
The XML Import Connector Module
258
Kofax Capture Administrator's Guide
<Pages> ... </Pages>
The 
<Pages>
element is a container for zero or more 
<Page>
elements, which specify the
pages to import. The 
<Pages>
element can be used with the 
<Batch>
element for loose pages
or the 
<Document>
element for pages within a document.
<Page>
Each 
<Page>
element specifies a file to import. It also acts as a placeholder for a file. If the
input file contains multiple pages, a corresponding number of pages are created in the
location defined by 
<Page>
. Multipage non-image files (such as Microsoft Word documents)
are always imported as single pages. Note that some of the attributes are read during the
XML Import Connector operation. Other attributes are written by the operation.
Attribute Name/
(Read/Write)
Type
Description
ImportFileName
(Read)
String
The name of the file to import. If no file name is provided, or the
file is not found, the error “Illegal File Name” is logged.
ErrorCode
(Write)
Integer
The XML Import Connector application (
Acxmlai.exe
) adds this
attribute to the 
<Page>
element if a page-level error occurs. The
value of the attribute is the number of the error.
Note that if ErrorCode exists for the 
<Page>
element, the XML
Import Connector application (
Acxmlai.exe
) will clear it before
processing the page.
If no error occurs, this attribute is not present.
ErrorMessage
(Write)
String
The XML Import Connector application (
Acxmlai.exe
) adds this
attribute to the 
<Page>
element if a page-level error occurs. The
value of the attribute is the error message text.
Note that if ErrorMessage exists for the 
<Page>
element, the XML
Import Connector application (
Acxmlai.exe
) will clear it before
processing the page.
If no error occurs, this attribute is not present.
OriginalFileName
(Read/Write)
String
Use this optional attribute to specify the name and extension of
the imported file, if it is different than the submitted image file
name. This may be useful if files have been transported over a
network or over the Internet.
If the length of the string exceeds 250 characters (not including
the file extension) or contains invalid characters, an error is
generated.
<IndexFields> ... </IndexFields>
The 
<IndexFields>
element is a container for zero or more 
<IndexField>
elements,
which specify index field values. You can have at most one 
<IndexFields>
element for a
<Document>
element, for a 
<TableRow>
element, or for a 
<Folder>
element.
The XML Import Connector Module
Kofax Capture Administrator's Guide
259
<IndexField>
Each 
<IndexField>
value specifies an index field value. An index field that is successfully
imported receives a confidence value of 100. This index field value is not overwritten if the
batch is subsequently sent to the Recognition Server However, the parent document is still
considered unprocessed within the Validation and Verification modules.
IndexFields that are marked “required” in the batch class but do not receive a value from the
XML Import Connector file do not cause an error. It is assumed that such fields are entered in
the Validation module.
This same approach applies to validating the value. Provided the value is smaller than the
maximum field size, it is accepted without any data type checking or user-defined scripting. It
is assumed that such checking is performed from the Validation module.
Note that some of the attributes are read during the XML Import Connector operation. Other
attributes are written by the operation.
Attribute Name/
(Read/Write)
Type
Description
Name
(Read)
String
The name of the index field to fill. If the name is not found in the
batch class, the error “Field name not found” is logged.
Value
(Read)
String
The value of the index field. The value is only checked for data
type. No additional validation is performed.
There are two different methods for specifying the values of table
fields:
1. Table-aware method. If the element is a child of a TableRow
element, the attribute indicates the value for that particular row.
2. Legacy method. If the element is not a child of a TableRow
element and is a table field, the attribute specifies a delimited list
of table row values. The delimiter is the row separator defined
for the batch class. For example, “rock;scissors;paper” would
indicate 3 row values for the table.
These methods are mutually exclusive. If a TableRow element is
present for a batch, any “legacy method” table data is discarded.
If a different number of values are specified for index fields in the
same table, the number of rows in the table matches the size
needed to accommodate the largest value list for that table.
ErrorCode
(Write)
Integer
The XML Import Connector application (
Acxmlai.exe
) adds this
attribute to the 
<IndexField>
element if an error occurs. The
value of the attribute is the number of the error.
Note that if ErrorCode exists for the 
<IndexField>
element, the
XML Import Connector application (
Acxmlai.exe
) will clear it
before processing the field.
If no error occurs, this attribute is not present.
The XML Import Connector application (
Acxmlai.exe
) adds this
attribute to the 
<IndexField>
element if an error occurs. The
value of the attribute is the number of the error.
Note that if ErrorCode exists for the 
<IndexField>
element, the
XML Import Connector application (
Acxmlai.exe
) will clear it
before processing the field.
If no error occurs, this attribute is not present.
The XML Import Connector Module
260
Kofax Capture Administrator's Guide
Attribute Name/
(Read/Write)
Type
Description
ErrorMessage
(Write)
String
The XML Import Connector application (
Acxmlai.exe
) adds this
attribute to the 
<IndexField>
element if an error occurs. The
value of the attribute is the error message text.
Note that if ErrorMessage exists for the 
<IndexField>
element,
the XML Import Connector application (
Acxmlai.exe
) will clear
it before processing the field.
If no error occurs, this attribute is not present.
<Tables> ... </Tables>
The 
<Tables>
element is a container for zero or more 
<Table>
elements, which specify tables
within a document.
<Table> ... </Table>
The
<Table>
element specifies a table in a document, and has 
<TableRows>
as a child
element.
Attribute Name/
(Read/Write)
Type
Description
Name
(Read)
String
The name of the index field to fill. If the name is not found in the
batch class, the error “Field name not found” is logged.
ErrorCode
(Write)
Integer
The XML Import Connector application (
Acxmlai.exe
) adds this
attribute to the 
<Table>
element if an error occurs. The value of
the attribute will be the number of the error.
Note that if ErrorCode exists for the 
<Table>
element, the XML
Import Connector application (
Acxmlai.exe
) will clear it before
processing the field.
If no error occurs, this attribute is not present.
ErrorMessage
(Write)
String
The XML Import Connector application (
Acxmlai.exe
) adds this
attribute to the 
<Table>
element if an error occurs. The value of
the attribute will be the error message text.
Note that if ErrorMessage exists for the 
<Table>
element, the
XML Import Connector application (
Acxmlai.exe
) will clear it
before processing the field.
If no error occurs, this attribute is not present.
<TableRows> ... </TableRows>
The 
<TableRows>
element is a container for zero or more 
<TableRow>
elements, which
specify table rows within a table.
<TableRow> ... </TableRow>
The 
<TableRow>
element specifies a table row in a table, that holds a single 
<IndexFields>
element.
Documents you may be interested
Documents you may be interested