CRTGPHFMT (Create Graph Format)

Note: To use this command, have the 5722-PT1 (Performance Tools for iSeries) licensed program installed.

CRTGPHFMT Command syntax diagram

 

Purpose

The Create Graph Format (CRTGPHFMT) command creates a graph format used to display performance and historical graphs that are created from performance data members.

 

Required Parameters

GPHFMT

Specifies the graph format to be created.

The possible library values are:

• QPFRDATA: The graph format is located in the IBM-supplied performance data library, QPFRDATA.
• library-name: Specify the name of the library where the graph format is located.

format-name: Specify the name of the graph format to be created.

 

Optional Parameters

TEXT

Specifies the user-defined text that briefly describes the graph format or graph package.

*BLANK: The text description for the graph format or graph package is left blank.

'description': Specify no more than 50 characters of text, enclosed in apostrophes.

TITLE

Specifies the title for the graph.

*BLANK: The title for the graph is left blank.

*MBRTEXT: The text of the database member used in creating the graph with this format is used as the title.

'graph-title': Specify a title of no more than 50 characters for the graph produced using this format. Enclose the user-defined title in apostrophes.

SUBTITLE

Specifies the subtitle for the graph.

*BLANK: The subtitle for the graph is left blank.

*MBRTEXT: The text of the database member used in creating the graph with this format is used as the subtitle.

'graph-subtitle': Specify a subtitle of no more than 50 characters for the graph produced using this format. Enclose the user-defined subtitle in apostrophes.

GPHTYPE

Specifies the type of graph to produce.

*SURFACE: The graph is a surface graph.

*LINE: The graph is a line graph.

*CBAR: The graph is a composite bar graph.

*FBAR: The graph is a floating bar graph.

*SCATTER: The graph is a scatter diagram.

DATATYPE

Specifies the type of data to include on the graph.

*ALL: The value puts all of the jobs into one group for graphing.

*FCNARA: This value puts jobs into each of the functional areas that are to be graphed. Functional areas must be unique over the data that is graphed. For example, if a job exists in more than one of the functional areas selected for the graph, an error message is issued that indicates that the job exists in more than one functional area. In addition, you cannot use functional areas to graph historical data.

*JOBTYPE: This value includes individual job types, such as interactive, and conglomerate types, such as *ALLINTER (all interactive), *ALLBATCH (all batch), and *ALLSYSTEM (all system). All interactive refers to a job with a job type of I and includes interactive, iSeries Access, System/36, MRT, and display station pass-through.

*PRIORITY: This value puts jobs into priority ranges. For example, the range 10-20 includes all jobs that have priorities between 10 and 20, inclusive.

*IOP: This value allows you to graph maximum and average utilization lines for the particular type of input/output processor.

If the user specifies DATATYPE(*IOP), one of the following combinations must be specified:

• YAXIS(*CMNIOP) and XAXIS(*TIME)
• YAXIS(*DSKIOP) and XAXIS(*TIME)
• YAXIS(*LWSIOP) and XAXIS(*TIME)
• YAXIS(*MFCIOP) and XAXIS(*TIME)
• YAXIS(*MFDIOP) and XAXIS(*TIME)

*DISK: This value allows you to graph maximum and average utilization lines for the disk arms. It also allows maximum and average lines for the percentage of disk occupied.

If the user specifies DATATYPE(*DISK), then one of the following combinations must be specified:

• YAXIS(*DSKARM) and XAXIS(*TIME)
• YAXIS(*PCTDSKOCC) and XAXIS(*TIME)

*CMNLINE: This value allows you to graph individual communications line use or the maximum use of all communications lines.

This value is valid only if YAXIS(*CMNLINE) and XAXIS(*TIME) are specified.

AREAFILL

Specifies whether areas on the graph are filled in.

*NO: The areas on the graph are not filled in.

*YES: The areas on the graph are filled in.

REFLINE

Specifies where to place a reference line on the graph. The reference line is placed on the Y-axis. The line is parallel to the X-axis.

*NONE: No reference line is placed on the graph.

reference-line-number: Specify the number on the Y-axis on which the reference line is placed.

XAXIS

Specifies the list of characteristics that are used for creating the X-axis on the graph.

Element 1: X-axis Variable

*TIME: Time is mapped along the X-axis.

*CPU: Use of the CPU is mapped along the X-axis.

*TNS: The number of transactions per hour is mapped along the X-axis.

