Collector Server log file

Edit online

The Collector Server log file is an ASCII file with a record for each complete transaction. A record contains fields that are delimited by a semicolon. Thus, it can easily be imported into a spreadsheet program for further evaluation. Each record has a fixed part and a variable part.

The first block of columns is fixed and thus the same for all operations. The second block varies regarding the operation. The structure of the fixed block of record fields is reflected in the examples that are shown in Table 1 and Table 2.

Table 1. The common block of columns in the Collector Server log file
1 Timestamp	2 Return code	3 Job number	4 Operation	5 Archive ID
18:47:32	-50	17	Archive	A1
14:02:21	0	16	Append	A1
...	...	...	...	...
09:42:04	0	1	Att Search	A1
09:42:05	0	8	Retrieve	A1

Table 2. The common block of columns in the Collector Server log file (continued)
6 CS server exec. time	7 Agent exec. time	8 Agent PID	9 IP Address
0.456	0.123	660031	6.132.8.58
0.217	0.035	45388	6.132.8.58
...	...	...	6.132.8.58
0.158	0.020	13564	6.132.8.58
0.149	0.018	12406	6.132.8.58

The following list briefly explains the data in each column:

Timestamp

The time when Collector Server completed the job.

Return code

The validation code that Collector Server returned for each processed job. A return code of 0 indicates a successful operation. All other codes indicate an error.

For an overview of the return codes, see Return codes.

Job number

The number that was assigned to the processed job.

Operation

The operation or the stages in the process of completing the operation.

Value	Explanation
ARCHIVE	Archiving
APPEND	Appending (adding content to an archived document)
UPDATE	Updating
FULL_RETRIEVE	Retrieving entire documents
COMP_RETRIEVE	Retrieving the specified document components
PART_RETRIEVE	Retrieving the document part as specified by the offset and the length parameter
DELETE	Deleting a document, including all its components, from the archive
STATUS	Obtaining status information
FREE_SEARCH	Searching the content of a print list for a specific search string
ATTR_SEARCH	Searching the description file of a print list for attributes
CHANGE_IC	Moving archived documents from one item type to another
SEND_BC or SENDBC	Sending bar codes to SAP
CREATE_SAP_WORKITEM or CREATEWI	Creating a work item in an SAP workflow
MKCOL	Creating a collection (BC-ILM)
PUT	Archiving a resource (BC-ILM)
GET	Retrieving a resource (BC-ILM)
HEAD	Retrieving resource or collection header data (BC-ILM)
PROPFIND	Retrieving resource or collection properties (BC-ILM)
PROPPATCH	Modifying resource or collection properties (BC-ILM)
WEBDAV_DELETE	Deleting a resource or a collection (BC-ILM)
LinkItem	Details about the processed document in the case of a SENDBC or CREATEWI request
GET_SAPATTR	Retrieving the column names of an SAP table
INDXFER_LIST	Retrieving the list of documents that are to be processed by an INDXFER request
INDXFER	Transferring the index information

Archive ID

The logical archive ID of the archive that is addressed by the operation, as specified in the server configuration profile.

CS server exec. time

The time that Collector Server and the agent needed to process the job, in seconds.

Agent exec. time

The time that the agent needed to process the job, in seconds.

Agent PID

The identification number that an agent assigns to the job that it processes, in decimals:

The number of the thread is shown. Numbering starts at 0.
The ID of the process is shown.

IP Address

The IP address of the Content Collector for SAP client that creates the job.

For information about the variable block of record fields, which varies according to the selected operation, see one or more of the following tables. Each table contains example values for Windows.

Note: Record fields that are denoted with CRI are not used by Content Collector for SAP.

Columns for operation type ARCHIVE

10 DocID	13 Content type	14 Full source file name	15 Content length
2000021421141232# 405A.0908	application/msword	D:\cstore\test\notice.doc	102717.0
...	...	...
1000911493141728# 405A.0908	text/plain	D:\cstore\test\notice.txt	4367.0

Columns for operation type APPEND

10 DocID	13 Component ID	14 Content type	15 Full source file name
2000021421141232# 405A.0908	note	FAX	D:\cstore\test\notice.doc
...		...	...
1000911493141728# 405A.0908	note	TXT	D:\cstore\test\invoice.txt

Columns for operation type UPDATE

