Alphabetical listing of ECMap system variables

Table 19-1: ECMap System Variables

Name

Size

Type

Description

ABORT_GROUP

1

AN

Flag that specifies that an entire functional group should be aborted, on an outbound map

ABORT_INTERCHANGE

1

AN

Flag that specifies that an entire interchange should be aborted, on an outbound map

ACK_INTCH

1

AN

Flag that specifies whether an EDIFACT interchange-level acknowledgement is expected from the receiver of an outbound map:

  • 1 = Acknowledgement expected

  •    = Acknowledgement not expected

When ACK_INTCH is 1, the program populates the field in the outgoing EDIFACT UNB envelope that requests the receiver to return an interchange-level acknowledgement.

Loaded from on outbound: tradstat/ACK_RQSTD

Loaded to on outbound: EDIFACT: UNB S005 0031

ACK_MSG

1

AN

Flag that specifies whether an EDIFACT message-level acknowledgement is expected from the receiver of an outbound map:

  • 1 = Acknowledgement expected

  •    = Acknowledgement not expected

ACK_REQSTD

1

AN

Flag that specifies whether an X12 TA1 interchange-level acknowledgement is expected from the receiver of an outbound map:

  • 1 = TA1 acknowledgement expected

  •    = TA1 acknowledgement not expected

When ACK_REQSTD is 1, the program populates the field in the outgoing X12 ISA envelope that requests the receiver to return an interchange-level acknowledgement.

Loaded from on outbound: tradstat/ACK_RQSTD

Loaded to on outbound: X12: ISA 14

APP_PASSWORD

14

AN

Password on the group-level envelope

Loaded to on outbound/loaded from on inbound: EDIFACT: UNB S005 0022

APP_RECV_CODE

35

AN

Receiver ID code on the group-level envelopeLoaded from on outbound: tp/GSID (if blank, use tradstat/RCV_GSID)

Loaded to on outbound/loaded from on inbound: X12: GS 03EDIFACT: UNB S003 0046. UNG S007 0044HL7: MSH 0006. FHS 0072. BHS 0086

APP_RECV_QUAL

4

AN

Receiver ID code qualifier on the group-level envelope

Loaded to on outbound/loaded from on inbound: EDIFACT: UNG S007 0007

APP_SEND_CODE

35

AN

Sender ID code on the group-level envelope

Loaded from on outbound: tp/SND_GSID

(if blank, use wixset/WIX_GSID)

Loaded to on outbound/loaded from on inbound: X12: GS 02

EDIFACT: UNB S002 0042. UNG S006 0040

HL7: MSH 0004. FHS 0070. BHS 0084

APP_SEND_QUAL

4

AN

Sender ID code qualifier on the group-level envelope

Loaded to on outbound/loaded from on inbound: EDIFACT: UNG S006 0007

ASSOC_CODE

6

AN

Associate assigned code.

AUTH_CODE

15

AN

Trading partner authorization ID code

Loaded from on outbound: tp/AUTH_CODE

Loaded to on outbound/loaded from on inbound: X12: ISA 02

AUTH_QUAL

2

AN

Trading partner authorization ID code qualifier

Loaded from on outbound: tp/AUTH_QUAL

(if blank, use “00” for X12 and null for EDIFACT)

Loaded to on outbound/loaded from on inbound: X12: ISA 01

B_RECV_ID

24

AN

Batch receiver ID

B_SEND_ID

24

AN

Batch sender ID

B_VERS

2

AN

Batch version

BIN_NUMB

6

AN

Bin number

CHANGE_LEVEL

4

UI

Change outbound flow level

Assigned by user on outbound

When the user assigns a new value to CHANGE_ LEVEL in a rule command, the program first processes the rule, then goes to the new level specified in CHANGE_LEVEL, and finally resets the value of CHANGE_LEVEL to spaces. [CHANGE_LEVEL and COMBINED_BREAK are used in rule commands to control map flow processing on outbound maps.]

CLIST_VER

6

AN

Code List Directory Version Number

EDIFACT: UNH S009 0110

CNT_AG1

3

AN

Controlling Agency, Coded

EDIFACT: UNH S009 0051

CNT_AG2

3

AN

Controlling Agency, Coded

EDIFACT: UNH S016 0051

CNT_AG3

3

AN

Controlling Agency, Coded

EDIFACT: UNH S017 0051

CNT_AG4

3

AN

Controlling Agency, Coded

EDIFACT: UNH S018 0051

COMBINED_BREAK

1

UI

End-of-file (EOF) indicator