*NBRTNS: The total number of transactions is mapped along the X-axis.

*RSP: Response time is mapped along the X-axis.

*SYNCIO: Synchronous disk I/O per second is mapped along the X-axis.

*NBRSYNC: The total number of synchronous disk I/O operations is mapped along the X-axis.

*ASYNCIO: Asynchronous disk I/O per second is mapped along the X-axis.

*NBRASYNC: The total number of asynchronous disk I/O operations is mapped along the X-axis.

*TOTDSKIO: Total disk I/O per second is mapped along the X-axis.

*NBRDSKIO: The total number of disk I/O operations is mapped along the X-axis.

Element 2: X-axis Title

*DFT: The default title is used. This is the value specified for the X-axis variable.

*BLANK: The title for the X-axis is left blank.

'x-axis-title': Specify a title of no more than 30 characters for the X-axis. Enclose the title in apostrophes.

Element 3: Starting and Ending Range for X-axis

*AUTO: The X-axis range is automatically calculated. This value must be specified if *TIME is specified for the X-axis variable.

starting-number: Specify the starting number for the range on the X-axis. This value is valid only if an ending number is also specified.

ending-number: Specify the ending number for the range on the X-axis. This value is valid only if a starting number is also specified.

YAXIS

Specifies the list of characteristics that are used for creating the Y-axis on the graph.

Element 1: Y-axis Variable

*CPU: Use of the CPU is mapped along the Y-axis.

*TNS: The number of transactions per hour is mapped along the Y-axis.

*NBRTRNS: The total number of transactions is mapped along the Y-axis.

*RSP: Response time is mapped along the Y-axis.

*SYNCIO: Synchronous disk I/O per second is mapped along the Y-axis.

*NBRSYNC: The total number of synchronous disk I/O operations is mapped along the Y-axis.

*ASYNCIO: Asynchronous disk I/O per second is mapped along the Y-axis.

*NBRASYNC: The total number of asynchronous disk I/O operations is mapped along the Y-axis.

*TOTDSKIO: Total disk I/O per second is mapped along the Y-axis.

*NBRDSKIO: The total number of disk I/O operations is mapped along the X-axis.

*CMNIOP: Use of the communications input/output processor (IOP) is mapped along the Y-axis. If YAXIS(*CMNIOP) is specified, XAXIS(*TIME) must be specified.

*DSKIOP: Use of the disk IOP is mapped along the Y-axis. If YAXIS(*DSKIOP) is specified, XAXIS(*TIME) must be specified.

*LWSIOP: Use of the local work station IOP is mapped along the Y-axis. If YAXIS(*LWSIOP) is specified, XAXIS(*TIME) must be specified.

*MFCIOP: Use of the multifunction IOP for communications is mapped along the Y-axis. If YAXIS(*MFCIOP) is specified, XAXIS(*TIME) must be specified.

*MFDIOP: Use of the multifunction IOP for disks is mapped along the Y-axis. If YAXIS(*MFDIOP) is specified, XAXIS(*TIME) must be specified.

*DSKARM: Use of the disk arm is mapped along the Y-axis. IF YAXIS(*DSKARM) is specified, XAXIS(*TIME) must be specified.

*PCTDSKOCC: The percentage of information occupying the disk is mapped along the Y-axis. If YAXIS(*PCTDSKOCC) is specified, XAXIS(*TIME) must be specified.

*CMNLINE: Use of communications lines is mapped along the Y-axis. If YAXIS(*CMNLINE) is specified, XAXIS(*TIME) must be specified.

*LGLDBIO: The total number of logical database I/O operations is mapped along the Y-axis.

Element 2: Y-axis Title

*DFT: The default title is used. This is the value specified for the Y-axis variable.

*BLANK: The title for the Y-axis is left blank.

'y-axis-title': Specify a title of no more than 30 characters for the Y-axis. Enclose the title in apostrophes.

Element 3: Starting and Ending Range for Y-axis

*AUTO: The Y-axis range is automatically calculated.

starting-number: Specify the starting number for the range on the Y-axis. If you specify a starting number, also specify an ending number.

ending-number: Specify the ending number for the range on the Y-axis. If you specify an ending number, also specify a starting number.

FCNARA

Specifies the list of characteristics to be used for each functional area on the graph. The FCNARA parameter is valid only when DATATYPE(*FCNARA) is specified. When DATATYPE(*FCNARA) is specified, at least 1 but not more than 16 functional area entries must be specified.