10 DocID	13 Component ID	14 Content type	15 Full source file name
2000021421141232# 405A.0908	note	FAX	D:\cstore\test\notice.doc
...		...	...
1000911493141728# 405A.0908	note	TXT	D:\cstore\test\notice.txt

Columns for operation type INDEX_TRANSFER

10 Full source file name	11 Successes and failures
D:\transfer\test\BKPF:20020228114509000	100 successful, 5 failed
...	...
D:\transfer\test\BKPF:200202#0336501000	83 successful, 4 failed

Columns for operation type FULL_RETRIEVE

10 DocID	11 ComponentID	13 Full target file name	14 Content length
2000021421141232#405A.0908	data	D:\cstore\test\notice.txt	102717.0
...	...	...
1000911493141728#405A.0908	data	D:\cstore\test\notice.txt	4367.0

Columns for operation type COMP_RETRIEVE

10 DocID	11 ComponentID	13 Full target file name	14 Content length
2000021421141232#405A.0908	data	D:\cstore\test\notice.doc	102717.0
...	...	...
1000911493141728#405A.0908	data	D:\cstore\test\notice.txt	4367.0

Columns for operation type PART_RETRIEVE

10 DocID	11 ComponentID	13 Offset	14 Length
2000021421141232#405A.0908	data	21373.0	208.0
...	...	...	...
1000911493141728#405A.0908	data	14577.0	217.0

If an operation was successful, the value in the Length column reflects the actual length of the retrieved item. Otherwise, the Length column shows the length of the request.

Columns for operation type DELETE

10 DocID	11 ComponentID	12 CRI
2000021421141232#405A.0908	data
...	...
1000911493141728#405A.0908	data

Columns for operation type STATUS

10 DocID	11 ComponentID	12 CRI
2000021421141232#405A.0908
...
1000911493141728#405A.0908

Columns for operation type FREE_SEARCH

10 DocID	11 Pattern to be searched	12 From offset	13 To offset	14 Number of results	15 Offset of first hit	16 Length of first hit
2000021421141232#405A.0908	abc	17473.0	32000.0	8	21373.0	3
...	...	...	...	...	...	...
1000911493141728#405A.0908	qrs	17473.0	32000.0	5	21373.0	3

If an operation was successful, the Number of results column contains the actual number of hits. If it was unsuccessful, it contains the requested number of hits. The columns Offset of first hit and Length of first hit contain values only if the operation was successful.

Columns for operation type ATTR_SEARCH

10 DocID	11 Pattern to be searched	12 From offset	13 To offset	14 Number of results	15 Offset of first hit	16 Length of first hit
2000021421141232#405A.0908	0+10 +abc# 20+30 +xyz#	17473.0	32000.0	8	21373.0	3
...	...	...	...	...	...	...
1000911493141728#405A.0908	0+15 +def# 15+16 +qrs#	17473.0	32000.0	5	21373.0	3

The values in column Pattern to be searched have the following structure:

<offset>+<length>+<value>#
<offset>+<length>+<value>#
<offset>+<length>+<value>#...

Columns for operation type SEND_BC

10 DocID	11 Bar code
2000021421141232#405A.0908	barcode73211
...	...
1000911493141728#405A.0908	barcode45801

The archpro program handles requests of this type directly. Agents are not involved. Therefore, the agent execution time and the agent process ID (PID) are 0.

Columns for operation type SENDBC

The columns vary depending on whether the bar code is sent during archiving, document linking, or manual linking.

For archiving, the following columns are supplied:

Column number	Explanation
10	The number of processed documents.
11	The number of documents that were retrieved successfully.
12	The number of documents that were retrieved and linked successfully.
13	The type of operation.

For document linking and for manual linking, the following columns are supplied:

Column number	Explanation
10	The number of processed documents.
11	The number of documents that were retrieved successfully.
12	The number of documents that were retrieved and linked successfully.
13	The number of documents that were retrieved, linked, and routed successfully.
14	The type of operation.

Columns for operation type UPDATE

10 DocID	11 Action	12 Target workbasket	13 From folder	14 To folder
2000021421141232#405A.0908	attributes +workbasket +folder	WORKFLOW_WB	Folder1	Folder2
...	...	...	...	...
1000911493141728#405A.0908	attributes +workbasket +folder	STACK_1	New	Old

