Appendix D: Data Dictionary

This appendix describes the fields in your log files. A data dictionary is a collection of descriptions of the data objects or items in a data model. You can consult a data dictionary to understand where a data item fits in the structure and what values it can contain.

Table D-20 shows the fields in the ARCHFILE log file.

Table D-1: Field descriptions for the ARCHFILE file

Field

Datatype

Width

Description

T_STAMP

Text

50

Timestamp, the date and time for archiving and put at the end of the archived file

FILENAME

Text

100

Name of the archived file

FOLDERNAME

Text

200

Directory where the archived file is located

EXPIREDATE

Text

50

Reserved for future use

STORDATE

Date/Time

--

The date of archiving

STORETIME

Date/Time

--

The time of archiving

ORIGFOLDER

Text

200

Directory where the file to be archived will be located

ORIGFILE

Text

100

The file to be archived

ARCHIVEEXE

Text

255

Executable name for archive, currently is FileCopy or empty

RESTOREEXE

Text

255

Executable name for restore, currently is FileCopy or empty

S_D_ORDER

Text

1

Reserved for future use

LONGFILE

Text

1

Reserved for future use

R_DEST

Text

1

Reserved for future use

OPERATOR

Text

50

Reserved for future use

RUN_LOCAL

Text

1

Indicator if archive is in the local machine, even if there are remote Source or Destination IP and port provided

Table D-2 shows the fields in the COMMCH log file.

Table D-2: Field descriptions for the COMMCH file

Field

Datatype

Width

Description

CH_NAME

Text

50

The name for Communication Channel

CH_TYPE

Text

50

Communication Channel Type: FTP, and so on

TEMPSCRIPT

Text

1

If this channel uses template script file, Y: Yes, N: No

DESCRIPT

Text

255

Description for this channel

MBOXNAME

Date/Time

50

MailBox name for this channel

MBOXFOLDER

Date/Time

200

MailBox folder for this channel

DIRECTION

Text

10

Direction of this channel: send, receive, or both

INPUTFILE

Text

255

The template script file name

RECVFILE

Text

255

Name of the file to be received

SENDFILE

Text

255

Name of the file to be sent

SCRIPTFILE

Text

255

Script file name

COMMEXE

Text

255

Communication executable name for channel type Async-Other

USERID

Text

50

User ID

USRACCOUNT

Text

50

User account

USERPWD

Text

30

User password

HOSTID

Text

100

Server name for FTP server

PHONENO

Text

20

Reserved for future use

PORT

Text

5

Port number for FTP server

FWSERVER

Text

100

Firewall Server name for FTP

FWPORT

Text

5

Port number for firewall FTP server

PASSIVE

Text

1

FTP server transfer file in passive mode

PAR0NAME

Text

50

The first parameter name in the template script file

PAR0VALUE

Text

200

The value for the first parameter

PAR1NAME

Text

50

The second parameter name in the template script file

PAR1VALUE

Text

200

The value for the second parameter

PAR2NAME

Text

50

The third parameter name in the template script file

PAR2VALUE

Text

200

The value for the third parameter

PAR3NAME

Text

50

The fourth parameter name in the template script file

PAR3VALUE

Text

200

The value for the fourth parameter

PAR4NAME

Text

50

The fifth parameter name in the template script file

PAR4VALUE

Text

200

The value for the fifth parameter

PAR5NAME

Text

50

The sixth parameter name in the template script file

PAR5VALUE

Text

200

The value for the sixth parameter

PAR6NAME

Text

50

The seventh parameter name in the template script file

PAR6VALUE

Text

200

The value for the seventh parameter

PAR7NAME

Text

50

The eighth parameter name in the template script file

PAR7VALUE

Text

200

The value for the eighth parameter

PAR8NAME

Text

50

The ninth parameter name in the template script file

PAR8VALUE

Text

200

The value for the ninth parameter

PAR9NAME

Text

50

The tenth parameter name in the template script file

PAR9VALUE

Text

200