Used in the master level I/O rule to do EOF processing if COMBINED_BREAK = 1 and (with CHANGE_LEVEL) to help control map flow processing when a parent level has multiple child levels that repeat in an undetermined order.

Generated by the program on outbound: After a successful read, COMBINED_BREAK is set to blank. After an unsuccessful read (record type changes when reading a file with multiple record types), COMBINED_BREAK is set to 1.

User-assigned value on inbound: When this variable is set to 1 and EOF is reached for an inbound EDI file, the user can create a rule and attach it to the end-of-outer-envelope flow level to clean up processing.

COMM_AC_REF

35

AN

Common access reference

User-assigned value for outbound use

Loaded to on outbound/loaded from on inbound: EDIFACT: UNB S005 0026

COMM_AGM_ID

35

AN

Communication agreement ID

User-assigned value for outbound use

Loaded to on outbound/loaded from on inbound: EDIFACT: UNB S005 0032

CONTACT1

35

AN

Name of trading partner contact #1

Loaded from on inbound: tp/CONTACT1

CONTACT2

35

AN

Name of trading partner contact #2

Loaded from on inbound: tp/CONTACT2

DATA_ELEM_SEP

1

AN

X12 element delimiter

Loaded from on outbound: tp/ELE_DELIMT

(if blank, the program uses the default)

Loaded from on inbound: ISA Column 4

EDFT_A_COMP_SEP

1

AN

EDIFACT composite element delimiter – syntax A (The syntax identifier is in UNB S001 0002.)

Loaded from on outbound/loaded to on inbound: tp/EDIF_SUBDL (if blank, the program uses the default)

Loaded to on outbound/loaded from on inbound: UNA Column 4

(Changing this value does affect the envelope because the same information is loaded into an internal program variable and that variable is used to populate the envelopes.)

EDFT_A_DEC_IND

1

AN

EDIFACT decimal indicator – syntax A

(The syntax identifier is in UNB S001 0002.)

Loaded from on outbound/loaded to on inbound: “.” [decimal point]

Loaded to on outbound/loaded from on inbound: UNA Column 6

(Changing this value does not affect on the envelope because the same information is loaded into an internal program variable and that variable is used to populate the envelopes.)

EDFT_A_ELEM_SEP

1

AN

EDIFACT element delimiter – syntax A

(The syntax identifier is in UNB S001 0002.)

Loaded from on outbound/loaded to on inbound: tp/EDIF_ELEDL (if blank, the program uses the default)

Loaded to on outbound/loaded from on inbound: UNA Column 5

(Changing this value does not affect on the envelope because the same information is loaded into an internal program variable and that variable is used to populate the envelopes.)

EDFT_A_REL_IND

1

AN

EDIFACT release character – syntax A

(The syntax identifier is in UNB S001 0002.)

Loaded from on outbound/loaded to on inbound: tp/EDIF_RELCHL (if blank, the program uses the default)

Loaded to on outbound/loaded from on inbound: UNA Column 7

(Changing this value does not affect on the envelope because the same information is loaded into an internal program variable and that variable is used to populate the envelopes.)

EDFT_A_SEG_TERM

1

AN

EDIFACT segment delimiter – syntax A

(The syntax identifier is in UNB S001 0002.)

Loaded from on outbound/loaded to on inbound: tp/EDIF_SEGDL (if blank, the program uses the default)

Loaded to on outbound/loaded from on inbound: UNA Column 8

(Changing this value does not affect on the envelope because the same information is loaded into an internal program variable and that variable is used to populate the envelopes.)

EDFT_B_COMP_SEP

1

AN

EDIFACT composite element delimiter – syntax B (The syntax identifier is in UNB S001 0002.)

Loaded from on outbound/loaded to on inbound: tp/EDIF_SUBDL (if blank, the program uses the default)

Loaded to on outbound/loaded from on inbound: UNA Column 4

(Changing this value does not affect on the envelope because the same information is loaded into an internal program variable and that variable is used to populate the envelopes.)

EDFT_B_DEC_IND

1

AN

EDIFACT decimal indicator – syntax B

(The syntax identifier is in UNB S001 0002.)

Loaded from on outbound/loaded to on inbound: “.” [decimal point]

Loaded to on outbound/loaded from on inbound: UNA Column 6

(Changing this value does not affect on the envelope because the same information is loaded into an internal program variable and that variable is used to populate the envelopes.)

EDFT_B_ELEM_SEP

1

AN

EDIFACT element delimiter – syntax B

(The syntax identifier is in UNB S001 0002.)

Loaded from on outbound/loaded to on inbound: tp/EDIF_ELEDL (if blank, the program uses the default)