Element 1: Name of Functional Area

*OTHER: All jobs that do not belong in one of the functional areas specified on the FCNARA parameter are grouped together.

functional-area-name: Specify the name of the functional area.

Element 2: Functional Area Legend Description

*DFT: The default legend description is used. This is the value or name specified for the functional area name.

*BLANK: The legend description for the functional area is left blank.

'legend-description': Specify the legend description for the functional area. Enclose the description in apostrophes.

Element 3: Graphic Display Line Type

There are eight types of lines from which the user can choose:

• 1. Dotted
• 2. Short-dashed
• 3. Dash-dot
• 4. Double-dot
• 5. Long-dashed
• 6. Dash-dot-dot
• 7. Solid
• 8. Invisible

7: The solid line is used for the lines representing the functional area on graphic terminals.

line-type-number: Specify the number of the line type to use for lines representing the functional area on graphic terminals.

Element 4: Non-Graphic Work Station Symbol

*: The asterisk symbol is used for graphic representation of the functional area on non-graphic terminals.

character: Specify a character to use for graphic representation of the functional area on non-graphic terminals.

JOBTYPE

Specifies the list of characteristics to be used for creating job type information on the graph. The JOBTYPE parameter is valid only when DATATYPE(*JOBTYPE) is specified. When DATATYPE(*JOBTYPE) is specified, at least 1, but not more than 16 job type entries must be specified.

Element 1: Job Type

*ALL: All job types are grouped together.

*ALLINTER: All interactive job types include:

• DDM jobs
• Pass-through jobs
• iSeries Access server jobs, except those that process batch activities only.
• Interactive jobs
• System/36 environment jobs
• Multiple requester terminal jobs

*ALLBATCH: All batch job types include:

• Batch jobs
• iSeries Access server jobs, those that process batch activities only.
• Evoke jobs
• Writer jobs
• Reader jobs
• Prestart jobs
• Autostart jobs
• Print driver jobs

*ALLSYSTEM: All system jobs include:

• System jobs
• Subsystem monitor jobs

*ASJ: Autostart jobs.

*BCH: Batch jobs.

*CA4: iSeries Access server jobs.

*DDM: Distributed Data Management (DDM) jobs.

*EVK: Jobs that are started by a procedure start request.

*INT: Interactive jobs.

*MRT: Multiple requester terminal jobs.

*PCS: iSeries Access server jobs.

*PDJ: Print Driver jobs.

*PJ: Prestart jobs.

*PTH: Pass-through jobs.

*RDR: Reader jobs.

*S36: System/36 environment jobs.

*SBS: Subsystem monitor jobs.

*SYS: System jobs.

*WTR: Writer jobs.

*OTHER: All job types that have not been specified on the JOBTYPE parameter are grouped together.

Element 2: Job Type Legend Description

*DFT: The default legend description is used. This is the value specified for the job type.

*BLANK: The legend description for the job type is left blank.

'legend-description': Specify the legend description for the job type. Enclose the description in apostrophes.

Element 3: Graphic Display Line Type

There are eight types of lines from which the user can choose:

• 1. Dotted
• 2. Short-dashed
• 3. Dash-dot
• 4. Double-dot
• 5. Long-dashed
• 6. Dash-dot-dot
• 7. Solid
• 8. Invisible

7: The solid line is used for lines representing the job type on graphic terminals.

line-type-number: Specify the number of the line type to use for lines representing the job type on graphic terminals.

Element 4: Non-Graphic Work Station Symbol

*: The asterisk symbol is used for graphic representation of the job type on non-graphic terminals.

character: Specify a character to use for graphic representation of the job type on non-graphic terminals.

PRIORITY

Specifies the characteristics to be used for creating job priority information on the graph. The PRIORITY parameter is valid only when DATATYPE(*PRIORITY) is specified. When DATATYPE(*PRIORITY) is specified, at least 1 but not more than 16 job priority entries must be specified.

Element 1: Job Priority Boundaries

*ALL: All job priorities are grouped together.

*OTHER: All job priorities that do not fall within the job priority boundaries specified on the PRIORITY parameter are grouped together.

lower-priority-boundary: Specify the lower job priority boundary. The user can specify a value ranging from 0 through 99.

upper-priority-boundary: Specify the upper job priority boundary. The user can specify a value ranging from 0 through 99. The upper boundary value must be greater than or equal to the lower boundary value.