The value for the tenth parameter

PAR10NAME

Text

50

The eleventh parameter name in the template script file

PAR10VALUE

Text

200

The value for the eleventh parameter

PAR11NAME

Text

50

The twelfth parameter name in the template script file

PAR11VALUE

Text

200

The value for the twelfth parameter

PAR12NAME

Text

50

The thirteenth parameter name in the template script file

PAR12VALUE

Text

200

The value for the thirteenth parameter

PAR13NAME

Text

50

The fourteenth parameter name in the template script file

PAR13VALUE

Text

200

The value for the fourteenth parameter

PAR14NAME

Text

50

The twelfth parameter name in the template script file

PAR14VALUE

Text

200

The value for the twelfth parameter

PAR14NAME

Text

50

The fifteenth parameter name in the template script file

PAR15VALUE

Text

200

The value for the sixteenth parameter

PAR16NAME

Text

50

The seventeenth parameter name in the template script filee

PAR16VALUE

Text

200

The value for the seventeenth parameter

PAR17NAME

Text

50

The eighteenth parameter name in the template script file

PAR17VALUE

Text

200

The value for the eighteenth parameter

PAR18NAME

Text

50

The nineteenth parameter name in the template script file

PAR18VALUE

Text

200

The value for the nineteenth parameter

PAR19NAME

Text

50

The twentieth parameter name in the template script file

PAR19VALUE

Text

200

The value for the twentieth parameter

Table D-3 shows the fields in the ERROR log file.

Table D-3: Field descriptions for the ERROR file

Field

Datatype

Width

Description

RUN_ID

Number

9

Run ID

ISA_SEND

Text

35

ISA Send

ISA_RECV

Text

35

ISA Receiver

GS_SEND

Text

35

Group Start Send

GS_RECV

Text

35

Group Start Receive

GS_NUMBER

Text

35

Group Start Segment Number

ST_NUMBER

Text

35

Transaction Start Number

TRANS_NAME

Text

3

Transaction Name

SEGMENT

Text

3

Segment

SEG_NUMBER

Text

10

Segment Number

SEG_ERROR

Text

50

Segment Error

ELEM_NO

Text

2

Element Number

SUBELEM_NO

Text

2

Sub-element Number

ELEM_ERROR

Text

50

Element Error

Table D-4 shows the fields in the ISSERV log file.

Table D-4: Field descriptions for the ISSERV file

Field

Datatype

Width

IS_KEY

AutoNumber

Long Integer

IS_SYSTEM

Text

50

IS_NAME

Text

1

IS_TYPE

Text

100

IS_P_STR

Date/Time

120

IS_INDIR

Date/Time

250

IS_C_STR

Text

250

IS_C_STR2

Text

250

IS_OUTDIR

Text

120

IS_R_IP

Text

15

IS_R_PORT

Number

Long Integer

IS_ENABLE

Text

1

IDENTITY

Text

12

CODE

Text

12

DESC

Text

55

DISPLAYED

Text

100

Table D-5 shows the fields in the LOOKUP log file.

Table D-5: Field descriptions for the LOOKUP file

Field

Datatype

Width

Description

IDENTITY

Text

12

The name for the entity to look up

CODE

Text

12

Code value for this entity

DESC

Text

55

Description for this entity

DISPLAYED

Text

100

The information which is displayed on the screen for this entity

Table D-6 shows the fields in the MBOX log file.

Table D-6: Field descriptions for the MBOX file

Field

Datatype

Width

Description

MBOXNAME

Text

50

MailBox name

MBOXFOLDER

Text

200

MailBox folder

USERTYPE

Text

20

Reserved for future use

Table D-7 shows the fields in the PASSWORD log file.

Table D-7: Field descriptions for the PASSWORD file

Field

Datatype

Width

Description

USERNAME

Text

50

User name for EC Gateway

USERPASSWORD

Text

50

User password

SYSTEMRIGHT

Text

Yes/No

If user has right to use System

CHANNELRIGHT

Yes/No