Loaded to on outbound/loaded from on inbound: UNA Column 5

(Changing this value does not affect on the envelope because the same information is loaded into an internal program variable and that variable is used to populate the envelopes.)

EDFT_B_REL_IND

1

AN

EDIFACT release character – syntax B

(The syntax identifier is in UNB S001 0002.)

Loaded from on outbound/loaded to on inbound: tp/EDIF_RELCHL (if blank, the program uses the default)

Loaded to on outbound/loaded from on inbound: UNA Column 7

(Changing this value does not affect on the envelope because the same information is loaded into an internal program variable and that variable is used to populate the envelopes.)

EDFT_B_SEG_TERM

1

AN

EDIFACT segment delimiter – syntax B

(The syntax identifier is in UNB S001 0002.)

Loaded from on outbound/loaded to on inbound: tp/EDIF_SEGDL (if blank, the program uses the default)

Loaded to on outbound/loaded from on inbound: UNA Column 8

(Changing this value does not affect on the envelope because the same information is loaded into an internal program variable and that variable is used to populate the envelopes.)

EDI_OUT_FILENAME

80

AN

Read only. EDI output file name

On inbound: The file to which EDI data that is passed through will be written and which is generated by the program using the Run ID number.

On outbound: The file to which the mapped EDI data will be written. (This is parameter 1 on the command line or the entry in the Output EDI File text box on the Required tab of the Run Outbound Map window.)

EDI_START_FILENAME

160

AN

Input/output EDI file name

On inbound: The file from which the EDI input data will be read. (This is the name of the EDI input file specified in the Input EDI File text box on the Required tab of the Run Inbound Map window or parameter 1on the command line.)

On outbound: The file to which the mapped EDI data will be written. (This is the name of the EDI input file specified in the Output EDI File text box on the Required tab of the Run Any-to-Any Map window or parameter 1on the command line.)

ERR_OCCURRED

1

AN

Flag to indicate if transaction errors occurred:

  • Y = errors occurred

  • N = no errors occurred

Generated by the program

Users can perform an action based on the value

FIRST_LAST_TRAN

1

AN

First and last transfers

Loaded to on outbound/loaded from on inbound: EDIFACT: S010 0073

FORM_FEED

1

AN

Form feed character - <CTRL> l

Loaded by the program

This unprintable character is available for users when they create reports - such as writing out the records in a file or the fields in a record. They can assign this system variable to an appropriate field in a record and it will cause a form feed action.

FUNC_GP_DATE

8

Date

Date on group-level envelopes

Loaded with on outbound: Computer Date

Loaded to on outbound/loaded from on inbound: X12: GS 04

EDIFACT: UNG S004 0017

FUNC_GP_NUM

35

AN

Control/reference number on group-level envelopes

Loaded from on outbound: Tradstat/GS_NO

Loaded to on outbound/loaded from on inbound: X12: GS 06

EDIFACT: UNG S004 0048

FUNC_GP_TIME

6

Time

Time on group-level envelopes

Loaded with on outbound: Computer time

Loaded to on outbound/loaded from on inbound: X12: GS 05

EDIFACT: UNG S004 0019

FUNC_ID

6

AN

Functional identifier code

Loaded to on outbound/loaded from on inbound: X12: GS 01

FUNC_ST_CHG

35

AN

Indicator that the transaction has changed

Generated by the program to:

Trigger a trading partner lookup and potentially create a new ISA or GS envelope (used with FUNC_ST_REF)

FUNC_ST_REF

35

AN

Value of ST 03

Supplied by the user on outbound as the <value> in the -s3 switch

Loaded to on outbound/loaded from on inbound: X12: ST 03

INB_CURR_SEG

3

AN

Inbound current segment

Captured by the program each time it does an inbound read

Users can use the value of this system variable when they are performing additional compliance checks.

INB_PRIOR_SEG

3

AN

Inbound prior segment

Captured by the program each time it does an inbound read

Users can use the value of this system variable when they are performing additional compliance checks.

INT_FORMAT

4

AN

INT_HEAD_DATE

8

Date

Date on interchange-level envelopes

Loaded with on outbound: Computer Date

Loaded to on outbound/loaded from on inbound: X12: ISA 09

EDIFACT: UNB S004 0017

INT_HEAD_NUM

35

AN

Control/reference number on interchange-level envelopes

Loaded from on outbound: Tradstat/GS_NO

Loaded to on outbound/loaded from on inbound: X12: ISA 13

EDIFACT: UNB S004 0048

INT_HEAD_TIME

