WRITE EXSTATS Command

Use the WRITE EXSTATS command to write statistics record from external sources.

WRITE EXSTATS Command Format

WRITE EXSTATS has the following format and parameters. The required parameters and keywords are bold.
Label Command Parameters
(Optional) WRITE EXSTATS

TYPE = ID

MSGID = ID

STARTT = ([date][,hh:mm:ssXM])

STOPT = ([date][,hh:mm:ssXM])

CCODE = completion code

MSG.SHORTTEXT or MSST = text

USER = name

LNODE = name

APPLICATION.NAME or APP.NAME = text

FCODE = feedback code

PNAME = name

PNUMBER or PNUM = number

SUBMITTER = name

DSN = name

MSG.LONGTEXT or MSGT = text

SYMBOLIC.PARAMETERS or SYMBOLS = text

UDF1= text

UDF2= text

UDF3= text

UDF4= text

The following table describes the WRITE EXSTATS command parameters:
Parameter Description

TYPE = ID

Specifies the statistics record types to write. Every statistics record IBM Connect:Direct writes from external source has an associated record-type identifier. Each identifier is two characters long and indicates the event or function that generated the record.

Identifier must be one of following reserved record types for external statistics:
YA, YB, YC, YD, YE, YF, YG, YH, YI,
 YJ, YK, YL, YM, YN, YO, YP, YQ, YR, YS, 
YT, YU, YV, YW, YX, YY, YZ, Y0, Y1, Y2,
 Y3, Y4, Y5, Y6, Y7, Y8, Y9, Y@, Y#, Y$, Y%
Note: This is required parameter.

MSGID = ID

Specifies 8 character message ID.

Note: This is required parameter.

STARTT = ([date][,hh:mm:ssXM])

Specifies starting date and time of operation or function which generated this record. The date or day and time are positional parameters. If you do not specify the date or day, precede the time with a comma.

Date specifies the date of Process execution. You can specify the day (dd), month (mm), and year (yy for 2-digit year and yyyy for 4-digit year). You can use periods or backslashes (/) to separate the components of a date value. You can omit the separators only for transfers between mainframe nodes. Use separators to guarantee transfers between all platforms. You can use the following date formats, according to which date order is specified in the DATEFORM initialization parameter:
  • DATEFORM=MDY specifies the date format as mm/dd/yy, mm/dd/yyyy, mm.dd.yy, or mm.dd.yyyy
  • DATEFORM=DMY specifies the date format as dd/mm/yy, dd/mm/yyyy, dd.mm.yy, or dd.mm.yyyy
  • DATEFORM=YMD specifies the date format as yy/mm/dd, yyyy/mm/dd, yy.mm.dd, or yyyy.mm.dd
  • DATEFORM=YDM specifies the date format as yy/dd/mm, yyyy/dd/mm, yy.dd.mm, or yyyy.dd.mm

Valid Julian dates formats are yyddd, yyyyddd, yy/ddd, yyyy/ddd, yy.ddd, or yyyy.ddd. If you do not specify the DATEFORM parameter, Connect:Direct for z/OS defaults to MDY date format.

hh:mm:ssXM indicates the time of day in hours (hh), minutes (mm), and seconds (ss) to select. Set XM to AM or PM. You can use the 24-hour clock or the 12-hour clock. If you use the 24-hour clock, valid times are 00:00-24:00. If you use the 12-hour clock, 1:00 hours are expressed as 1:00AM, and 13:00 hours are expressed as 1PM. If you use neither AM or PM, IBM Connect:Direct assumes the 24-hour clock. You do not have to specify minutes and seconds.

If you do not specify a start date, the start date will be Jan 0, 0000. If you do not specify a start time, the start time will be 00:00:00. If you specify neither, the start date and time will be Jan 0, 0000 00:00:00. If the start date and time is after the current system date and time, searching will be bypassed, and so nothing will be selected. If you specify a day of the week, it is always resolved to the current date or a prior date, never a future date.
Note: This is required parameter.
STOPT = ([date][,hh:mm:ssXM])

Specifies stopping date and time of operation or function which generated this record. The date, day, and time are positional parameters. If you do not specify the date or day, place a comma before the time.

The date and time formats are the same as the STARTT parameter. The time default is 24:00:00, the end of the day.

If you do not specify a stop time, it will be 23:59:59.99. Otherwise, it will be the time specified. Either way, this time is only provisional.

Note: This is required parameter.
CCODE = completion code

Specifies a decimal value 1 to 2,147,483,647

Note: This is required parameter.

MSG.SHORTTEXT

or MSST = text