Yes/No

If user has right to use Channel

MAILBOXRIGHT

Yes/No

Yes/No

If user has right to use Mailbox

TPRIGHT

Yes/No

Yes/No

If user has right to use TradePartner

COMPANYRIGHT

Yes/No

Yes/No

If user has right to use Company ID

SCHEDULERIGHT

Yes/No

Yes/No

If user has right to use Scheduler

PROCESSRIGHT

Yes/No

Yes/No

If user has right to use Process

RUNMAPRIGHT

Yes/No

Yes/No

If user has right to use Run Map

LOGRIGHT

Yes/No

Yes/No

If user has right to use Log

REPORTRIGHT

Yes/No

Yes/No

If user has right to use Report

ARCHIVERIGHT

Yes/No

Yes/No

If user has right to use Archive

RESTORERIGHT

Yes/No

Yes/No

If user has right to use Restore

Table D-8 shows fields of the PROCFILE file.

Table D-8: Field descriptions for the PROCFILE

Field

Datatype

Width

Description

P_NAME

Text

50

Process name

P_ORDER

Number

200

Directory where the process is located

P_LABEL

Text

50

For future use

DISABLED

Text

255

Description for the process

CMDNAME

Number

Double

For future use

CMDNUMBER

Number

Long Integer

The number for this command used by the program

CMDTEXT

Text

255

Command text displayed on screen

OPERAND1

Text

255

Info displayed in the first text box on the command screen

OPERAND2

Text

255

Info displayed in the second text box on the command screen

OPERAND3

Text

255

Info displayed in the third text box on the command screen

OPERAND4

Text

255

Info displayed in the fourth text box on the command screen

OPERAND5

Text

255

Info displayed in the fifth text box on the command screen

OPERAND6

Text

255

Info displayed in the sixth text box on the command screen

OPERAND7

Text

255

Info displayed in the seventh text box on the command screen

OPERAND8

Text

255

Internal Use

OPERAND9

Text

255

Internal Use

OPERAND10

Text

255

Internal Use

OPERAND11

Memo

--

For info longer than 256 characters

PARAMCODE1

Number

Long Integer

Internal Use

PARAMCODE2

Number

Long Integer

Internal Use

PARAMCODE3

Number

Long Integer

Internal Use

PARAMCODE4

Number

Long Integer

Internal Use

PARAMCODE5

Number

Long Integer

Internal Use

PARAMCODE6

Number

Long Integer

Internal Use

PARAMCODE7

Number

Long Integer

Internal Use

Table D-9 shows the PROCNAME file.

Table D-9: Field descriptions for the PROCNAME file

Field

Datatype

Width

Description

P_NAME

Text

50

Process name

P_FOLDER

Text

200

Directory where the process is located

P_TYPE

Text

50

For future use

DESCRIPT

Text

255

Description for the process

PARAMNO

Number

Double

For future use

Table D-10 shows the RUN_ID file.

Table D-10: Field descriptions for the RUN_ID file

Field

Datatype

Width

Description

RUN_NO

Number

Single

Run ID, every time a process, map, e-ftp, or pfs/async is run, this number is increased by one and used as the indicator of this processing in the log table

Table D-11 shows the fields in the SMON log file.

Table D-11: Fields descriptions for the SMON file

Field

Datatype

Width

This table is for Interactive Gateway only

SM_SYSTEM

Number

50

SM_IP

Text

50

SM_PORT

Number

Long Integer

SM_MINS

Number

Longer Integer

Table D-12 shows the fields in the SPORT log file.

Table D-12: Fields descriptions for the SPORT file

Field

Datatype

Width

This table is for Interactive Gateway only

SM_SYSTEM

Text

50

SM_NAME

Text

50

SM_PORT

Number

Long Integer

SM_PTYPE

Number

Longer Integer

Table D-13 shows the fields in the SSERV log file.

Table D-13: Fields descriptions for the SSERV file

Field

Datatype

Width

This table is for Interactive Gateway only

SS_SYSTEM