6

Time

Time on interchange-level envelopes

Loaded with on outbound: Computer time

Loaded to on outbound/loaded from on inbound: X12: ISA 10

EDIFACT: UNB S004 0019

INT_VERSION

5

AN

EDI version number

Loaded from on inbound: X12: ISA 12

EDIFACT: UNB S001 0001 and 0002

Loaded to on inbound: tradstat/VERS (first 5 characters)

ISA_TYPE

5

AN

EDI Standard used in the map

  • <blank> = X12 standard

  • 70 = EDIFACT standard

Loaded from on outbound and inbound: tradstat/ISA_TYPE

LOG_BYTES

5

UI

Size of the message/transaction

Loaded from log file on inbound and outbound

Available for interrogation by users

LOG_ELEMENT

2

UI

EDI element name

Loaded from log file on inbound and outbound

Available for interrogation by users

LOG_ERRS

5

UI

Number of errors in the message/transaction

Loaded from log file on inbound and outbound

Available for interrogation by users

LOG_FIELDNAME

15

AN

Field name

Loaded from log file on inbound and outbound

Available for interrogation by users

LOG_LEVEL

5

UI

Flow level number

Loaded from log file on inbound and outbound

Available for interrogation by users

LOG_MSG_NO

5

UI

Error message number

Loaded from log file on inbound and outbound

Available for interrogation by users

LOG_MSG_TXT

45

AN

Text of the error message

Loaded from log file on inbound and outbound

Available for interrogation by users

LOG_READ_CNT

9

UI

Number of records read

Loaded from log file on inbound and outbound

Available for interrogation by users

Inbound: Number of EDI file records read

Outbound: Number of records read for record type

LOG_RECNAME

10

AN

Record field name

Loaded from log file on inbound and outbound

Available for interrogation by users

LOG_RPT_NO

2

UI

Log repeat number

LOG_SEGMENT

3

AN

EDI segment name

Loaded from log file on inbound and outbound

Available for interrogation by users

LOG_STATUS

1

AN

Log status code

Loaded from log file on inbound and outbound

Available for interrogation by users

LOG_SUBELEMENT

2

UI

EDI sub-element number

Loaded from log file on inbound and outbound

Available for interrogation by users

LOG_VALUE

30

AN

Value of record/field or EDI element when an error occurred

Loaded from log file on inbound and outbound

Available for interrogation by users

MSG_IMPID

14

AN

Message Implementation Guide Identification

EDIFACT: UNH S017 0121

MSG_IMPREL

3

AN

Message Implementation Guide Release Number

EDIFACT: UNH S017 0124

MSG_IMPVER

3

AN

Message Implementation Guide Version Number

EDIFACT: UNH S017 0122

MSG_SUBID

14

AN

Message Subset Identification

EDIFACT: UNH S016 0115

MSG_SUBREL

3

AN

Message Subset Release Number

EDIFACT: UNH S016 0118

MSG_SUBVER

3

AN

Message Subset Version Number

EDIFACT: UNH S016 0116

MSG_TYPE

6

AN

Message Type Sub-Function

EDIFACT: UNH S009 0113

NCPDP_BATCH_MSG

35

AN

Batch trailer message.

NEW_COMPANY_ID

35

AN

Set to create a new ISA

NEXT_XML_TAG

40

AN

Value of the XML start tag following the last successfully read xml start tag

Captured by the program

Since users must build all XML read statements manually, this value allows users to know how to process the current start tag. (i.e., it allows users to know whether the following tag continues down the XPath, stays at the same place on the xpath, or goes back up the xpath.)

OUTPUT_FILENAME

60

AN

File name opened for Write

Captured by the program

Inbound: Map or Runtime override

PROC_NUMB

10

AN

Processing control number

PROC_PRIO_CODE

1

AN

Processing Priority Code

Loaded to on outbound/loaded from on inbound: EDIFACT: UNB S005 0029

PROPRIETARY_LENGTH

3

AN

Length of proprietary header

PROPRIETARY_TEXT

250

AN

Proprietary header information

RECV_CODE

35

AN

Interchange/Outer Envelope Receiver ID code

Loaded from on outbound: tp/IDCODE (if blank, use tradstat/RCV_IDCODE)

Loaded to on outbound/loaded from on inbound: X12: ISA 08

EDIFACT: UNB S003 0010

RECV_QUAL

4

AN

Interchange/Outer Envelope Receiver ID code qualifier

Loaded from on outbound: tp/IDQUAL (if blank, use tradstat/RCV_IDQUAL)

(if blank, use “00” for X12 and null for EDIFACT)

