Sign in
< Back to User Guide Top

Scheduled Report Parameters

The tables below list the parameters with their allowed values that can be used with scheduled reports. While mostly the same for all reports, there are several differences. The following tables are listed:

  • CIS & Clarify report parameters (and allowed values)
  • EBI 2 report parameters (and allowed values)
  • EEI report parameters (and allowed values)
  • Possible values for CIS Status columns
  • Possible values for Acknowledgement Status

CIS & Clarify report parameters and their allowed values

Report Parameters and <allowed values>
Transfers
  • logStatus=Error/Success/Inprogress
  • numberOfDays=<integer value>
  • status=<string value> (Ex: Error, Success, Exception)
  • direction=<string value> (Ex:receive/send)
  • tradingpartneralias=<string value>
  • host=<string value> (Ex:Extol3FTP)
  • origname=<string value> (Ex:clarifyStorageNode_64bd899f175c415b819c9b58cf1622d5)
  • filesize=<integer value> (In bytes) (Ex.22528)
  • displayname=<string value> (Ex: AS2, AS3, Local FTP Users)
  • transferid=<string value> (Ex:FTP-20170328_195944387-I)
  • vlserial=<string value> (Ex:HY0001)
  • mailbox=<string value> (Ex:extol3Ftp)
  • action=<string value> (Ex:send/receive)
  • origpath=<string value> (Ex:clarify:/Extol3Clarify/Extol3FTP)
  • origfiledt=<string value> (Ex:2017/03/28 19:59:44)
  • transfertime=<decimal value> (Ex:0.37)(in sec)
  • transferbytes=<integer value> (In bytes) (Ex.22528)
  • resulttext=<string value> (Ex:Success - Source file deleted.)
  • folder=<string value>
  • copypath=<string value>
  • runtype=<string value> (Ex:Scheduled)
  • filetype=<string value>
  • trackedtype=<string value>
  • ipaddress=<string value>
  • hostmailbox=<string value> (Ex: Extol3FTP, extol3Ftp)
  • startdtint=<integer value>
  • enddtint=<integer value>
  • username=<string value>
SLAs
  • status=Error/Success
  • numberOfDays=<integer value>
  • transferid=<string value> (Ex:CHECK-19880921_073806992-BI)
  • vlserial=<string value> (Ex:HY0001)
  • host=<string value> (Ex:Extol3FTP)
  • mailbox=<string value> (Ex:extol3Ftp)
  • action=<string value> (Ex:send/receive)
  • resulttext=<string value> (Ex:Success - Source file deleted.)
  • folder=<string value>
  • runtype=<string value> (Ex:Scheduled)
  • startdtint=<integer value> (Ex: 590845086000)
  • enddtint=<integer value> (Ex:590845086000)
  • tradingpartneralias=<string value> (Ex:~Unassigned~)
  • checktype=<string value> (Ex:File Age)
  • subclass=Age >=<string value> (Ex: 5 Seconds)
  • timecondition=<string value>
  • direction=<string value> (Ex:receive/send)
  • recurse=<string value>
  • status_slakpi=<string value>
  • count=<string value>
  • sender=<string value>
  • receiver=<string value>
  • functionalgroupsender=<string value>
  • functionalgroupreceiver=<string value>
  • transactiontype=<string value>
  • documenttype=<string value>
  • hostmailbox=<string value>
  • filepath=<string value>
CIS Transfers
  • logStatus=Error/Success/Inprogress
  • numberOfDays=<integer value>
  • CALCULA010(Startddtnt)=<integer value> (Ex:1490745589000)
  • CALCULA003(Direction)=Receive/Send
  • CALCULA004(Connection)=<string value>
  • CALCULA005(File)=<string value>
  • CALCULA006(Size)=<integer value> (Ex:)
  • CALCULA007(Protocol)=<string value> (In bytes) (Ex.22528)
  • transferid=<string value>
  • CONNECTION_NUMBER=<integer value> (Ex:4239)
Connection Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • ID=<string value> (Connection ID)
  • STATUS=<int value>(Ex:5,10,11,31)**
  • CONNECTION_NUMBER=<integer value>
  • LOG_ORIGIN_OBJECT=<string value>
  • CONNECTION_DIRECTION=<string value>
  • CALCULA001= Send /Receive(Direction)