Text

50

SM_NAME

Text

50

SS_IP

Text

50

SM_PORT

Number

Longer Integer

SM_NPORT

Number

Longer Integer

SS_MPORT

Number

Longer Integer

Table D-14 shows the fields in the SYSTEM log file.

Table D-14: Field descriptions for the SYSTEM file

Field

Datatype

Width

This table is for Interactive Gateway only

SYSTEMNAME

Text

50

The system name

TPDSN

Text

50

ODBC Data Source Name for Trading Partner database

LOGDSN

Text

50

ODBC Data Source Name for Log database

TPCON

Text

250

ODBC Connection String for Trading Partner database

LOGCON

Text

250

ODBC Connection String for Log database

ARCHIVEDIR

Text

200

Directory for Archive destination

MAPDIR

Text

200

Map directory

MBOXDIR

Text

200

Main MailBox directory

EMAILEXE

Text

255

E-mail executable name

FAXEXE

Text

255

FAX executable name

ENCRYPTEXE

Text

255

Encrypt executable name

DECRYPTEXE

Text

255

Decrypt executable name

SYSTEMDSN

Text

50

ODBC Data Source Name for System database

SYSTEMCON

Text

250

ODBC Connection String for System database

SYSTEMHOST

Text

100

Reserved for future use

SOURCEIP

Text

50

Source machine IP address for Archive

SOURCEPORT

Text

10

Source machine port number for Archive

SOURCEDIR

Text

200

Directory for Archive source

ARCHIVEIP

Text

50

Destination machine IP address for Archive

ARCH_PORT

Text

10

Destination machine port number for Archive

RUNUNIX

Text

1

If this system is for UNIX there is a different Scheduler functionality

Table D-15 shows the fields in the SYSUSER log file.

Table D-15: Field descriptions for the SYSUSER file

Field

Datatype

Width

This table is for Interactive Gateway only

USERNAME

Text

50

User name for the systems, which uses this database as their system database, systems are database-based. If different systems use the same database, all the system tables are shared.

USERPWD

Text

10

Password

CREATOR

Text

50

Reserved for future use

Table D-16 shows the fields in the TEMPPROC log file.

Table D-16: Field descriptions for the TEMPPROC file

Field

Datatype

Width

This table is for Interactive Gateway only

SCRIPTLINE

Number

Long Integer

For internal use only. For temporary storage during creation process.

P_NAME

Text

50

OPERAND1

Text

255

OPERAND2

Text

255

OPERAND3

Text

255

OPERAND4

Text

255

OPERAND5

Text

255

OPERAND6

Text

255

OPERAND7

Text

255

OPERAND8

Text

255

OPERAND9

Text

255

OPERAND10

Text

255

OPERAND11

Text

255

OPERAND12

Text

255

OPERAND13

Text

255

OPERAND14

Text

255

OPERAND15

Text

255

OPERAND16

Text

255

OPERAND17

Text

255

OPERAND18

Text

255

OPERAND19

Text

255

OPERAND20

Text

255

OPERAND21

Memo

--

Table D-17 shows the fields in the TP DATABASE log file.

Table D-17: Field descriptions for the TP DATABASE file

Field

Datatype

Width

Description

CUST NO

Text

35

Trading Partner ID

<filer>

Text

1

Not Used

NAME

Text

35

Internal name of trading partner

IDQUAL

Text

4

ID Qualifier (interchange level)

IDCODE

Text

35

ID Code (interchange level)

AUTH_QUAL

Text

2

Authentication Qualifier (interchange level)

AUTH_CODE

Text

10

Authentication Code (interchange level)

SECU_QUAL

Text

2

Security Qualifier (interchange level)

SECU_CODE

Text

10

Security Code (interchange level)

GSID

Text

35

Group ID – trading partner functional group level

SHIPQUAL

Text

2

Ship To Qualifier

SHIPIDEN

Text

15

Ship To Identifier Code

BILLQUAL

Text

2

Bill To Qualifier