Loaded to on outbound/loaded from on inbound: X12: ISA 07 (max length 4)

EDIFACT: UNB S003 0007

RECV_ROUTE

14

AN

Interchange/Outer Envelope Receiver Routing Code

Loaded to on outbound/loaded from on inbound: EDIFACT: UNB S003 0014

RECVR_SUBID

35

AN

Interchange Receiver Internal Sub-Identification

EDIFACT: UNB S003 0046

RESP_AGENCY_CODE

1

AN

Responsible agency code

User-assigned value for outbound use (if blank, the system will load “X”)

Loaded to on outbound/loaded from on inbound: X12: GS 07

SCEN_ID

14

AN

Scenario Identification

EDIFACT: UNH S018 0127

SCEN_REL

3

AN

Scenario Release Number

EDIFACT: UNH S018 0130

SCEN_VER

3

AN

Scenario Version Number

EDIFACT: UNH S018 0128

SECU_CODE

14

AN

Trading partner security ID code

Loaded from on outbound: tp/SECU_CODE

Loaded to on outbound/loaded from on inbound: X12: ISA 04

EDIFACT: UNB S005 0022

SECU_QUAL

2

AN

Trading partner security ID code qualifier

Loaded from on outbound: tp/SECU_QUAL (if blank, use “00” for X12 and null for EDIFACT)

Loaded to on outbound/loaded from on inbound: X12: ISA 03

EDIFACT: UNB S005 0025

SEG_TERM

1

AN

X12 segment delimiter

Loaded from on outbound: tp/SEG_DELMT (if blank, use X12 default segment terminator)

Loaded to on outbound/loaded from on inbound: X12: ISA 16

SEGMENT_COUNT

9

UI

Number of segments in a transaction

Loaded from on outbound: tradstat/GS_NO

Loaded to on outbound/loaded from on inbound: X12: GS 06

EDIFACT:

SEND_CODE

35

AN

Sender ID code on interchange-level envelopes

Loaded from on outbound: tp/SND_IDCODE (if blank, use wixset/WIX_IDCODE)

Loaded to on outbound/loaded from on inbound: X12: ISA 06

EDIFACT: UNB S002 0004

SEND_QUAL

4

AN

Sender ID code qualifier on interchange-level envelopes

Loaded from on outbound: tp/SND_IDQUAL (if blank, use wixset/WIX_IDQUAL)

Loaded to on outbound/loaded from on inbound: X12: ISA 05

EDIFACT: UNB S002 0007

SEND_REV_ROUTE

14

AN

Sender reverse routing code

Loaded to on outbound/loaded from on inbound: EDIFACT: UNB S002 0008

SEQ_TRAN

1

AN

Sequence of transfers

Loaded to on outbound/loaded from on inbound: EDIFACT: UNH S010 0070

SERV_CODE

6

AN

Service Code List Directory Version Number

EDIFACT: UNB S001 0080

SERV_ID

15

AN

Service provider ID

SERV_QUAL

2

AN

Service provider ID qualifier

SKIP_SEGMENT_WRITE

1

AN

Flag that specifies to not write this EDI segment

Generated by the program on outbound and inbound: In outbound maps, sets the SKIP_SEGMENT_WRITE SYSVAR in a Before or After segment element EDIT rule to a “Y”, then when the level which contains this segment is generated, the rule will turn it to a “Y” and this segment won't be written. Note SKIP_SEGMENT_WRITE is reset to “ “after each segment is written. So if there are 10 segments at a level, you can have rules in each segment to determine whether to write to it or not.

You could also set it in a Before Rule in the flow. But then it would just affect the first segment at that level.

In inbound maps, SKIP_SEGMENT_WRITE can be used in Segment element EDIT rules, or in the Before Flow rule to affect whether the segment will be placed in the EDI OUT File.

SNDR_SUBID

35

AN

Interchange Sender Internal Sub-Identification

EDIFACT: UNB S002 0042

SOFT_ID

10

AN

Software/vendor ID

SQL_RETURN

2

UI

SQL return code

Returns the status of SQL commands

Generated by the program and used to determine if the last FETCH command returned a result set. For example, you can use the SQL_RETURN system variable in an IF/THEN/ELSE command to determine if a result set has been returned.

SUB_SEPERATOR

1

AN

Sub-element delimiter for X12 and HL7 data

Loaded to on outbound/loaded from on inbound: X12: ISA Column 105

Loaded from outbound: tp/ELE_DELIMT (if blank, use standard default)

SYS_ADDR1

35

AN

First line of trading partner street address

