FILETYPE=HISTORY Parameters

You can use the following additional SYSIN01 parameters when FILETYPE=HISTORY is coded in the SYSIN01 DD statement of the XCOMJOB JCL:
xdtz12
You can use the following additional SYSIN01 parameters when FILETYPE=HISTORY is coded in the SYSIN01 DD statement of the XCOMJOB JCL:
OCOMPLETED
This parameter specifies a subtype of completed transfer requests to report on. Any combination of the values can  be specified.
  • S
   Report on completed transfers which completed successfully.
  • F
    Report on completed transfers which terminated as a result of a file error.
  • L
    Report on completed transfers which terminated as a result of a logic error.
  • N
    Report on completed transfers which terminated as a result of a network error.
  • T
    Report on completed transfers which terminated for other conditions.
If this parameter is not specified, all completed transfers are reported on when OTYPE=C or OTYPE=ALL is specified.
OEDATE
This parameter limits the history request to only those file transfers that were scheduled or completed on or before the end date and time.
  • YYYYMMDD
    The end date that is used to limit the history request to only those file transfers that were scheduled or completed on or before the end date and time specified.
    • YYYY
      The four-digit year
    • MM
      The two-digit number of the month, as follows:
      1 = January 2 = February 3 = March 4 = April 5 = May 6 = June 7 = July 8 = August 9 = September 10 = October 11 = November 12 = December
    • DD
      The two-digit day of the month (01 through 31)
Default:
No filtering by end date.
OEDATE and OETIME form an end date and time that is used to limit the history request to only those file transfers that were scheduled or completed on or before the date and time specified.
See OSDATE and OSTIME for the start date and time.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OETIME
This parameter limits the history request to only those file transfers that were scheduled or completed on or before the end date and time.
  • HHMMSS
    The end time that is used to limit the history request to only those file transfers that were scheduled or completed on or before the end date and time specified.
    • HH
      The two-digit hour (00 through 23)
    • MM
      The two-digit minute (00 through 59)
    • SS
      The two-digit second (00 through 59)
Default:
235959
OEDATE and OETIME form an end date and time that is used to limit the history request to only those file transfers that were scheduled or completed on or before the date and time specified.
See OSDATE and OSTIME for the start date and time.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
If OETIME is not specified or is set to 000000, it is treated as a value of 240000 or end of day for the specified end date.
OFILE
This parameter specifies the file name (local or remote) to match for a TYPE=HISTORY request.
Default:
No filtering by file name.
You can use the following wildcard characters when you specify the file name:
  • * or %
    Represents a string of zero or more characters.
  • _
    Represents any single character.
Example:
An OFILE value of
%MASTER.FIL_.G*
tells CA XCOM Data Transport to locate a file with following attributes:
  • Starting with anything
  • Ending with anything
  • With the characters
    MASTER.FIL
    found in the name, followed by any single character, followed by 
    .G
OFILECASE
This parameter specifies whether the specified file name (OFILE parameter) search could be case-sensitive.
Default:
N
OFILETYPE
This parameter limits the history request to those transfers with the specified FILETYPE.
  • JOB
    Restrict the search for file transfers to only FILETYPE JOB transfers.
  • REPORT
    Restrict the search for file transfers to only FILETYPE REPORT transfers.
  • FILE
    Restrict the search for file transfers to only FILETYPE FILE transfers.
Default:
No filtering by filetype.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OFLMAX
This parameter limits the history request to only the file transfers where the number of bytes transferred is equal to or less than the value specified.
  • NNNNNNNNN
    (
    N
    |
    X
    )
    A 1 to 10-digit number, where the last digit can be either another numeric digit or a one-character qualifier. This parameter is used to restrict the search for file transfers to only the  file transfers where the number of bytes transferred is equal to or less than the value specified.
    • X
      One of the following qualifiers (default B):
      • B = Bytes
      • K = Kilobytes
      • M = Megabytes
      • G = Gigabytes