BILLIDEN

Text

15

Bill To Identifier Code

ADDR1

Text

35

Street Address 1

ADDR2

Text

35

Street Address 2 (additional address)

CITY

Text

19

City

STATE

Text

15

State

COUNTRY

Text

25

Country

ZIP

Text

9

Zip code

CONTACT1

Text

35

Name of Trading Partner Contact 1

TELEPHONE1

Text

22

Telephone Number of Contact 1

CONTACT2

Text

35

Name of Trading Partner Contact 2

TELEPHONE2

Text

22

Telephone Number of Contact 2

ISA_IN_NO

Text

9

Interchange-level control number inbound

ISA_OUT_NO

Text

9

Interchange-level control number outbound.

SND_GSID

Text

35

Company ID – group level

SND_IDQUALText

Text

4

TP Qualifier – interchange level.

SND_IDCODE

Text

35

TP Identifier Code – interchange level.

SUB_DELIMT

Text

3

X.12 Sub-element Delimiter override character.

ELE_DELIMT

Text

3

X.12 Element Delimiter override character

SEG_DELIMT

Text

3

X.12 Segment Delimiter override character

RELEASE_CH

Text

3

X.12 Release Character override Text.

X12 REPEAT

Text

3

X.12 Repetition Character override character.

<filler>

Text

1

Not used

EDIF_SUBDL

Text

3

EDIFACT Sub-element delimiter override character

EDIF_ELEDL

Text

3

EDIFACT Element Delimiter override character

EDIF_SEGDL

Text

3

EDIFACT Segment Delimiter override character.

EDIF_RELCH

Text

3

EDIFACT Release Character override characterer.

EDIF_REPEA

Text

3

EDIFACT Repeat Character override character.

HL7_SEGDL

Text

3

HL7 Segment Delimiter override character.

HL7_ELEDL

Text

3

HL7 Element Delimiter override character.

HL7_SUBDL

Text

3

HL7 Sub-element Delimiter override character.

HL7_SUBSUB

Text

3

HL7 Component Delimiter override character.

HL7_RELCH

Text

3

HL7 Release Character override character.

HL7_REPEAT

Text

3

HL7 Repeat Character override character.

EXPORT_FLG

Text

1

Export Flag for records to be moved.

MBOX_NAME

Text

35

Internal mailbox Name.

MAILBOX

Text

100

Full path location (directory) of Mailbox.

CURR_FMT

Text

1

Decimal Character: Decimal (D) or Comma (C)

POS_LTR

1

Reserved for future use.

TPKEY

Numeric

10

Unique auto-increment field

Table D-18 shows the fields in the TRADSTAT log file.

Table D-18: Field descriptions for the TRADSTAT file

Field name

Type

Width

Notes

CUSTNO

Text

35

Trading Partner Internal ID

MAP_TRAN

Text

6

Transaction Identifier.

ST03

Text

35

Implementation Convention Reference.

DIR

Text

3

Direction/Purpose of Maps

STAT

Text

1

Status (Test or Production)

VERS

Text

12

Version of EDI Standard

TBCODE

Text

60

Map Name.

MBOX_NAME

Text

35

Trading Partner Internal Mailbox Name.

DEST

Text

100

Override Path to Mailbox

FILE

Text

30

File Name TP Mailbox

GS_NO

Text

9

Group Number

ISA_TYPE

Text

5

EDI Standard.

<filler>

Text

1

Not Used

RCV_GSID

Text

35

Receiver Trading Partner Group ID Code

RCV_IDQUAL

Text

4

Receiver TP ID Qualifier (Interchange Level)

RCV_IDCODE

Text

35

Receiver TP ID Code (Interchange Level)

ACK_RQSTD

Text

1

Acknowledgement Expected (Interchange Lvl.)

ACK_RQSTD2

Text

1

Acknowledgement Expected (Group Level)

EDI_OUT

Text

1

Inbound EDI Output to Mailbox

DAYS

Text

2

Number of Days to Receive Acknowledgement