Loaded to on inbound: tp/ADDR1

SYS_ADDR2

35

AN

Second line of trading partner street

Loaded to on inbound: tp/ADDR2

SYS_BILLIDEN

15

AN

Trading partner Bill To ID code

Loaded to on inbound: tp/BILLIDEN

SYS_BILLQUAL

2

AN

Trading partner Bill To ID code qualifier

Loaded to on inbound: tp/BILLQUAL

SYS_CHG_TRANS

6

AN

Indicator that transaction has changed

Generated by the program

On Outbound, this triggers a trading partner lookup. (i.e., it is used by the program in conjunction with SYS_TRANSt to change maps for different transactions when multiple transactions are in one file.) Each time the program writes a message/transaction, if SYS_CHG_TRANS is different from SYS_TRANS, the program, writes a new:

  • Outer envelope if the trading partner changed

  • Inner envelope if the trading partner did not change.

SYS_CITY

30

AN

City where the trading partner is located

Loaded to on inbound: tp/CITY

SYS_COUNTRY

25

AN

Country where the trading partner is located

Loaded to on inbound: tp/COUNTRY

SYS_DATE

8

Date

Runtime system date

Loaded with on inbound and outbound: Computer date

SYS_GENGS

1

AN

Flag to generate multiple group envelopes

Generated by the program on Outbound to: Generate multiple group envelopes

SYS_HHMMSS

6

Time

System time in format HHMMSS

Loaded with on inbound and outbound: Computer time

SYS_IDCODE

35

AN

Trading partner ID code

Not currently used

SYS_IDQUAL

2

AN

Trading partner ID code qualifier

Not currently used

SYS_MAP_EXT

8

AN

Map name extension.

User-defined at trade agreement creation to distinguish multiple map definitions for the same transaction, direction, and trade partner.

SYS_MAP_EXT_CHG

8

AN

Used to change the map name extension of the current map. (Outbound only).

SYS_NAME

35

AN

Internal name for the trading partner

Loaded to on inbound: tp/NAME

SYS_RUN_ID

9

UI

Log run ID number

For inbound and outbound, this value can be:

  • passed in as a parameter on the -id switch

  • loaded from trlog/runid if using an ODBC log

  • loaded with 0000 if using a non-ODBC log

This number is used to create output file names for routed data.

SYS_SHIPIDEN

15

AN

Trading partner Ship To identification code

Loaded to on inbound: tp/SHIPIDEN

SYS_SHIPQUAL

2

AN

Trading partner Ship To identification code qualifier

Loaded to on inbound: tp/SHIPQUAL

SYS_STATE

2

AN

State where the trading partner is located

Loaded to on inbound: tp/STATE

SYS_TIME

4

Time

System Time in format HHMM

Loaded with: Computer time

SYS_TRADNO

35

AN

Internal ID number for trading partner generated by the trading partner lookup

Loaded from on inbound and outbound: tp/CUSTNO

Trading partner lookup on inbound: Using the trading partner search option criteria specified by the user, the program compares selected fields in the EDI envelope(s) with the appropriate fields in the trading partner database, to find the CUSTNO.

Trading partner lookup on outbound: The program matches the trading partner ID field in the user file with the group receiver code in the trading partner database, to find the CUSTNO.

(Both lookups are affected by the presence or absence of override values and switches.)

SYS_TRANS

6

AN

Message/transaction set

Passed in on outbound as required parameter 4: -t <message/ transaction set>

Loaded to on outbound/loaded from on inbound: X12: ST 01

EDIFACT: UNH S009 0065

Loaded to on inbound and outbound: tradstat/MAP_TRAN

(If this value is changed, it will not affect the envelope or the actual transaction name used.)

SYS_TRCODE

2

AN

Transaction code

Passed in on outbound as required parameter 3: <2-character transaction code>

SYS_USER_FIELD

35

AN

USER DEFINED FIELD

SYS_ZIP

9

AN

Zip code of trading partner location

Loaded to on inbound: tp/ZIP

TELEPHONE1

22

AN

Trading partner telephone number #1

Loaded to on inbound: tp/TELEPHONE1

TELEPHONE2

22

AN

Trading partner telephone number #2

Loaded to on inbound: tp/TELEPHONE2

TEST_IND

1

AN

Transaction mode (T, P, or I)

Loaded from on outbound: tradstat/STAT

Loaded to on outbound/loaded from on inbound: X12: ISA 15

EDIFACT: UN B S005 0035

TOT_ERRS

9

UI

Total number of errors during a map run

Loaded from log file on inbound and outbound

