Session Audit File |
  
|
Session Audit File |
|
General Information
At the end of every communication session eXite® provides a Session Audit File (SAF). This XML file includes general information about the file itself, detailed information about all transmitted interchanges and a session summary.
Examples
positive
The excerpt below shows an example of a SAF.
<?xml version="1.0" encoding="UTF-8"?> <ProtocolInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocat... <JobRef> <ProtocolDate>2007-09-20</ProtocolDate> <ProtocolTime>13:31:45</ProtocolTime> <SessionRef>734256</SessionRef> <SessionStatus>OK</SessionStatus> </JobRef> <ProtocolDescription> <Interchange> <ExiteICID>070920309324</ExiteICID> <CustomerICID>7845645</CustomerICID> <From>SYSADMIN01</From> <To>SYSADMIN01</To> <DateIn>2007-09-20</DateIn> <TimeIn>13:31:45</TimeIn> <SizeInBytes>2534</SizeInBytes> <GatewayData>N</GatewayData> <MessageClass>ORDERS</MessageClass> </Interchange> <Interchange> <ExiteICID>070920309323</ExiteICID> <CustomerICID>745675</CustomerICID> <From>SYSADMIN01</From> <To>SYSADMIN01</To> <DateIn>2007-09-20</DateIn> <TimeIn>13:31:44</TimeIn> <SizeInBytes>2000</SizeInBytes> <GatewayData>N</GatewayData> <MessageClass>ORDERS</MessageClass> </Interchange> </ProtocolDescription> <SessionAccounting> <SizeInBytes>4534</SizeInBytes> <NumberOfInterchanges>2</NumberOfInterchanges> </SessionAccounting> <Signature xmlns="http://www.w3.org/2000/09/xmldsig#"> <SignedInfo> <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315#With... <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/> <Reference URI=""> <Transforms> <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/> </Transforms> <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/> <DigestValue>OJNVYrhLeO7dhYFOAu5rnnCoGdk=</DigestValue> </Reference> </SignedInfo> <SignatureValue>Ix3cwJYKvO5m0uWfcuM4BoEm+0OA2I/xht+K5ygZeP8mz7VRNp96YRV8OKUKDN4pvqya0UEcS... <KeyInfo> <X509Data> <X509Certificate>MIIE4DCCA8igAwIBAgIDAuP5MA0GCSqGSIb3DQEBBQUAMIGfMQswCQYDVQQGEwJBVDFIM... </X509Data> </KeyInfo> </Signature> </ProtocolInfo> |
negative
The excerpt below shows a SAF example of a negative sending session. The receiver was unknown, so additional error tags were created. They show the error severity, error code and an error description. Additionally the session sum is 0, because nothing was successfully transmitted.
<?xml version="1.0" encoding="UTF-8"?> <ProtocolInfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocat... <JobRef> <ProtocolDate>2007-09-20</ProtocolDate> <ProtocolTime>15:34:45</ProtocolTime> <SessionRef>767210</SessionRef> <SessionStatus>OK</SessionStatus> </JobRef> <ProtocolDescription> <Interchange> <ExiteICID>070920309576</ExiteICID> <CustomerICID>987654321</CustomerICID> <From>SYSADMIN01</From> <To>SYSADMIN02</To> <DateIn>2007-09-20</DateIn> <TimeIn>15:34:45</TimeIn> <SizeInBytes>0</SizeInBytes> <GatewayData>N</GatewayData> <MessageClass>ORDERS</MessageClass> <Error> <ErrorSeverity>70</ErrorSeverity> <ErrorType>EDI210D</ErrorType> <ErrorText>^INVALID RECIPIENT ADDRESS</ErrorText> </Error> </Interchange> </ProtocolDescription> <SessionAccounting> <SizeInBytes>0</SizeInBytes> <NumberOfInterchanges>0</NumberOfInterchanges> </SessionAccounting> <Signature xmlns="http://www.w3.org/2000/09/xmldsig#"> <SignedInfo> <CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315#With... <SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/> <Reference URI=""> <Transforms> <Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/> </Transforms> <DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/> <DigestValue>OJNVYrhLeO7dhYFOAu5rnnCoGdk=</DigestValue> </Reference> </SignedInfo> <SignatureValue>Ix3cwJYKvO5m0uWfcuM4BoEm+0OA2I/xht+K5ygZeP8mz7VRNp96YRV8OKUKDN4pvqya0UEcS... <KeyInfo> <X509Data> <X509Certificate>MIIE4DCCA8igAwIBAgIDAuP5MA0GCSqGSIb3DQEBBQUAMIGfMQswCQYDVQQGEwJBVDFIM... </X509Data> </KeyInfo> </Signature> </ProtocolInfo> |
Field Descriptions
Tag Name |
Occurence |
Description |
Type |
Codes |
<ProtocolInfo> |
1 |
head tag including namespace and schema definitions |
||
<JobRef> |
1 |
general session information |
||
<ProtocolDate> |
1 |
session audit file generation date |
date |
|
<ProtocolTime> |
1 |
session audit file generation time |
time |
|
<SessionRef> |
1 |
session reference number created by eXite® |
an 6 |
|
<SessionStatus> |
1 |
session status |
an 5 |
OK, ERROR |
</JobRef> |
||||
<ProtocolDescription> |
1 |
includes all the transmitted interchanges |
||
<Interchange> |
1 - ∞ |
starting tag for each transmitted interchange |
||
<ExiteICID> |
1 |
eXite® internal interchange ID |
an 12 |
|
<CustomerICID> |
1 |
UNB Refererence number of the transmitted interchange |
an 14 |
|
<From> |
1 |
sender GLN of the transmitted interchange |
an 15 |
|
<To> |
1 |
receiver GLN of the transmitted interchange |
an 15 |
|
<DateIn> |
1 |
date, when the interchange was sent to eXite® |
date |
|
<TimeIn> |
1 |
time, when the interchange was sent to eXite® |
time |
|
<DateOut> |
0 - 1 |
date, when the interchange was received from eXite® |
date |
|
<TimeOut> |
0 - 1 |
time, when the interchange was received from eXite® |
time |
|
<SizeInBytes> |
1 |
size of the transmitted interchange in bytes |
n unsignedInt |
|
<GatewayData> |
1 |
was the interchange sent / received via a gateway (non-eXite® partner) |
an 1 |
Y…Yes, N…No |
<MessageClass> |
1 |
message class / type used in EDIFACT UNB envelope |
an 15 |
|
<Error> |
0 - 1 |
trigger if an error occured |
||
<ErrorSeverity> |
1 |
error severity |
n 2 |
|
<ErrorType> |
1 |
type of error as code |
an 7 |
|
<ErrorText> |
1 |
plain error text |
an 512 |
|
</Error> |
||||
</Interchange> |
||||
</ProtocolDescription> |
||||
<SessionAccounting> |
1 |
overall session information |
||
<SizeInBytes> |
1 |
sum of all successful interchange sizes in bytes within the session |
n unsignedInt |
|
<NumberOfInterchanges> |
1 |
total number of all successful interchanges within the session |
n unsignedInt |
|
</SessionAccounting> |
||||
<Signature> |
1 |
standard XML signature tags |
||
</Signature> |
||||
</ProtocolInfo> |
Terms
ointerchange: UNB-UNZ
oGLN: Global Location Number
oan: alphanumeric
on: numeric