Syntax
seehsf [action] options
This command can be used to administer a CICS region's HSF data.
Actions
The following mutually-exclusive command-line actions are available for use with the seehsf command. The
-aggregate action is assumed if no action is explicitly specified.
- -aggregate
- Generates data aggregated by transaction or job. Default action if no other action specified.
- -delete -all
- Delete all HSF data from the region database.
- -delete -before:time
- Delete HSF transaction data from the region database. All data for transactions or jobs which started before the specified time will be deleted from the region database.
- -delete -keep:n
- Delete HSF transaction data from the region database. Data for all but the latest
n transactions or jobs will be deleted from the region database (i.e. Data for
n transactions or jobs will be kept).
- -info
- Output information about the HSF data (number of transactions or jobs, and the time range for all transactions or jobs).
- -raw
- Generates data for each transaction or job, including job step data for JES regions.
- -timegroup
- Generates transaction or job data grouped into time blocks.
Options
For the
-aggregate,
-raw and
-timegroup actions:
- -count:n
- Number of transactions or jobs to produce data for. Data will only be produced for the most recent
n transactions or jobs.
- -endtime:time
- An upper bound on time. Data will not be produced for transactions or jobs which finished after this time. Defining a time range will reduce the time taken to generate the data.
- -out:output filename
- Output file name for data, in CSV format. Default:
seehsf.csv.
- -starttime:time
- A lower bound on time. Data will not be produced for transactions or jobs which were queued before this time. Defining a time range will reduce the time taken to generate the data.
For the
-raw action:
- -filedata
- Output data for CICS file APIs or JES file records
- CICS only
- -filemax:n
- Maximum number of files to output data for. The most heavily used files will be displayed first. If
n is set to 0, all files will be displayed (not compatible with
-files:<n>). Default: 5.
- -files:list
- A comma-separated list of specific files to output data for (not compatible with
-filemax:<n>).
- -tdqdata
- Include data for the CICS TDQ APIs in the output.
- -tdqmax:n
- Maximum number of TDQs to output data for. The most heavily used TDQs will be displayed first. If
n is set to 0, all TDQs will be displayed (not compatible with
-tdqs:<n>). Default: 5.
- -tdqs:list
- A comma-separated list of specific TDQs to output data for (not compatible with
-tdqmax:<n>).
- -transaction:tran-id
- A specific transaction to output data for.
- -tsqdata
- Include data for the CICS TSQ APIs in the output.
- -tsqmax:n
- Maximum number of TSQs to output data for. The most heavily used TSQs will be displayed first. If
n is set to 0, all TSQs will be displayed (not compatible with
-tsqs:<n>). Default: 5.
- -tsqs:list
- A comma-separated list of specific TSQs to output data for (not compatible with
-tsqmax:<n>).
- JES only
- -jobname:name
- The name of a specific job to output data for
For the
-timegroup action:
- -emptyrows
- Include empty rows (time intervals where there is no transaction or job data) in the output
- -timeinterval:interval units
- Time interval units. Either "seconds" or "minutes". Default: minutes.
- CICS only
- -transactions:list
- A comma-separated list of transaction-ids to output specific data for, in addition to data for all transactions. Default: Combined transaction data is output.
- JES only
- -jobs:list
- A comma-separated list of job names to output specific data for, in addition to data for all jobs Default: Combined job data is output
For all actions:
- -nobanner
- Do not display utility welcome and copyright messages.
- -region:region-name
- Name of region to administer HSF data for.
- -usedb
- Use the default SQL Server instance. Default: (local).
- -usedb:instance
- Use the specified SQL Server instance. Default: (local).
- -utc
- All datetime inputs will be interpreted as UTC, and all datetimes will be output in UTC. If omitted, all datetime inputs and outputs will be in the local timezone.
- -verbose
- The command output displays all of the messages that the command generates.
Examples
Custom output location/region/database:
seehsf -out:myFileName.csv -region:MYREGION -usedb:myServerName\myDb
Data (default: aggregated) for last 1000 transactions/jobs:
seehsf -count:1000
Data (default: aggregated) for transactions/jobs in a specified time range:
seehsf -starttime:2015-05-11 -endtime:2015-05-18
Raw data with file, TDQ, and TSQ data:
seehsf -raw -filedata -tdqdata -tsqdata
Raw data for a specific transaction and file:
seehsf -raw -transaction:ABCD -filedata -files:MYFILE
Raw data for a specific job, including file records:
seehsf -raw -region:JCLDEMO -jobname:MYJOB -filedata
Time-grouped data (1 minute time blocks by default):
seehsf -timegroup
Time-grouped data with a specified transaction list (1 second time blocks):
seehsf -timegroup -timeinterval:seconds -transactions:ACCT,MYTR
Time-grouped data with a specified jobs list:
seehsf -timegroup -region:JCLDEMO -jobs:JOB001,JOB002,JOB003
Deleting data from jobs/transactions before a specified date/time:
seehsf -delete -before:2015-05-30T12:30
Deleting all but the latest 1000 HSF transaction/job records from the region database:
seehsf -delete -keep:1000
