10 Auditing in Oracle Document Capture

Oracle Document Capture audits certain activities and saves the information in the ecAudit table in the Capture database.

You can use audit information to create reports using a third-party reporting application. For example, you might build a custom report that gives the total number of pages scanned per day by all users, by file cabinet. This would allow you to compare the output of scanning users.

This section covers the following topics:

• "ecAudit Table"

• "Scan for ISIS Activity IDs"

• "Scan for Adrenaline Activity IDs"

• "Index Activity IDs"

• "Commit Server Activity IDs"

• "Recognition Server Activity IDs"

• "Import Server Activity IDs"

10.1 ecAudit Table

Table 10-1 ecAudit Table

Column Name	Data Type	Field Length	Description
ecDate	Integer	4	Date the activity occurred.
ecTime	Integer	4	Time the activity occurred.
ecUserID	Text	20	User ID of the person who performed the activity.
ecProcessID	Text	20	Process name or tool that is logging the activity. Applicable IDs include: Indexing Scan for ISIS Scan for Adrenaline Oracle Document Capture Import Server Oracle Document Capture Recognition Server Oracle Document Capture Commit Server Batch Manager
ecActionID	Number	4	Activity ID of the activity being logged. This number is relevant only for the process or tool logging the activity.
ecActionDesc	Text	225	Description of the activity.
ecFileCabinet	Text	50	File Cabinet affected by the activity.
ecBatch	Text	50	Batch affected by the activity.
ecBatchID	Long Integer	4	Internal ID assigned to the batch.
ecActionDataInt	Long Integer	4	If the activity produces an integer result, that result is saved here.
ecActionDataFloat	Floating Point	8	If the activity produces a floating-point value result, that result is saved here.
ecActionDataText1	Text	255	If the activity produces a text result, that result is saved here.
ecActionDataText2	Text	255	Miscellaneous information about the activity.
ecActionDataText3	Text	255	Miscellaneous information about the activity.
ecActionDataText4	Text	255	Miscellaneous information about the activity.
ecActionDataText5	Text	255	Miscellaneous information about the activity.
ecErrorNum	Integer	4	Error number for auditing errors.
ecErrorDesc	Text	255	Error Description.

10.2 Scan for ISIS Activity IDs

All scanning and indexing audit information is tracked in the same table. This section describes which activities Scan audits and reports in the fields above.

In the "ecAudit Table", Date, UserID, FileCabinet, and Batch are automatically filled in for each activity. The ecActionDataText1 field always contains the scan profile name for each activity. The following table describes the remaining data elements for Scan audit activity.

Table 10-2 Scan for ISIS Activity IDs

Activity ID	Description	ecActionDataInt	ecActionDataText2
1	Create Batch	Number of pages scanned	N/A
2	Append Pages	Number of pages appended (added)	N/A
3	Insert Pages	Number of pages inserted	N/A
4	Replace Page	Page number replaced	N/A
5	Delete Batch	Number of pages deleted	N/A
6	Delete Page	Page number deleted	N/A
7	Update Batch Note	N/A	Note text
8	Print Image	N/A	Page number printed
11	Update Batch Status	N/A	New status
12	Update Batch Priority	New priority	N/A
13	Commit Profile	Number of documents committed	Internal identifier
15	Rename Batch	N/A	Original batch name
100	Reviewed Batch	Number of pages viewed	N/A
101	Scan Preview	N/A	N/A
102	Scanner Settings Opened	N/A	N/A
103	Create Scan Profile	N/A	N/A
104	Update Scan Profile	N/A	N/A
105	Delete Scan Profile	N/A	N/A

10.3 Index Activity IDs

All scanning and indexing audit information is tracked in the same table. This section describes which activities Index audits and reports in the fields listed in the previous table.

In the "ecAudit Table", Date, UserID, FileCabinet, Batch and BatchID are automatically filled in for each activity. The ecActionDataText1 field always contains the index profile name for each activity. The ecActionDataFloat field contains the total number of documents committed for activity ID 10.

Table 10-3 Index Activity IDs