Specifies 1 to 72 characters in length short message text. Text must be enclosed within quotes For example,
MSG.SHORTTEXT = ‘Process Executed Successfully’
Same text can be specified on multiple lines as follows,
MSST = \’Process \ || -
 Executed Successful\’\
Note: This is required parameter.
USER = name

Specifies user name, who performed operation or function causing generation of this statistics record.

USER name can be up to 64 characters in length and can contain lowercase characters. If not specified, USER name default to current signed-on user.

LNODE = name

Specifies Local Node name on which process or command is submitted, causing generation of this statistics record.

If not specified, LNODE name default to current signed-on Node.

APPLICATION.NAME

or APP.NAME = text

Specifies 1 to 32 characters text description of application which is generating this statistics record. Text must be enclosed within quotes.

If not specified, it is defaulted to current signed-on application description. For example,
APPLICATION.NAME = ‘CD File Agent’

Same text can be specified on multiple lines as follows,

APP.NAME = \’CD \ ||
 - File Agent\’\

FCODE = feedback code

Specifies a decimal value 1 to 2,147,483,647

This is optional parameter and can be specified if message has feedback code in addition to completion code

PNAME = name

Specifies 1 to 8 characters Process name.

This is optional parameter and can be specified when statistics record is related to Connect:Direct process.

PNUMBER

Or PNUM = number

Specifies Process number. The range is 1-199999

This is an optional parameter and can be specified when statistics record is related to Connect:Direct process.

SUBMITTER = name

Specifies user name, who submitted the Connect:Direct process.

SUBMITTER name can be up to 64 characters in length and can contain lowercase characters. This is an optional parameter and can be specified when statistics record is related to Connect:Direct process

DSN = name

Specifies data set name or USS file path.

DSN can be up to 255 characters in length and can contain lowercase characters. Name must be enclosed within quotes.

This is optional parameter and can be specified when statistics record is related to data set or file. For example,

Data set name
DSN = ‘HLQ.LLQ’
USS absolute file name
DSN = ‘/u/Library/Book 001’
Same name can be specified on multiple lines as follows,
DSN = \'/u/Library/\ || -
Book 001\'\ 

MSG.LONGTEXT

or MSGT = text

Specifies 1 to 960 characters in length long message text. Text must be enclosed within quotes. This is optional parameter.

For example,

MSG.LONGTEXT = ‘Process Executed Successfully’

Same text can be specified on multiple lines as follows,

MSGT = \’Process \ || -
Executed Successful\’\

SYMBOLIC.PARAMETERS

or SYMBOLS = text

Specifies substitution parameters.

Text can be up to 127 characters in length and can contain lowercase characters. Text must be enclosed within quotes.

This is optional parameter and can be specified when statistics record is related to Connect:Direct process and process contains substitution parameters. For example,
SYMBOLIC.PARAMETERS = ':&DATE=TODAY:&GDG=+1:'

Same text can be specified on multiple lines as follows,

SYMBOLS = \':&DATE=TODAY\ || -
:&GDG=+1:\'\
UDF1 = text

Specifies additional text information.

Text can be up to 127 characters in length and can contain lowercase characters. Text must be enclosed within quotes. This is an optional parameter

For example,
UDF1 = ‘User Defined Field 1’

Same text can be specified on multiple lines as follows,

UDF1 = \'User Defined \ || -
Field 1\'\
UDF2 = text

Specifies additional text information.

Text can be up to 127 characters in length and can contain lowercase characters. Text must be enclosed within quotes. This is an optional parameter

For example,
UDF2 = ‘User Defined Field 2’
Same text can be specified on multiple lines as follows,
UDF2 = \'User Defined \ || -
 Field 2\'\
UDF3 = text

Specifies additional text information.

Text can be up to 127 characters in length and can contain lowercase characters. Text must be enclosed within quotes. This is an optional parameter

For example,
UDF2 = ‘User Defined Field 3’
Same text can be specified on multiple lines as follows,
UDF3 = \'User Defined \ || -
 Field 3\'\
UDF4 = text

Specifies additional text information.

Text can be up to 127 characters in length and can contain lowercase characters. Text must be enclosed within quotes. This is an optional parameter

For example,
UDF4 = ‘User Defined Field 4’
Same text can be specified on multiple lines as follows,
UDF4 = \'User Defined \ || -
 Field 4\'\

Connect:Direct provides permission, External Statistics Logging via authorization bit mask (ABM) to restrict user from performing WRITE EXSTATS command.

Connect:Direct also provides initialization parameter, EXTERNAL.STATS.ALLOWED to control which external statistics record identifiers are allowed from which application.