The values in the Action column are converted to strings and written to the server log file. The Target workbasket, From folder, and To folder columns are left empty if you do not specify a value for them in the request message.

Columns for operation type ATTR_SPEC

There are no additional columns for this operation type.

Columns for operation type CREATE_SAP_WORKITEM

10 DocID	11 Content repository	12 DocType	13 SapArObject	14 Bar code
2000021421141232#405A.0908	A1	ALF	FIIINVOICE	barcode0815
...	...	...	...	...
1000911493141728#405A.0908	A1	FAX	FAXMSG	barcode1428

Columns for operation type CREATEWI

The columns vary depending on whether the work item is created for archiving a document or for linking a document.

For archiving, the following columns are supplied:

Column number	Explanation
10	The number of processed work items.
11	The number of work items that were retrieved successfully.
12	The number of work items that were retrieved and linked successfully.
13	The type of operation.

For document linking and for manual linking, the following columns are supplied:

Column number	Explanation
10	The number of processed work items.
11	The number of work items that were retrieved successfully.
12	The number of work items that were retrieved and linked successfully.
13	The number of work items that were retrieved, linked, and routed successfully.
14	The type of operation.

Columns for operation type MKCOL

10 Resource name	11 Full source file name	12 Content length
/Coll1/Test1/		0.0
...
/Coll1/Test2/		0.0

Columns for operation type PUT

10 Resource name	11 Full source file name	12 Content length
/Coll1/Test1/res1	C:\temp\invoice.doc	245223.0
...
/Coll1/Test2/res1	C:\temp\invoice2.doc	5634535.0

Columns for operation type GET

10 Resource name	11 Full target file name	12 Offset	13 Length	14 Total length
/Coll1/Test1/res1	C:\temp\invoice.doc	0.0	245223.0	245223.0
...
/Coll1/Test2/res1	C:\temp\invoice2.doc	0.0	5634535.0	5634535.0

If the operation is completed successfully, the Length column contains the length of the retrieved content. If it fails, this column contains the requested content length.

Columns for operation type HEAD

10 Resource name	11 Full target file name	12 Offset	13 Length	14 Total length
/Coll1/Test1/	C:\temp\temp1.tmp	0.0	0.0	0.0
...
/Coll1/Test2/	C:\temp\temp2.tmp	0.0	0.0	0.0

Columns for operation type PROPFIND

10 Resource name	11 Property name 1	12 Property name 2	...
/Coll1/Test1/res1	creation_date	2015–01–01	...
...
/Coll1/Test2/res1	creation_dater	2015–01–02	...

Additional columns contain the names of all requested properties. If all properties are retrieved, only the resource name is shown.

Note: The PROPFIND operation can return huge response lists. The detailed response is not logged.

Columns for operation type PROPPATCH

10 Resource name	11 Property 1	12 Property 1 value	13 Property 2	14 Property 2 value	...
/Coll1/Test1/res1	creation_date	2005–01–01	important	true	...
...
/Coll1/Test2/res1	creation_dater	2005–02–02	important	false	...

Additional columns contain the names and the values of all modified properties.

Columns for operation type WEBDAV_DELETE

10 Resource name
/Coll1/Test1/res1
...
/Coll1/Test2/res1

Note: The WEBDAV_DELETE operation can return large response lists. The detailed response is not logged.

Columns for operation type LinkItem

The columns vary depending on whether archiving, document linking, or manual linking is involved.

For archiving, the following columns are supplied:

Column number	Explanation
10	The index of the document or the work item.
11	The return code.
12	The document ID.
13	The file name of the document.
14	The bar code of the document.
15	The return code of the retrieval step.
16	The return code of the linking step.

For document linking and for manual linking, the following columns are supplied:

Column number	Explanation
10	The index of the document or the work item.
11	The return code.
12	The document ID.
13	The work item ID of the document.
14	The bar code of the document.
15	The return code of the retrieval step.
16	The return code of the linking step.
17	The return code of the routing step.

Columns for operation types GET_SAPATTR, INDXFER_LIST, and INDXFER

The following columns are supplied:

Column number	Explanation
10	The number of hits.
11	The number of files that were created.
12	The batch size.
13	The ID of the task in IBM® Content Navigator.
14	The part of the file name that is made up of the following components: hitlist_`taskid`_`generated_key`