Available for interrogation by users

TRANS_ACK_REQ

1

AN

Specifies that a Functional Acknowledgement is expected from the receiver of an outbound map or has been requested by the sender of an inbound map: 1 = Expected/requested 0 = Not expected/requested

Loaded from on inbound and outbound: tradstat/ARK_RQSTD2

On outbound maps: When the value of TRANS_ACK_REQ is 1, the program saves additional information to the log. This information will be used to match the Functional Acknowledgment that is sent back with the data that requested it and confirm that it was received within the time period specified.

On inbound maps: When the value of TRANS_ACK_REQ is 1, the program “turns on” trlog/TR_ACK_TYPE and saves additional information to the log. This information will be used as input to the map that creates the Functional Acknowledgment.

On outbound Functional Acknowledgments: When an EDI transaction is received which the trading partners have agreed should generate a Functional Acknowledgement, the receiver must run one of the acknowledgement maps provided with the software. As input to the map, the program uses all of the data in trlog with TR_ACK_TYPE “turned on”. After creating the acknowledgements, the program “turns off” TR_ACK_TYPE in order to prevent sending duplicate acknowledgments.

On inbound Functional Acknowledgements: When an Interchange Acknowledgment is received, the program compares it with the information entered in the log to match the acknowledgement with the correct requesting data it and to confirm that it was received within the time period specified. The program must “turn off” trlog/ACK_EXPECT after acknowledgements have been received to indicate that the request for an acknowledgment has been fulfilled.

TRANS_CTRL_NUM

35

AN

Transaction control number

Loaded from on outbound:

(tradstat/GS_NO X 1000) + # of transactions

Loaded to on outbound/loaded from on inbound: X12 ST/SE 02

EDIFACT: UNH/UNT 0062

TRANSMISSION_TYPE

2

AN

Batch header transmission type

USER_BHS0201_SCODE

15

AN

Batch sending application

USER_BHS0301_R_ROUTE

15

AN

Batch sending facility

USER_BHS0401_RCODE

15

AN

Batch receiving application

USER_BHS0501_RCVCODE

15

AN

Batch receiving facility

USER_BHS0601_DATE

8

AN

Batch creation date

USER_BHS0602_TIME

4

AN

Batch creation time

USER_BHS0701_PASSWORD

12

AN

Batch security

USER_BHS1001_GS_CCTRL

14

AN

Batch control ID

USER_FHS0201_SCODE

15

AN

File sending application

USER_FHS0301_R_ROUTE

15

AN

File sending facility

USER_FHS0401_RCODE

15

AN

File receiving application

USER_FHS0501_RCVCODE

15

AN

File receiving facility

USER_FHS0601_DATE

8

AN

File creation date

USER_FHS0602_TIME

4

AN

File creation time

USER_FHS0701_PASSWORD

12

AN

File security

USER_FHS0801_FNAME

20

AN

File name/ID

USER_FHS1001_GISABUF

35

AN

File control ID

USER_GS01_SYS_TRCODE

2

AN

Functional identifier code

USER_GS02_SCODE

15

AN

Application sender’s code

USER_GS03_RCODE

15

AN

Application receiver’s code

USER_GS04_SYS_DATE

8

AN

Date

USER_GS05_SYS_TIME

8

AN

Time

USER_GS06_FUNC_GP_NUM

9

AN

Group control number

USER_GS07_CH_AGENCY

2

AN

Responsible agency code

USER_GS08_XVER

12

AN

Version/release/industry identifier code

USER_ISA01_AUTH_QUAL

2

AN

Authorization information qualifier

USER_ISA02_AUTH_CODE

15

AN

Authorization information

USER_ISA03_SECU_QUAL

2

AN

Security information qualifier

USER_ISA04_SECU_CODE

14

AN

Security information

USER_ISA05_SEND_QUAL

4

AN

Interchange ID qualifier

USER_ISA06_SEND_CODE

35

AN

Interchange sender ID

USER_ISA07_RECV_QUAL

4

AN

Interchange ID qualifier

USER_ISA08_RECV_CODE

35

AN

Interchange receiver ID

USER_ISA09_DATE

6

AN

Interchange date

USER_ISA10_TIME

4

AN

Interchange time

USER_ISA11_PTSTD

1

AN

Interchange control standards identifier

USER_ISA12_ISA_TYPE

5

AN

Interchange control version number

USER_ISA13_GISABUF

9

AN

Interchange control number

USER_ISA14_ACK_REQSTD

1

AN

Acknowledgement requested

USER_ISA15_TEST_IND

1

AN

Usage indicator