HOURS

Text

2

Number of Hours to Receive Acknowlegement

MINUTES

Text

2

Number of Minutes to Receive Acknowlegement

SECONDS

Text

2

Number of Seconds to Receive Acknowlegement

APPL_REF

Text

14

Name of Application References

ACK_MSG

Text

1

EDIFACT acknowledge at message level

ACK_INTCH

Text

1

EDIFACT acknowledge at interchange level

TRADEKEY

Integer

10

Auto-increment field

Table D-19 shows the fields in the TRLOG DATABASE log file.

Table D-19: Field descriptions for the TRLOG DATABASE fil

Field name

Type

Width

Notes

AFLD

Auto Number

Long Integer

Auto increment field

RUN_ID

Number

Single

Runtime ID.

TYP

Text

1

Type Flag.

RUN_DATE

Date/Time

--

Runtime Date

ACKBY_DATE

Date/Time

--

Acknowledgement by Date

TRANS_CODE

Text

2

Transaction Code

TRANS_NAME

Text

6

Transaction Name

TPTNER_ID

Text

35

Trade Partner ID

VERSION

Text

12

Version Number

ISA_TYPE

Text

5

ISA Type

INTERCHANG

Text

35

Interchange Code

GROUP_NO

Text

35

Group Number.

TRANS_NO

Text

35

Transaction Number

APP_RCV_CD

Text

35

Application Receiver Code

APP_SND_CD

Text

35

Application Sender Code

RECV_CODE

Text

35

Receiver Code

SEND_CODE

Text

35

Sender Code

RECV_QUAL

Text

35

Receiver Qualifier

SEND_QUAL

Text

4

Sender Qualifier

ERRORS

Number

Single

Total Errors

STAT

Text

1

Status Code

BYTE_COUNT

Number

Single

Difference in Number of Bytes between ST and SE

DIR

Text

3

Direction of Transaction

FLOW_LEVEL

Text

5

Level of Segment in Flow

RECORD_NAM

Text

10

Record Name

RECORD_NO

Text

6

Field Name

FIELD_NAME

Text

15

Field Name

SEGMENT

Text

3

Segment

SEG_COUNT

Number

Long Integer

Segment Count

ELEMENT

Text

2

Element

SUBELEM

Text

2

Sub-element

SEV_CODE

Text

2

Severity Code

MSG_NO

Text

5

Message Number

MSG_TEXT

Text

100

Message Text

FILENAME

Text

160

For ST segments:

  • Outbound – FILENAME contains the current EDI outbound filename (can change based on tradstat and tp mailbox entries)

  • Inbound – the inbound EDI filename (always the same)

For SE segments and inboundtransactions:

  • FILENAME contains the current file name of any EDI OUT filenames (can change based on tradstat, tp mailboxes and tradstat EDI OUT field)

  • File name consists of both complete path and file name

FIELDVAL

Text

30

Field value

USER_IDENT

Text

35

User ID

ACK_EXPECT

Text

1

Acknowledgement Expected

TR_ACK_TYP

Text

1

Transaction Acknowledgement Type (1 indicates user wants an acknowledgement)

T_P_IND

Text

1

TEST_PRODUCTION Indicator (P or blank for production, T for test)

TRANS_CNT

Number

Long Integer

Transaction Count

FILEOFFSET

Number

Single

Number of Bytes File Offset

RCOUNT

Number

Integer

Field for Record Manipulation

Table D-20 shows the fields in the WIXSET log file.

Table D-20: Field descriptions in the WIXSET file

Field name

Type

Precision

Notes

RECORD_NO

Number

4

Record Number

GSID

Text

35

Group ID

NAME

Text

35

Name

IDQUAL

Text

4

ID Qualifier

IDCODE

Text

35

ID Code

AUTH_QUAL

Text

2

Authentication Qualifier

AUTH_CODE

Text

10

Authentication Code

SECU_QUAL

Text

2

Security Qualifier.

SECU_CODE

Text

10

Security Code