Default:
No filtering by maximum number of bytes.
Use OFLMIN and OFLMAX to specify a range that can be used to limit the history request by number of bytes transferred.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OFLMIN
This parameter limits the history request to only the  file transfers where the number of bytes transferred is equal to or greater than the value specified.
  • NNNNNNNNN
    (
    N
    |
    X
    )
    A 1 to 10-digit number, where the last digit can be either another numeric digit or a one-character qualifier. This parameter is used to restrict the search for file transfers to only the  file transfers where the number of bytes transferred is equal to or greater than the value specified.
    • X
      One of the following qualifiers (default B):
      • B = Bytes
      • K = Kilobytes
      • M = Megabytes
      • G = Gigabytes
Default:
No filtering by minimum number of bytes.
Use OFLMIN and OFLMAX to specify a range that can be used to limit the history request by number of bytes transferred.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OID
Limits the history request to only those file transfers with a specific transfer ID. The transfer ID is a user-defined identifier for file transfer requests.
  • xxxxxxxxxx
    A 1-character to 10-character transfer ID used to limit the history request to only those file transfers that contain the specified transfer ID.
Default:
No filtering by transfer ID.
  • The wildcard character, *, can be used for this parameter only when specified as the last character.
  • You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OINACTIVE
OINACTIVE specifies a subtype of inactive transfer requests to report on. Any combination of the following values can be specified.
  • H
   Report on inactive transfers which are in a HELD status.
  • S
    Report on inactive transfers which are in a SUSPENDED status.
When OTYPE=I or OTYPE=ALL is specified and this parameter is not specified, all inactive transfers are reported.
OINCLUDE
OINCLUDE indicates how transfers are selected to meet the date and time range criteria.
  • ACTIVE
    The selected transfers that are or were active within the date and time range criteria.
  • EXECUTED
    The selected transfers that started and ended within the date and time range criteria.
  • STARTED
    Only the transfers that started in the specified time range are reported.
  • COMPLETE
    Only the transfers that completed in the specified time range are reported.
Default:
Active
OINIT
Limits the history request to only locally initiated transfers or only remotely initiated transfers.
  • LOCAL or L
    Restrict the search for file transfers to only locally initiated transfers.
  • REMOTE or R
    Restrict the search for file transfers to only remotely initiated transfers.
Default:
No filtering by initiated type.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OJOB
This parameter specifies the invoking job name to match for a TYPE=HISTORY request.
Default:
No filtering by job name.
You can use the * wildcard character when you specify the job name.
OLIMIT
This parameter sets the maximum number of history records that can be returned.
  • NNNN
    Specifies a one- to four-digit number (1 through 9999) that limits the maximum number of records to be returned by the history request.
Default:
Set by the CA XCOM default (XCOMDFLT) table parameter OPERLIM.
OLMSG
Limits the history request by the transfer last message. The format to use for CA XCOM Data Transport messages is as follows:
  • XCOM
    XNNNNS
    A 1- to 10-character name used to restrict the search for file transfers to those where the last message matches the value specified.
    • XCOM
      Indicates that the message is from CA XCOM Data Transport.
    • X
      Identifies the system.
    • NNNN
      Is the message number.
    • S
      Is the message severity:
      • I = Informational
      • W = Warning
      • E = Error
Default:
No filtering by last message.
The wildcard character, *, can be used for this parameter only when specified as the last character.
This parameter is case-sensitive.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OLOCATN
This parameter specifies the location to search for history records.
  • QUEUE
    Restrict the search for file transfers to the request queue of the server.
  • DATABASE
    Restrict the search for file transfers to the history database. Depending on the HISTORY configuration option, this is either the VSAM History file or an ODBC database.
  • *
    Searches both the request queue and the history database for file transfer requests.
Default:
No filtering by history record location.
OLU
Limits the history request to only those file transfers with a specific remote LU name.
  • xxxxxxxx
    A one- to eight-character LU name used to limit the history request to only those file transfers for the specified remote LU.
Default:
No filtering by LU name.
The wildcard character, *, can be used for this parameter only when specified as the last character.
This parameter is case-sensitive.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OPLEXQ
Limits the history request to only those locally initiated file transfers which were scheduled via the named PLEXQ Group.
  • xxxxxxxx
    A one- to eight-character PLEXQ Group name used to limit the history request to only this locally initiated file transfers scheduled using the specified PLEXQ Group.