Interchange Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • INTERCHANGE_CONTROL_REF=<string value>
  • DISPLAY_NAME=<string value>(Trading Partner)
  • INTERCHANGE_DIRECTION=R/SSTATUS=<integer value>(Ex:5,10,11,31)**
  • ACK_STATUS=<integer value>(Acknowledge status)*
  • CONNECTION_LOG_NUMBER=<integer value>
  • SENDER_ID=<string value>
  • RECEIVER_ID=<string value>
  • logAckStatus= error/success(Acknowledge status grouping)
Group Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • GROUP_CONTROL_REFERENCE=<string value>
  • ACK_STATUS=<integer value>(Ack status)
  • *STATUS=<integer value> (Ex:1,5,31..)**
  • GROUP_DIRECTION=R/S
  • DISPLAY_NAME=<string value> (Trading Partner)
  • INTERCHANGE_CONTROL_REF=<string value>
  • INTERCHANGE_LOG_NUMBER=<string value>
  • GROUP_CODE=<string value>(Ex; PO,FA…)
  • logAckStatus=success/error(Acknowledge status grouping)
Message Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • tradingPartner=<name of trading partner>
  • GROUP_LOG_NUMBER=<string value>
  • ACK_STATUS=<integer value>(Ack status)*
  • STATUS=<integer value> (Ex:1,5,31..)**
  • MESSAGE_DIRECTION=R/S
  • INTERCHANGE_CONTROL_REF=<string value>
  • GROUP_CONTROL_REFERENCE=<string value>
  • MESSAGE_CONTROL_REFERENCE=<string value>
  • INTERCHANGE_LOG_NUMBER=<string value>
  • MESSAGE_ID=<string value>(Ex:997,810,IFTMIN...)(Doc id)
  • logAckStatus=success/error(Acknowledge status grouping)
  • Note: this parameter functions as a case insensitive, SQL LIKE, for example, if you have two trading partners, ACME, and acme 997, and you searched for "acme", it would return both trading partners.
Message Inquiry Inbound Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • GROUP_LOG_NUMBER=<string value>
  • ACK_STATUS=<integer value>(Ack status)*
  • STATUS=<integer value> (Ex:1,5,31..)**
  • MESSAGE_DIRECTION=R/S
  • DISPLAY_NAME=<string value> (Trading Partner)
  • INTERCHANGE_CONTROL_REF=<string value>
  • GROUP_CONTROL_REFERENCE=<string value>
  • MESSAGE_CONTROL_REFERENCE=<string value>
  • INTERCHANGE_LOG_NUMBER=<string value>
  • MESSAGE_ID=<string value>(Ex:997,810,IFTMIN...)(Doc id) logAckStatus=success/error(Acknowledge status grouping)
Message Inquiry Outbound Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • GROUP_LOG_NUMBER=<string value>
  • ACK_STATUS=<integer value>(Ack status)*
  • STATUS=<integer value> (Ex:1,5,31..)**
  • MESSAGE_DIRECTION=R/S
  • DISPLAY_NAME=<string value> (Trading Partner)
  • INTERCHANGE_CONTROL_REF=<string value>
  • GROUP_CONTROL_REFERENCE=<string value>
  • MESSAGE_CONTROL_REFERENCE=<string value>
  • INTERCHANGE_LOG_NUMBER=<string value>
  • MESSAGE_ID=<string value>(Ex:997,810,IFTMIN...)(Doc id)
  • logAckStatus=success/error(Acknowledge status grouping)
Late Acknowledge Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • ACK_STATUS=<integer value>(Ack status)*
  • STATUS=<integer value> (Ex:1,5,31..)**
  • GROUP_DIRECTION=R/S
  • DISPLAY_NAME=<string value> (Trading Partner)
  • INTERCHANGE_CONTROL_REF=<string value>
  • GROUP_CONTROL_REFERENCE=<string value>
  • TRADING_PARTNER_ID=<string value>
  • INTERCHANGE_LOG_NUMBER=<string value>
  • logAckStatus=success/error(Acknowledge status grouping)

EBI 2 report parameters and their allowed values