Element 2: Job Priority Legend Description

*DFT: The default legend description is used. This is the value or priority boundaries specified for the job priority boundaries.

*BLANK: The legend description for the job priority is left blank.

'legend-description': Specify the legend description for the job priority. Enclose the description in apostrophes.

Element 3: Graphic Display Line Type

There are eight types of lines from which the user can choose:

• 1. Dotted
• 2. Short-dashed
• 3. Dash-dot
• 4. Double-dot
• 5. Long-dashed
• 6. Dash-dot-dot
• 7. Solid
• 8. Invisible

7: The solid line is used for lines representing the job priority on graphic terminals.

line-type-number: Specify the number of the line type to use for lines representing the job priority on graphic terminals.

Element 4: Non-graphic Work Station Symbol

*: The asterisk symbol is used for graphic representation of the job priority on non-graphic terminals.

character: Specify a character to use for graphic representation of the job priority on non-graphic terminals.

IOP

Specifies the characteristics to be used for creating input/output processor (IOP) information on the graph. The IOP parameter is valid only when DATATYPE(*IOP) is specified. When DATATYPE(*IOP) is specified, at least 1 but not more than 2 IOP data entries must be specified.

Element 1: Amount of Utilization for IOP Type

*AVG: The average utilization of the IOP type is presented on the graph.

*MAX: The maximum utilization of the IOP type is presented on the graph.

Element 2: IOP Type Legend Description

*DFT: The default legend description is used. This is the value specified for the amount of utilization for the IOP.

*BLANK: The legend description for the IOP data is left blank.

'legend-description': Specify the legend description for the IOP data. Enclose the description in apostrophes.

Element 3: Graphic Display Line Type for IOP Type

There are eight types of lines from which the user can choose:

• 1. Dotted
• 2. Short-dashed
• 3. Dash-dot
• 4. Double-dot
• 5. Long-dashed
• 6. Dash-dot-dot
• 7. Solid
• 8. Invisible

7: The solid line is used for lines representing the IOP type on graphic terminals.

line-type-number: Specify the number of the line type to use for lines representing the IOP type on graphic terminals.

Element 4: Non-graphic Work Station Symbol

*: The asterisk symbol is used for graphic representation of the IOP type on non-graphic terminals.

character: Specify a character to use for graphic representation of the IOP type on non-graphic terminals.

DISK

Specifies the characteristics to be used for creating disk data information on the graph. The DISK parameter is valid only when DATATYPE(*DISK) is specified. When DATATYPE(*DISK) is specified, at least 1 but not more than 2 disk data entries must be specified. The types of disk data are the:

• Disk arm utilization, and
• Percent of disk space that is occupied.

Element 1: Amount of Utilization for Disk Data Type

*AVG: The average utilization of the disk data type is presented on the graph.

*MAX: The maximum utilization of the disk data type is presented on the graph.

Element 2: Disk Data Type Legend Description

*DFT: The default legend description is used. This is the value specified for the amount of utilization for disk data.

*BLANK: The legend description for the disk data type is left blank.

'legend-description': Specify the legend description for the disk data type. Enclose the description in apostrophes.

Element 3: Graphic Display Line Type

There are eight types of lines from which the user can choose:

• 1. Dotted
• 2. Short-dashed
• 3. Dash-dot
• 4. Double-dot
• 5. Long-dashed
• 6. Dash-dot-dot
• 7. Solid
• 8. Invisible

7: The solid line is used for lines representing the disk data type on graphic terminals.

line-type-number: Specify the number of the line type to use for lines representing the disk data type on graphic terminals.

Element 4: Non-graphic Work Station Symbol

*: The asterisk symbol is used for graphic representation of the disk data type on non-graphic terminals.

character: Specify a character to use for graphic representation of the disk data type on non-graphic terminals.

CMNLINE

Specifies the characteristics used for creating communications line information on the graph. This parameter is valid only if DATATYPE(*CMNLINE) is specified. If DATATYPE(*CMNLINE) is specified, at least 1 but no more than 16 communications line entries must be specified.

Element 1: Communications Line Name

*MAX: The maximum utilization of all the communications lines is presented on the graph.

communications-line-name: Specify the name of the communications line to be presented on the graph.

Element 2: Communications Line Legend Description

*DFT: The default legend description is used. The is the value or name specified for the communications line name.

*BLANK: The legend description for the communications line is left blank.

'legend-description': Specify the legend description for the communications line. Enclose the description in apostrophes.