Default:
No filtering of transfers by PLEXQ group. This means all transfers that meet all other criteria are reported.
The wildcard character, *, can be used for this parameter only when specified as the last character.
OREQ
Limits the history request to only those file transfers that contain this specific request number.
  • NNNNNN
    A one- to six-character request number used to limit the history request to a specific request number.
Default:
All request numbers
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OSDATE
This parameter limits the history request to only those file transfers that were scheduled or completed on or after the start date and time.
  • YYYYMMDD
    The start date that is used to limit the history request to only those file transfers that were scheduled or completed on or after the start date and time specified.
    • YYYY
      The four-digit year
    • MM
      The two-digit number of the month, as follows:
      1 = January 2 = February 3 = March 4 = April 5 = May 6 = June 7 = July 8 = August 9 = September 10 = October 11 = November 12 = December
    • DD
      The two-digit day of the month (01 to 31)
Default:
No filtering by start date.
OSDATE and OSTIME form a start date and time that is used to limit the history request to only those file transfers that were scheduled or completed on or after the date and time specified.
See OEDATE and OETIME for the end date and time.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OSTIME
This parameter limits the history request to only those file transfers that were scheduled or completed on or after the start date and time.
  • HHMMSS
    The start time that is used to limit the history request to only those file transfers that were scheduled or completed on or after the start date and time specified.
    • HH
      The two-digit hour (00 through 23)
    • MM
      The two-digit minute (00 through 59)
    • SS
      The two-digit second (00 through 59)
Default:
000000
OSDATE and OSTIME form a start date and time that is used to limit the history request to only those file transfers that were scheduled or completed on or after the date and time specified.
See OEDATE and OETIME for the end date and time.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OSYSID
Limits the history request to only those file transfers with a specific history system ID in an XCOMPLEX environment.
  • xxxx
    A one- to four-character history system ID used to limit the history request to only those file transfers for the specified history system ID.
Default:
No filtering by history system ID.
The wildcard character, *, can be used for this parameter only when specified as the last character.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OSYSNAME
Limits the history request to only those file transfers with a specific history system name in an XCOMPLEX environment.
  • xxxxxxxx
    A one- to eight-character history system name used to limit the history request to only those file transfers for the specified history system name.
Default:
No filtering by history system name.
The wildcard character, *, can be used for this parameter only when specified as the last character.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OTNAME
Limits the history request to only those file transfers with a specific remote TCP/IP name or TCP/IP address.
  • xxxxxxxx…x
    A 1- to 64-character TCP/IP name or address used to limit the history request to only those file transfers for the specified TCP/IP name or address.
Default:
No filtering by TCP/IP name or address.
The wildcard character, *, can be used for this parameter only when specified as the last character.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OTYPE
This parameter specifies if the history request must include inactive transfer requests, active transfer requests, or completed transfers.
  • I
    Selecting this option retrieves history records for file transfers whose execution is still pending.
  • A
    Selecting this option retrieves history records for file transfers that are currently in progress.
  • C
    Selecting this option retrieves history records for file transfers that have been successfully or unsuccessfully completed.
  • ALL|AIC|*
    Selecting this option retrieves history records for all file transfers, independent of their status.
You can also specify values in combination; for example, specify
AI
to request history records for file transfers currently in progress
and
file transfers whose execution is still pending.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
Default:
AIC
OTYPEREQ
Limits the history request to only send transfers or only receive transfers.
  • SEND or S
    Restrict the search for file transfers to only send transfers.
  • RECEIVE or R
    Restrict the search for file transfers to only receive transfers.
Default:
No filtering by send/receive transfers.
This parameter is case-sensitive.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OUSER
Limits the history request to only the  file transfers submitted by a specific user.
  • xxxxxxxxxxxx
    A 1- to 12-character user name used to limit the history request to only the  file transfers submitted by the specified user.
Default:
No filtering by userid.
The wildcard character, *, can be used for this parameter.
You can use symbolic variables with this parameter in batch SYSIN01. For more information, see Symbolic Parameters.
OVOL
This parameter specifies the volser (local or remote) to match for a TYPE=HISTORY request.
Default:
No filtering by volser.
Note:
You can use the * wildcard character when you specify the volser.