Report Parameters and <allowed values>
EBI2 Connection Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • dataSource=<data source id>
EBI2 Interchange Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • dataSource=<data source id>
EBI2 Group Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • dataSource=<data source id>
EBI2 Message Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • endpointName=<name of endpoint>
    Note: this parameter functions as a case insensitive, SQL LIKE, for example, if you have two endpoints, ACME, and acme 997, and you searched for "acme", it would return both endpoints.
  • dataSource=<data source id>
EBI2 Message Inquiry Inbound Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • dataSource=<data source id>
EBI2 Message Inquiry Outbound Report
  • logStatus=error/success
  • numberOfDays=<integer value>
  • dataSource=<data source id>

EEI report parameters and their allowed values

Report Parameters and <allowed values>
EEI Connection Report
  • sendStatus=error/success
  • receiveStatus=error/success
  • numberOfDays=<integer value>
  • dataSource=<data source id>
  • connectionLogNumber=<integer value>(Ex:1234)
  • networkId=<String value>(Ex: *AFT_EXAMPLES)
EEI Interchange Report
  • status=error/success
  • numberOfDays=<integer value>
  • dataSource=<data source id>
  • ackStatus=success/error
  • connectionLogNumber=<integer value>(Ex:1234)
  • tradingPartner=<string value>
  • ICN=<integer value>(Ex:1234)
  • direction=S/R
EEI Group Report
  • status=error/success
  • numberOfDays=<integer value>
  • dataSource=<data source id>
  • ackStatus=success/error
  • connectionLogNumber=<integer value>(Ex:1234)
  • tradingPartner=<string value>
  • ICN=<integer value>(Ex:1234)
  • GCN=<integer value>(Ex:1234)
  • direction=S/R
  • groupCode=<string value>(Ex:PO,FA,HB...)
EEI Message Report
  • status=error/success
  • numberOfDays=<integer value>
  • dataSource=<data source id>
  • ackStatus=success/error
  • connectionLogNumber=<integer value>(Ex:1234)
  • tradingPartner=<string value>
  • ICN=<integer value>(Ex:1234)
  • GCN=<integer value>(Ex:1234)
  • TSCN=<integer value>(Ex:1234)
  • direction=S/R
  • docID=<string value>(Ex:*ACK,850...)

Possible values for CIS status columns

Not Considered Status Code Error Status Code Success Status Code
Ready to start 0 Stopped 3 Active 1
"Suspended" 2 Failed 4 Completed 5
"Started" 8 Completed with errors 7 Completed with errors 6
Warning 9 Gen, enveloped, env error 11 "Mixed status at lower lvl" 19
Gen, env, wrapped, sent 10 Gen, wrap - error on send 13 "Accepted with errors" 40
Gen, enveloped, wrapped 12 Gen, wrap - error on wrap 14 "Accepted" 41
Generated", "Generated 15 "Generated - error on gen" 16 Partially accepted 42
"Generated and enveloped" 17 Rcvd, unwrap - err on unw 22 Sleeping 44
Marked for purging 18 Rcvd, unwrap, trans error 23 ESX Message Delivered 49
Out app data ready to gen 20 Receive error 24 "Queued for Processing" 50
Rcvd, unw, trans, added 21 Received - duplicate 25    
"Received and unwrapped" 26 Functional Group Not Found 34    
"Received only" 27 Transaction Set not found 35    
"Received unwrap 28 Multiple Functional Groups found 36    
Unwrapped 29 Functional Group was previously Acknowledged 37    
Initialized 31 Transaction Set was previously Acknowledged 38    
None 32 Multiple Transaction Sets found 39    
Pending 33 Interchange not found 45    
Pending Retry 52 Multiple Interchanges found 46    
"Retrying" 53 Interchange was previously Acknowledged 47    
Cancelled Retry 54 ESX Message Failure 48    
    Unwrapped - no EDI data 30    
    Rejected 43    
    Acknowledged at a higher level 51    

Possible values for Acknowledgement status

Status Description
5387 Acknowledgement generated
5384 Accepted
5388 Acknowledged at a higher level
5379 Acknowledgement in process
5378 Acknowledgement Pending
5377 No Acknowledgement Required
5382 No Acknowledgement Received
5381 Acknowledgement sent
5380 Acknowledgement processed

Related articles

Comments

0 comments

Please sign in to leave a comment.