Activity ID	Description	ecActionDataInt	ecActionDataText2
5	Delete Batch	Total pages in batch	N/A
6	Delete Page	N/A	Page(s) deleted
7	Update Batch Note	N/A	Note text
8	Print Image	N/A	Page number or range printed
9	Copy Image	N/A	Page number or range copied
10	Commit Batch	Total number of pages committed	Total number of pages in the batch at the time of commit
11	Update Batch Status	N/A	New status
12	Update Batch Priority	New priority	N/A
13	Commit Profile	Number of documents committed	Internal identifier
15	Rename Batch	N/A	Original batch name
200	Create New Index Profile	N/A	N/A
201	Update Index Profile	N/A	N/A
202	Delete Index Profile	N/A	N/A
203	Modify Zones	N/A	N/A
204	Select Batch	Total pages in Batch	N/A
205	Rotate Image	Page number rotated	N/A

10.4 Scan for Adrenaline Activity IDs

All scanning and indexing audit information is tracked in the same table. This section describes which activities Scan audits and reports in the fields above.

In the "ecAudit Table", Date, UserID, FileCabinet, Batch and BatchId are automatically filled in for each activity. The ecActionDataText1 field always contains the scan profile name for each activity. The following table describes the remaining data elements for Scan audit activity:

Table 10-4 Scan for Adrenaline Activity IDs

Activity ID	Description	ecActionDataInt	ecActionDataText2
1	Create Batch	Number of pages scanned	N/A
2	Append Pages	Number of pages appended (added)	N/A
3	Insert Pages	Number of pages inserted	N/A
4	Replace Page	Page number replaced	N/A
5	Delete Batch	Number of pages deleted	N/A
6	Delete Page	Page number deleted	N/A
7	Update Batch Note	N/A	Note text
8	Print Image	N/A	Page number printed
11	Update Batch Status	N/A	New status
12	Update Batch Priority	New priority	N/A
13	Commit Profile	Number of documents committed	Internal identifier
15	Rename Batch	N/A	Original batch name
100	Reviewed Batch	Number of pages viewed	N/A
101	Scan Preview	N/A	N/A
102	Scanner Settings Opened	N/A	N/A
103	Create Scan Profile	N/A	N/A
104	Update Scan Profile	N/A	N/A
105	Delete Scan Profile	N/A	N/A

10.5 Commit Server Activity IDs

This section describes the activities Commit Server audits and reports.

In the "ecAudit Table", Date, UserID, FileCabinet, and Batch are automatically filled in for each activity. The following table describes the remaining data elements for Commit Server audit activity:

Table 10-5 Commit Server Activity IDs

Activity ID	Description	ecActionDataInt	ecActionDataFloat	ecActionDataText2
10	Commit Batch	Number of pages committed	Number of documents committed	Number of pages at time of commit

10.6 Recognition Server Activity IDs

This section describes the activities Recognition Server audits and reports.

In the "ecAudit Table", Date, UserID, FileCabinet, and Batch are automatically filled in for each activity. The ecActionDataText1 field typically contains the batch job name for each activity. The following table describes the remaining data elements for Recognition Server audit activity:

Table 10-6 Recognition Server Activity IDs

Activity ID	Description	ecActionDataInt	ecActionDataText2	ecActionDataText1	ecActionDataFloat
7*	Update batch note	N/A	Updated note	N/A	N/A
11	Update batch status	N/A	Updated status	N/A	N/A
12	Update batch priority	Updated priority	N/A	N/A	N/A
500	Process batch	Number of pages processed	N/A	N/A	N/A
501**	Finish batch	Number of pages remaining after batch job completed	Name of first error batch	Name of the batch job	N/A
10	Commit batch	Total pages committed	N/A	N/A	Total documents committed

* Can be done only using a macro.

** TEXT3 = Number of pages in first error batch. TEXT4=Number of pages in second error batch.

10.7 Import Server Activity IDs

This section describes the activities Import Server audits and reports.

In the "ecAudit Table", Date, UserID, FileCabinet, and Batch are automatically filled in for each activity. The ecActionDataText1 field always contains the profile name for each activity. The following table describes the remaining data elements for Import Server audit activity:

Table 10-7 Import Server Activity IDs

Activity ID	Description	ecActionDataInt	ecActionDataText2	ecActionDataFloat
1	Create Batch	Number of pages imported	N/A	N/A
10	Commit Batch	Number of uncommitted pages	Number of pages in batch	Number of documents committed