Element 3: Graphic Display Line Type

Specify the type of line:

1. Dotted
2. Short-dashed
3. Dash-dot
4. Double-dot
5. Long-dashed
6. Dash-dot-dot
7. Solid
8. Invisible

7: The solid line is used for lines representing the communications line on graphic terminals.

line-type-number: Specify the number of the line type to use for lines representing the communications line on graphic terminals.

Element 4: Non-graphic Work Station Symbol

*: The asterisk symbol is used for graphic representation of the communications line on non-graphic terminals.

character: Specify a character to use for graphic representation of the communications line on non-graphic terminals.

ALLDATA

Specifies the characteristics to be used for creating information on the graph for all jobs. The ALLDATA parameter is valid only when DATATYPE(*ALL) is specified.

Element 1: Legend Description

*DFT: The default legend description of *ALL is used.

*BLANK: The legend description for the data is left blank.

'legend-description': Specify the legend description for the data. Enclose the description in apostrophes.

Element 2: Graphic Display Line Type

There are eight types of lines from which the user can choose:

• 1. Dotted
• 2. Short-dashed
• 3. Dash-dot
• 4. Double-dot
• 5. Long-dashed
• 6. Dash-dot-dot
• 7. Solid
• 8. Invisible

7: The solid line is used for lines representing all of the job data on graphic terminals.

line-type-number: Specify the number of the line type to use for lines representing all of the job data on graphic terminals.

Element 3: Non-graphic Work Station Symbol

*: The asterisk symbol is used for graphic representation of all of the job data on non-graphic terminals.

character: Specify a character to use for graphic representation of all of the job data on non-graphic terminals.

Example for CRTGPHFMT

CRTGPHFMT   GPHFMT(FORMAT1)  TITLE(*MBRTEXT)
  DATATYPE(*FCNARA)
  FCNARA((ACCOUNTING 'ACCOUNTING')
  (SALES 'SALES' 7 #) (OFFICE 'OFFICE' 7 @))

This command creates a graph format named FORMAT1 in the QPFRDATA library. The member that is presented on the graph using this format supplies the title for the graph. The graph is a surface graph with no area fill nor a reference line. The jobs presented on the graph are grouped according to three functional areas:

1. ACCOUNTING
2. SALES
3. OFFICE

The functional area of accounting is represented on the graph with a solid line with the label, ACCOUNTING. If the format is displayed on a non-graphics work station, the asterisk (*) symbol is used to graphically represent the functional area of accounting. The functional areas, sales and office, are formatted in the same manner as accounting, except SALES is graphically represented with the # symbol on a non-graphics work station, and OFFICE is graphically represented with the at @ symbol on a non-graphics work station.

Error messages for CRTGPHFMT

*ESCAPE Messages

CPF0011

Error detected by prompt override program.

PFR9001

DATATYPE(*IOP) must be specified to use IOP variable.

PFR9002

DATATYPE(*DISK) must be specified to use a disk variable.

PFR9003

An IOP variable must be specified for YAXIS.

PFR9004

Disk variable must be specified for YAXIS.

PFR9006

*TIME must be specified for XAXIS.

PFR9007

*TIME must be specified for XAXIS.

PFR9008

Graph format &2 already exists in library &1.

PFR9010

No functional area &2 exists.

PFR9014

Graph axis range specified not correct.

PFR9015

Priority boundaries specified not correct.

PFR9016

Value for FCNARA parameter must be specified.

PFR9017

Value for JOBTYPE parameter must be specified.

PFR9018

Value for PRIORITY parameter must be specified.

PFR9019

Value for IOP parameter must be specified.

PFR9020

Value for DISK parameter must be specified.

PFR9021

Both axis variables cannot be the same.

PFR9040

Specify *AUTO for range with *TIME for variable.

PFR9081

Functional area name not valid.

PFR9090

DATATYPE(*CMNLINE) must be specified to use a communications line variable.

PFR9091

Communications line variable must be specified for YAXIS.

PFR9092

Value for CMNLINE parameter must be specified.

PFR9093

Graph format &3 already exists in library &2.

PFR9104

Record length for GDF file &2 not correct.

PFR9106

Too many data lines specified for scatter graph.

PFR9116

*LGLDBIO only valid when *JOBTYPE specified for DATATYPE parameter

PFR9117

*DDM must be specified for Job type parameter.

PFR9804

Library &2 not found.