USER_ISA16_SUB_SEP

1

AN

Component element separator

USER_OUT_FILENAME

160

AN

User-generated override for the EDI output file name

On inbound: The file to which EDI data that is passed through will be written and which is generated by the program using the Run ID number.

On outbound: The file to which the mapped EDI data will be written.

USER_UNB0101_VERS

4

AN

Syntax identifier

USER_UNB0102_VERS

1

AN

Syntax version number

USER_UNB0103_SERV_CODE*

6

AN

Syntax version

USER_UNB0201_SCODE

35

AN

Sender identification

USER_UNB0202_PSQUAL

4

AN

Partner identification code qualifier

USER_UNB0203_SNDR_ROUTE

35

AN

Sender routing address

USER_UNB0204_SNDR_SUBID*

35

AN

Sender subID

USER_UNB0301_RCODE

35

AN

Recipient identification

USER_UNB0302_PRECV

4

AN

Partner identification code qualifier

USER_UNB0303_RCVR_ROUTE

35

AN

Recipient routing address

USER_UNB0304_RCVR_SUBID*

35

AN

Recipient subID

USER_UNB0401_DATE*

8

AN

Date of preparation

USER_UNB0402_TIME

4

AN

Time of preparation

USER_UNB0501_GISABUF

35

AN

Interchange control reference

USER_UNB0601_PASSWORD

14

AN

Recipient reference/password

USER_UNB0602_PSECU

2

AN

Recipient reference/password

USER_UNB0701_COMREF

14

AN

Application reference

USER_UNB0801_PCODE

1

AN

Processing priority code

USER_UNB0901_ACK_MSG

1

AN

Acknowledgement request

USER_UNB1001_COMAG

35

AN

Communications agreement ID

USER_UNB1101_PTIND

1

AN

Test indicator

USER_UNG0101_F_IDCODE

6

AN

Functional group identification

USER_UNG0201_SCODE

35

AN

Application sender identification

USER_UNG0202_APSQUAL

4

AN

Partner identification code qualifier

USER_UNG0301_RCODE

35

AN

Application recipient’s identification

USER_UNG0302_APRQUAL

4

AN

Partner identification code

USER_UNG0401_DATE*

8

AN

Date of preparation

USER_UNG0402_TIME

4

AN

Time of preparation

USER_UNG0501_GUNGBUF

14

AN

Functional group reference number

USER_UNG0601_CNT_AG1

3

AN

Controlling agency

USER_UNG0701_XVER

3

AN

Message type version number

USER_UNG0702_XVER2

3

AN

Message type release number

USER_UNG0703_ASSOC_CODE

6

AN

Association assigned code

USER_UNG0801_AP_PASE

14

AN

Application password

WIX_ADP_AD_PASS

8

AN

Company ADP authorization password

WIX_ADP_ID

8

AN

Company ADP user identification

WIX_ADP_PASS

8

AN

Company ADP password

WIX_APP_SND_QL

4

AN

WIX_AUTH_CODE

10

AN

Company authorization code

WIX_AUTH_QUAL

2

AN

Company authorization code qualifier

WIX_B_SEND_ID

24

AN

Company batch sender ID

WIX_BIN_NUMB

6

AN

Company bin number

WIX_COMPANY_NAME

35

AN

Company name

WIX_GSID

35

AN

Company group/inner envelope sender ID code

WIX_IDCODE

35

AN

Company interchange/outer envelope sender ID code

WIX_IDQUAL

2

AN

Company interchange/outer envelope sender ID code qualifier

WIX_MODEM_BAUD

4

AN

Company modem baud rate

WIX_MODEM_PORT

2

AN

Company modem port

WIX_PHONE_TONE

1

AN

Company modem tone

WIX_PROC_NUMB

10

AN

Company process control number

WIX_PRODUCER_ID

12

AN

Company producer ID code

WIX_SECU_CODE

10

AN

Company security code

WIX_SECU_QUAL

2

AN

Company security code qualifier

WIX_SERV_ID

15

AN

Company service ID

WIX_SERV_QUAL

2

AN

Company service ID qualifier

WIX_SNDR_ROUTE

15

AN

Sender internal ID

WIX_SNDR_SUBID

15

AN

Sender internal subID

WIX_SOFT_ID

10

AN

Company software ID

WIX_TEL_NUMBR

16

AN

Company telephone number

X12_VERSION

12

AN

Version of EDI standard used in the map

Loaded from on outbound: tradstat/VERS

Loaded to on outbound/loaded from on inbound: X12: GS 08

EDIFACT: UNG S008 0052