Protocol file structures

The following table describes all elements that can occur in a protocol file also depending on the operation and the protocol type. Not all elements are always present. The abbreviations have the following meanings:

  • X: The element is present.

  • O: The element is optional.

  • D: There is a dependency. The element may only occur in certain entries.

For example, some entries refer to the state of the overall run, which is typically characterized by general parameters such as the common batch directory or a common request ID, while other entries refer to the state of a single item which can be characterized by a more specific parameter such as the item’s individual revision ID or a file path to the control file (such as “meta.xml” or “update.xml”). In the XML protocol file examples beneath this table (appendices Import – Update) optional values are also indicated by square brackets.

Element

Description

Type

Operation

 

Protocol Type (Type): Success, Error, STate
Operations: Import, Update, Export, Delete

S

E

T

I

U

E

D

<newRun/>

a signal that a new FIS run has been started

O

O

O

O

O

O

O

<entry>

log file entry bracketed by the entry tag

X

X

X

X

X

X

X

<pid>

a unique process identifier which is provided as parameter via the command line call when invoking a FIS run

X

X

X

X

X

X

X

<date>

the date and time when the process that generated the protocol file has finished

The format is the ISO XML standard YYYY-MM-DD’T’HH:MI:SS.(milliseconds)(timezone), e.g.:

2013-03-07T13:55:52.760+01:00

X

X

X

X

X

X

X

<command>

the used FIS command, e.g.: ArchiveDocuments, UpdateDocuments, ExportObjects, DeleteObjects, BulkUpdateAttributes, ArchiveSapDocuments or ExportSapObjects

X

X

X

X

X

X

X

<directory>

the batch directory (present in entries for the states STARTED, FINISHED, and ABORTED)

 

 

X

X

X

X

X

<filePath>

The order file, i.e. “meta.xml” with its relative file path in the batch directory concerning the current entry, e.g.:

…\0000000001.sec\0000000001.tra\0000000001\meta.xml

D

D

D

D

D

 

 

<sapDocId>

SAP document ID in case of an SAP operation

X

X

X

X

O

X

O

<state>

the state of the item from the current entry, i.e. in a success protocol OK, in an error protocol NOK and in a state protocol either one of these or RUNNING

For each FIS run there is also one overall entry with the state STARTED in the beginning and FINISHED or ABORTED in the ending. Furthermore, the state PREPARE can occur after a start and the state REORGANIZE after a failure occurred and a retry attempt is started.

X

X

X

X

X

X

X

<batchId>

the batch ID (which is only present in batch import processes)

X

 

 

X

 

 

 

<error>

   <code>...</code>
   <message>...</message>
   <id>...</id>
   <property ...>...</property>

a section which contains error information in subtags with an ImageMaster error code, message text, ID, and possibly with further descriptive properties

 

X

 

X

 

X

X

<attributes>

the affected attributes in the operation on the current entry

 

X

 

X

 

 

 

<operation>

the current operation in a state protocol, i.e. one of: archiveDocument, search, delete, deleteOperation, processHitlist,

evalResult, resultAdded, hitAdded, writeData, itemAdded, bulk update

 

 

X

X

X

X

X

<requestId>

an ID that is used in the Integration Service log files and which enables  further detailed  analysis

 

 

D

D

D

 

 

<searchId>

an ID (UUID) referring to the search definition file “export.xml”

D

D

D

 

 

D

D

<updateId>

an ID referring to attribute bulk update orders in “update.xml”

X

X

X

 

X

 

 

<hits>

the number of successfully deleted or exported hits

X

 

 

 

 

X

X

<documentId>

a document ID

X

 

D

X

X

D

D

<revisionId>

a revision ID

X

 

D

X

X

D

D

<action>

an additional action information

 

 

D

 

 

D

D

<info>

provides statistical information on an overall run such as the total run time or the total number of affected items, failures or requests

 

 

X

X

X

X

X