Generic Event Record: Sample DSECT (Macro $RFGEVNT)

Generic Data Transfer Application Event Support › Generic Event Record: Sample DSECT (Macro $RFGEVNT)

Generic Event Record: Sample DSECT (Macro $RFGEVNT)

Build the Generic Event record before calling NM000FGX. The name (label) of the DSECT is GEVENT.

Three types of event are supported and mapped using the following distributed DSECT:

Transfer Start (optional)
Transfer End
Transfer Failure

Field Name	Field Type	Usage	Hex Offset	Default	Required /Optional	Apply to Event Type
GERCVID	CL8	EPS Event Receiver ID	0000	$RFFTEVR	OPT	All
GEXFRID	CL32	Transfer ID	0008	-	REQ	All
GETYPE	CL1	Event Type S: START E: END F: FAILURE	0028	-	REQ	All
GETRACE	CL1	Trace Option T: TRACE ON N: TRACE OFF	0029	N	OPT	All
-	CL6	Spare	002A	-
GEXBYTES	D	Bytes Transmitted	0030	-	OPT	End
GEXRECS	F	Records Transmitted	0038	-	OPT	End
GEFAILRC	F	Error Code	003C	-	OPT	Failure
GEFAILTX	CL128	Error Text	0040	-	OPT	Failure
GEDXPRD	CL24	File Transfer Product ID	00C0	STC Name	OPT	All
GEUSERID	CL16	User ID	00D8	STC Name	OPT	All
GESRCNOD	CL64	Transfer Source Node Name or Address	00E8	-	OPT	All
GESRCDAT	CL255	Transfer Source Data File	00FC	-	OPT	All
GETRGNOD	CL64	Transfer Target Node Name or Address	01FC	-	OPT	All
GETRGDAT	CL255	Transfer Target Data File	0210	-	OPT	All
GEXSTART	PL8	Transfer Start hhmmssth0cyydddF	0310	For Start Event, set to Event Time For End/Failure event, set to 0	OPT	All
GEXEND	PL8	Transfer End hhmmssth0cyydddF	0318	Event Time	OPT	End Failure
GEUSRDAT	CL32	User Data	0320	-	OPT	All

Notes:

Data Transfer Start Events are optional. The Transfer ID and Event Type fields are mandatory.
If you specify an IP address in the GESRCNOD or GETRGNOD field, it must be character-formatted.

EPS Event Receiver ID (Optional)

Applies to: All events

Default: $RFFTEVR

Validation: None

If specified, ensure consistency between calls to NM000FGX.

Transfer ID

Applies to:

All events

Validation:

If missing, NM000FGX forwards the event with Event Status set to XIDMISSING and returns with R15 set to 4. The transfer ID must be from 1 to 32 characters. The character set is validated and should include the following:

A–Z
a–z
0–9
#
@
$
Period “.”
Underscore “_”
Hyphen “-“
Open parenthesis “(“
Close parenthesis “)”

If the validation fails, NM000FGX forwards the event with Record Status set to XIDINVALID and return with R15 set to 8.

Event Type

Applies to:

All events

Validation:

The values supported are:

S for Transfer Start
E for Transfer End
F for Transfer Failure

If missing or incorrect, NM000FGX forwards the event with $RFPPIMP Record Status set to TYPEINVALID and returns with R15 set to 12.

User data (Optional)

Applies to:	All event
Default:	None
Validation:	None

Trace Option (Optional)

Applies to:

All events

Default:

Validation:

The values supported are:

T to turn on trace option for this event
N to indicate no trace option for this event

If incorrect, N (no trace) is assumed.

When this field is set to T, NM000FGX issues the following message (WTO):

RFGE01  iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii   Type:t     forwarded
to:rrrrrrrr    Status:ssssssssss    RC:nnnn

where:

iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiii is the File Transfer ID (see Transfer ID)
t is the event type (see: Event Type)
rrrrrrrr is the EPS Event Receiver ID
ssssssssss is the event status
nnnn is NM000FGX return code

Bytes Transmitted (Optional)

Applies to:	End event
Default:	None
Validation:	None

Records Transmitted (Optional)

Applies to:	End event
Default:	None
Validation:	None

Error Code (Optional)

Applies to:	Failure event
Default:	None

Specify a meaningful error code.

Error Text (Optional)

Applies to:	Failure event
Default:	None
Validation:	None

File Transfer Product ID (Optional)

Applies to:	All event
Default:	STC Name
Validation:	None

If specified, ensure its consistency between calls to NM000FGX.