jpcrdef create
- Organization of this page
Format
jpcrdef create [-mx maximum-heap-size] [-ms initial-heap-size] [-dateformat date-format-pattern-name] [-dateseparator date-format-separator-name] input-file-name
Function
The jpcrdef create command connects to PFM - Manager and creates a new report definition. The command acquires the contents of the definition from the XML-format parameter file specified as a command line argument. Multiple report definitions can be specified and created in one parameter file at the same time.
Hosts that can execute the command
PFM - Web Console
Execution permission
- In Windows:
-
User with Administrators permissions
- In UNIX:
-
User with root user permissions
To execute this command, a key file for authentication needs to be created in advance for a user account with administrator user permissions or general user permissions# for Performance Management. For details, see the jpcmkkey command.
- #
-
Execution permissions for Performance Management that are required for a Performance Management user or JP1 user.
Installation directory
- In Windows:
-
installation-folder\tools\
- In UNIX:
-
/opt/jp1pcwebcon/tools/
Arguments
-mx maximum-heap-size
Specifies the maximum heap size for java.exe (in megabytes). The default is 128 MB. The maximum size that can actually be acquired depends on the system. If the specified value does not satisfy the following conditions, an invalid command line format results:
-
Integer in the range 1 to 2,048
-
Value specified in -mx >= value specified in -ms
-ms initial-heap-size
Specifies the initial heap size for java.exe (in megabytes). The default is 32 MB. If the specified value does not satisfy the following conditions, an invalid command line format results:
-
Integer in the range 1 to 2,048
-
Value specified in -mx >= value specified in -ms
-dateformat date-format-pattern-name
Specifies the name of the date format pattern that is used to identify the format of dates specified in the <expression> tag in the input file. The following date format pattern names can be specified:
-
pattern-ddMMyyyy
-
pattern-MMddyyyy
-
pattern-yyyyMMdd
-dateseparator date-format-separator-name
Specifies the character string that is used to identify the format of separators specified in the <expression> tag in the input file. The following date format separator names can be specified:
-
space
-
slash
-
hyphen
-
period
input-file-name
Specifies the XML-format parameter file that is to be used to create the new report(s). This parameter file must be created according to the Parameter file format described below. You can specify the absolute file path name, relative file path name, or file name. When the name is not the absolute file path, the command assumes the current directory.
Parameter file format
XML tag specifications
-
report-definitions
Type
Description
Description
Root tag for report definition information
Specifiable value
None
Omissible
No
Attribute
None
Parent element
pr-cli-parameters
Child element
report-definition
-
report-definition
Type
Description
Description
Specifies a single report definition.
Specifiable value
None
Omissible
No
Attribute
name
Specify a report definition name with 1 to 64 double-byte and/or single-byte characters (rather than 1 to 64 bytes). If the report definition name contains \ or /, specify it as \\ or \/, respectively. If the specified report definition name already exists, an error results. If the parent-folder attribute is specified but the name attribute is omitted, an error results. If spaces are specified before and/or after the report definition name, the name is registered without the leading and/or trailing spaces.
parent-folder
Specify the name of the directory that contains the report definition specified in the name attribute. The name that you specify is a slash (/) separated path from the root directory. The path can have 1 to 64 double-byte and/or single-byte characters (rather than 1 to 64 bytes). For a path, specify directories sequentially separated by / starting from the highest-level directory. If the directory name contains \ or /, specify it as \\ or \/, respectively. The report definition directory in the system definition cannot be specified. If the specified directory does not exist, the command creates it. If this attribute is omitted, an error results. An error results if spaces are specified before and/or after the directory name.
For example, to output the report definition named PD define located under the User Reports root directory, specify as follows:
<report-definition name="PD define" parent-folder="/"/>
The following example outputs to a file, all report definitions located in the Dir1 and Dir2 directories under the User Reports root directory:
<report-definition parent-folder="/Dir1/Dir2"/>
id
Ignored, if specified.
read-only
Specify TRUE to cancel creation of the report definition and to process the next report-definition element. When you specify FALSE or you omit this attribute, the command creates the report definition.
Parent element
report-definitions
Child element
product-id
report-type
record
indication-settings
realtime-indication-settings
view-type
drilldown
-
product-id
Type
Description
Description
Type of product for which report information is to be collected
Specifiable value
Specify a product code that consists of a product ID and a data model version number. A product ID is an upper-case alphabetic character that identifies an agent product. A data model version is a number assigned by an agent. For details about product IDs, see the description of identifiers in the applicable PFM - Agent or PFM - RM manuals.
When the data model version of report A is equal to or later than the data model version of report B, you can drill down to report B from report A.
Omissible
No
Attribute
None
Parent element
report-definition
Child element
None
-
report-type
Type
Description
Description
Specifies the report type.
Specifiable value
None
Omissible
No
Attribute
type
Specify one of the following, in all lower-case letters or all upper-case letters:
-
For a historical (single agent) report
historical-single-agent or
HISTORICAL-SINGLE-AGENT
-
For a historical (multiple agents) report
historical-multiple-agents or
HISTORICAL-MULTIPLE-AGENTS
-
For a realtime (single agent) report
realtime-single-agent or
REALTIME-SINGLE-AGENT
Parent element
report-definition
Child element
None
-
-
record
Type
Description
Description
Specifies the target record for reports.
Specifiable value
None
Omissible
No
Attribute
id
Specify a record ID. This attribute cannot be omitted. The permitted record attribute depends on the report-type setting. For details, see Table 3-32 Combinations of record attribute and fields that can be specified for reports.
Parent element
report-definition
Child element
fields
condition-expression
-
fields
Type
Description
Description
Specifies one or more target fields for reports.
Specifiable value
None
Omissible
No
Attribute
None
Parent element
record
Child element
field
-
field
Type
Description
Description
Specifies one target field for reports.
Specifiable value
Specify a field ID of the selected record. Not all the attributes (table, list, and graph) can be set to FALSE in all field attributes. Make sure that at least one of table, list, or graph is set to TRUE.
If table, list, and graph are all FALSE in all fields, an error results. An error results if the field tag is specified using a duplicate field ID within the same field tag.
Some fields are added, collected, and summed up only when they are recorded in Agent Store and Remote Monitor Store as historical data, such as xxxx(Total). These fields cannot be specified for realtime reports. If specified, an error results. For details, see Table 3-36 Fields that cannot be specified for realtime reports.
Omissible
No
Attribute
table
Specify TRUE to display a table; otherwise, specify FALSE. This attribute cannot be omitted.
list
Specify TRUE to display a list; otherwise, specify FALSE. This attribute cannot be omitted.
graph
Specify TRUE to display a graph; otherwise, specify FALSE. This attribute cannot be omitted.
Specifying TRUE for a text-format field results in an error.
display-name
Specify a user display name with 24 or fewer double-byte and/or single-byte characters.
If this attribute is omitted or the null character (display-name="") or a space (display-name=" ") is specified, the field name is displayed.
Parent element
fields
Child element
None
-
condition-expression
Type
Description
Description
Specifies a logical operation for the filtering conditional expression.
Specifiable value
None
Omissible
Yes (when the parameter is omitted, it is not set)
Attribute
None
Parent element
record
ref-field
Child element
and
or
expression
-
expression
Type
Description
Description
Specifies a conditional expression.
Specifiable value
(1) When specified for a filtering condition
Specify a conditional expression in the format field condition ["value"]. Spaces cannot be used to delimit field, condition, and ["value"].
A field whose data type is time_t can be specified only when the value is omitted and specify-when-displayed is set to TRUE.
field
Specify a field in the record expressed as PFM - Manager name. For details about the PFM - Manager name, see the description of records in the applicable PFM - Agent or PFM - RM manuals.
condition
Specify one of the following as the condition value:
-
=: Field value is equal to ["value"].
-
<: Field value is less than ["value"].
-
<=: Field value is equal to or less than ["value"].
-
>: Field value is greater than ["value"].
-
>=: Field value is equal to or greater than ["value"].
-
<>: Field value is any value other than ["value"].
In XML, specify < for < and > for >.
Character string fields are compared in ascending order of ASCII codes.
["value"]
Specify a value enclosed in double quotation marks ("). The permitted maximum length is 2,048 bytes.
The character encoding, data length, and data format depend on the data type of the field specified in the left-hand term.
If specify-when-displayed attribute is set to TRUE, this value can be omitted.
The value cannot contain any control character or any of the symbols ( ) [ ] < > = ". If a control character or any of these symbols is specified, an error results.
Specify the value according to the data type of the field described in the PFM - Agent or PFM - RM manuals. The permitted values are as follows:
-
Characters (specify as is)
-
Integer (specify a value in the range permitted for Integer)
-
Decimal value (specify a value in the range permitted for Double; more than four decimal places must be rounded to four decimal places according to IEEE 754: Standard for Floating-Point Arithmetic#)
-
Date (One of the formats dd MM yyyy, MM dd yyyy, or yyyy MM dd must be used. Specify the same display format that is set for the locale in the OS.)
(The time is always in the format HH:mm:ss.)
For details about date display formats, see the JP1/Performance Management Planning and Configuration Guide.
(2) When specified for the target field for drilldown
Specifies a conditional expression in the format field condition ["value"] or field condition field. Spaces cannot be used to delimit field, condition, and value.
field
Specify a field in the record that was specified for the drilldown report.
condition
See the conditions described in (1) When specified for a filtering condition.
["value"] or field
-
When specifying a value in the right-hand term
For details about the value to be specified, see ["value"] in (1) When specified for a filtering condition.
-
When specifying a field in the right-hand term
Specify the field ID of the record, DATETIME field, or ODBC key field. For details about the ODBC key field, see the PFM - Agent or PFM - RM manuals.
Omissible
Yes (if condition-expression is specified, this parameter cannot be omitted)
Attribute
specify-when-displayed
Specify TRUE to set the value during execution; otherwise, specify FALSE. If this attribute is omitted, FALSE is assumed. If you specify FALSE without specifying a value in the logical expression for the element value, an error results.
Parent element
condition-expression
and
or
Child element
None
-
-
and
Type
Description
Description
Specifies the AND operation of the logical expression specified in expression.
Specifiable value
None
Omissible
Yes (parameter is specified when AND is specified in the conditional expression)
Attribute
None
Parent element
and
or
condition-expression
Child element
expression
and
or
-
or
Type
Description
Description
Specifies the OR operation of the logical expression specified in expression.
Specifiable value
None
Omissible
Yes (parameter is specified when AND is specified in the conditional expression)
Attribute
None
Parent element
and
or
condition-expression
Child element
expression
and
or
-
indication-settings
Type
Description
Description
Specifies the report display period, report interval, peak time display, and maximum number of records.
indication-settings can be specified only when report-type is historical-single-agent or historical-multiple-agents. If this parameter is specified when report-type is realtime-single-agent, an error results.
Specifiable value
None
Omissible
Yes (when the parameter is omitted, the default is assumed including the child elements)
Attribute
specify-when-displayed
Specify TRUE to specify the value when the report is displayed; otherwise, specify FALSE. If this attribute is omitted, FALSE is assumed.
maximum-number-of-records
Specify the maximum number of records to be displayed in the report, as an integer in the range 1 to 2,147,483,647. If this attribute is omitted, 1,440 is assumed.
Parent element
report-definition
Child element
date-range
report-interval
peak-time
-
date-range
Type
Description
Description
Specifies the report display period.
Specifiable value
Specify one of the following values:
-
For the past hour: WITHIN_THE_PAST_HOUR
-
For the past day (24 hours): WITHIN_THE_PAST_24_HOURS
-
For the past 7 days: WITHIN_THE_PAST_7_DAYS
-
For the past month: WITHIN_THE_PAST_MONTH
-
For the past year: WITHIN_THE_PAST_YEAR
-
For specifying the value when the report is displayed: SPECIFY_WHEN_DISPLAYED
These values are not case sensitive.
Omissible
Yes (when the parameter is omitted, SPECIFY_WHEN_DISPLAYED is assumed)
Attribute
None
Parent element
indication-settings
Child element
None
-
-
report-interval
Type
Description
Description
Specifies the report interval.
Specifiable value
Specify one of the following values (which are not case sensitive):
-
For minutely: MINUTE
-
For hourly: HOUR
-
For daily (every 24 hours): DAY
-
For weekly: WEEK
-
For monthly: MONTH
-
For yearly: YEAR
Specifying a PI record results in an error.
Omissible
Yes (when the parameter is omitted, HOUR is assumed)
Attribute
None
Parent element
indication-settings
Child element
None
-
-
peak-time
Type
Description
Description
Displays the report only when a field value reaches its maximum.
Specifiable value
If the record specified in record is a single-instance record, specify one of its field IDs. The system will display the record only as it exists when the field's maximum value for the day occurs. An error results if report-interval is not HOUR, the record is a multiple-instance record, or report-type is HISTORICAL-MULTIPLE-AGENTS.
Omissible
Yes (when the parameter is omitted, no field is set in peak-time)
Attribute
None
Parent element
indication-settings
Child element
None
-
realtime-indication-settings
Type
Description
Description
Specifies the realtime report refresh interval and display by ranking.
realtime-indication-settings can be specified only when report-type is realtime-single-agent. An error results if this parameter is specified when report-type is not realtime-single-agent.
Specifiable value
None
Omissible
Yes (when the parameter is omitted, the defaults are assumed, including for child elements)
Attribute
specify-when-displayed
Specify TRUE to specify the value when the report is displayed; otherwise, specify FALSE. If this attribute is omitted, FALSE is assumed.
indicate-delta-value
Specify TRUE to display delta values; otherwise, specify FALSE. If this attribute is omitted, TRUE is assumed.
Whether or not delta values can be displayed depends on each field that is collected at the agent. For details, see Table 3-35 Delta values in realtime reports and display conditions.
Parent element
report-definition
Child element
refresh-interval
display-by-ranking
-
refresh-interval
Type
Description
Description
Specifies whether or not the displayed information is to be refreshed automatically, the initial value for the automatic refresh interval (seconds), and the minimum value (seconds).
Specifiable value
None
Omissible
Yes (when the parameter is omitted, automatic updating is assumed)
Attribute
do-not-refresh-automatically
Specify TRUE to not automatically refresh data displayed in the realtime report; otherwise, specify FALSE. If this attribute is omitted, FALSE is assumed.
initial-value
If do-not-refresh-automatically is FALSE, specify the automatic refresh interval for the data displayed in the report, as an integer in the range from the value specified for minimum-value to 3,600 seconds.
If do-not-refresh-automatically is TRUE, specifying initial-value results in an error.
If initial-value and minimum-value are both omitted, the value of initial-value is set to 60 seconds.
If minimum-value is specified but initial-value is omitted, the value of initial-value is set to the value specified for minimum-value.
minimum-value
If do-not-refresh-automatically is FALSE, specify the minimum value permitted as the automatic refresh interval for the data displayed in the report, as an integer in the range 10 to 3,600 seconds.
If do-not-refresh-automatically is TRUE, specifying minimum-value results in an error.
If initial-value and minimum-value are both omitted, the value of minimum-value is set to 60 seconds.
If initial-value is specified but minimum-value is omitted, the value of minimum-value is set to the value specified for initial-value.
Parent element
realtime-indication-settings
Child element
None
-
display-by-ranking
Type
Description
Description
Specifies that the field specified in the field attribute is to be sorted in ascending or descending order and as many items as are specified in the display-number attribute are to be displayed from the top as ranking data in the report.
This parameter is applicable only to multi-row records (multi-instance records). If it is specified for a single-row record, an error results.
If display-by-ranking and display-key are both specified, the data acquired based on the display-by-ranking condition is displayed according to the display-key condition.
Specifiable value
None
Omissible
Yes (when the parameter is omitted, information is not displayed by ranking)
Attribute
field
Specify the field ID of the field to be used as the basis for display by ranking. Omitting this attribute results in an error.
If the specified field is not permitted for display by ranking, an error results.
For the data types of fields that can be specified for display by ranking, see Table 3-31 Specifiable combinations of parameters (for realtime reports).
display-number
Specify the number of items to be displayed by ranking, as an integer in the range 1 to 100. If this attribute is omitted, 10 is assumed.
in-descending-order
The field used as the basis for display by ranking can be sorted in ascending or descending order and then as many items as specified in the display-number attribute can be displayed from the beginning. Specify
TRUE to sort the field in ascending order and FALSE to sort in descending order. If this attribute is omitted, FALSE is assumed.
Parent element
realtime-indication-settings
Child element
None
-
view-type
Type
Description
Description
Specifies the report format.
Specifiable value
None
Omissible
Yes (display-key and graph-properties are set to all default values.)
Attribute
None
Parent element
report-definition
Child element
display-key
graph-properties
-
display-key
Type
Description
Description
Specifies the field for sorting records. If you specify display-key, you cannot specify LINE, AREA, or STACKED_AREA for graph-type.
Specifiable value
Specify the field ID.
Omissible
Yes (when the parameter is omitted, information is displayed in time series)
Attribute
in-descending-order
-
TRUE: Sort in descending order.
-
FALSE (or if omitted): Sort in ascending order.
Parent element
view-type
Child element
None
-
-
graph-properties
Type
Description
Description
Specifies the graph type and format. If no field is set to graph=true in the <field> tag, specifying the <graph-properties> tag results in an error.
Specifiable value
None
Omissible
Yes
Attribute
show-areas-of-missing-data
Specify TRUE to show areas of missing data, caused by a reason such as an inactive agent; this applies to a graph when the graph type is LINE, AREA, or STACKED_AREA and the data belongs to multiple agents or a multi-instance record. Or, specify FALSE to fill missing data.
If this attribute is omitted, FALSE is assumed.
series-direction
Specify BY_ROW to display graph data by record (row), or specify BY_COLUMN to display graph data by field (column).
If graph-type is LINE, AREA, or STACKED_AREA, this attribute is ignored. If graph-type is LINE, AREA, or STACKED_AREA and the target to be reported is multiple lines of records or multiple agents, BY_COLUMN is assumed; if the target to be reported is neither multiple lines of records nor multiple agents, BY_ROW is assumed.
If this attribute is omitted when graph-type is not LINE, AREA, or STACKED_AREA, BY_ROW is assumed.
Parent element
view-type
Specifies the report display format.
Child element
graph-type
axis-labels
data-label
-
graph-type
Type
Description
Description
Specifies the type of graph.
Specifiable value
Specify one of the following values:
-
For a column graph: COLUMN
-
For a stacked column graph: STACKED_COLUMN
-
For a bar graph: BAR
-
For a stacked bar graph: STACKED_BAR
-
For a pie graph: PIE
-
For a line graph: LINE
-
For an area graph: AREA
-
For a stacked area graph: STACKED_AREA
These values are not case sensitive.
Omissible
Yes (when the parameter is omitted, COLUMN (column graph) is assumed)
Attribute
None
Parent element
graph-properties
Child element
None
-
-
axis-labels
Type
Description
Description
Specifies X-axis and Y-axis labels for the graph. If PIE is specified in the <graph-type> tag, specifying an X-axis label or a Y-axis label results in an error.
Specifiable value
None
Omissible
Yes (when the parameter is omitted, neither the X-axis nor Y-axis label is displayed)
Attribute
None
Parent element
graph-properties
Child element
x-axis
y-axis
-
x-axis
Type
Description
Description
Specifies the X-axis label for the graph.
Specifiable value
A string that is 0 to 40 characters long (a double-byte character is counted as one character)
Omissible
Yes (when the parameter is omitted, the X-axis label is not displayed)
Attribute
None
Parent element
axis-labels
Child element
None
-
y-axis
Type
Description
Description
Specifies the Y-axis label for the graph.
Specifiable value
A string that is 0 to 40 characters long (a double-byte character is counted as one character)
Omissible
Yes (when the parameter is omitted, the Y-axis label is not displayed)
Attribute
None
Parent element
axis-labels
Child element
None
-
data-label
Type
Description
Description
Specifies the label display fields. If a single-instance record is specified, or if historical-single-agent is specified in report-type, or if LINE, AREA, or STACKED_AREA is specified in graph-type, specifying data-label results in an error.
Specifiable value
None
Omissible
Yes (when the parameter is omitted, the data label is not displayed)
Attribute
None
Parent element
graph-properties
Child element
data-label1
data-label2
-
data-label1
Type
Description
Description
Specifies the label display field for data label 1. Data label 2 can also be specified. The value for data label 2 is displayed in parentheses to the right of the value of data label 1.
Specifiable value
When report-type is historical-single-agent:
For a single-instance record:
-
Field ID specified in the fields tag
-
DATETIME field
For a multi-instance record:
-
Field ID specified in the fields tag
-
DATETIME field
-
Record-specific ODBC key field
When report-type is historical-multiple-agents:
For a single-instance record:
-
Field ID specified in the fields tag
-
DATETIME field
-
DEVICEID field
-
PROD_INST field
When report-type is realtime-single-agent:
For a single-instance record:
-
Field ID specified in the fields tag
-
RECORD_TIME field
For a multi-instance record:
-
Field ID specified in the fields tag
-
RECORD_TIME field
-
Record-specific ODBC key field
For details about the ODBC key field, see the PFM - Agent or PFM - RM manuals.
Omissible
Yes (when the parameter is omitted, data label 1 is not set)
Attribute
None
Parent element
data-label
Child element
None
-
-
data-label2
Type
Description
Description
Specifies the label display field for data label 2, expressed as the field ID corresponding to record. Specifying data-label2 without specifying data-label1 results in an error.
Specifiable value
When report-type is historical-single-agent:
For a single-instance record:
-
Field ID specified in the fields tag
-
DATETIME field
For a multi-instance record:
-
Field ID specified in the fields tag
-
DATETIME field
-
Record-specific ODBC key field
When report-type is historical-multiple-agents:
For a single-instance record:
-
Field ID specified in the fields tag
-
DATETIME field
-
DEVICEID field
-
PROD_INST field
When report-type is realtime-single-agent:
For a single-instance record:
-
Field ID specified in the fields tag
-
RECORD_TIME field
For a multi-instance record:
-
Field ID specified in the fields tag
-
RECORD_TIME field
-
Record-specific ODBC key field
For details about the ODBC key field, see the PFM - Agent or PFM - RM manuals.
Omissible
Yes (when the parameter is omitted, data label 2 is not set)
Attribute
None
Parent element
data-label
Child element
None
-
-
drilldown
Type
Description
Description
Specifies the target field and report for drilldown.
Specifiable value
None
Omissible
Yes (when the parameter is omitted, drilldown is not set)
Attribute
None
Parent element
report-definition
Child element
field-drilldown
report-drilldown
-
field-drilldown
Type
Description
Description
Specifies the target field for drilldown.
Specifiable value
None
Omissible
Yes (when the parameter is omitted, the target field for drilldown is not set)
Attribute
None
Parent element
drilldown
Child element
ref-field
-
ref-field
Type
Description
Description
Specifies the target field for drilldown.
Specifiable value
None. The field specified in the left-hand term of the conditional expression in expression that can be specified in the condition-expression child element is the field for drilldown report that is specified in the ref-report child element.
Omissible
Yes (when the parameter is omitted, the target field for drilldown is not set)
Attribute
id
Specify the field ID for the record specified in record. If the ref-field element is duplicated by specification of the same id, an error results. If you omit this attribute, you cannot specify condition-expression.
Parent element
field-drilldown
Child element
ref-report
condition-expression
-
report-drilldown
Type
Description
Description
Specifies the target report for drilldown.
Specifiable value
None
Omissible
Yes (when the parameter is omitted, the target report for drilldown is not set)
Attribute
None
Parent element
drilldown
Child element
ref-report
ref-bookmark
-
ref-report
Type
Description
Description
Specifies a single report definition.
Specifiable value
None
Omissible
Yes (when the parameter is omitted, the target report for drilldown is not set)
Attribute
pathname
Specify the directory path and report definition name in the format directory-path/report-definition-name. Specify the directory path sequentially from the root directory. If the directory name contains \ or /, specify it as \\ or \/, respectively. The directory path and report definition name can be specified with 1 to 64 characters (rather than 1 to 64 bytes) respectively. These items can have double-byte characters or single-byte characters, or both. Specifying a non-existent report definition or a report definition specified by report-definition results in an error. If the data model version number of report A is equal to or greater than the data model version number of report B, drilldown from report A to report B is available.
Parent element
ref-field
report-drilldown
Child element
None
-
ref-bookmark
Type
Description
Description
Specifies one bookmark or combination bookmark.
Specifiable value
None
Omissible
If this tag is omitted, report drilldown is not set.
Attribute
pathname
Specify a folder path and a bookmark name in folder-path/bookmark-name format. For folder-path, specify folder names starting from the root folder and delimit each folder name by using a forward slash (/). If a folder name contains \ or /, write \\ or \/, respectively.
- Example: Specifying CPU Trend in the My Bookmark folder under the root directory
-
/My Bookmark/CPU Trend
When multiple levels exist, specify a folder path by using folder names separated by / (for example, /Folder1/Folder2...).
The folder path and bookmark name can be specified with 1 to 64 characters (rather than 1 to 64 bytes) respectively. These items can have double-byte characters or single-byte characters, or both. If you specify a non-existing bookmark, an error occurs.
Note that the validity of the bookmark itself, such as the associated report definitions and agents, is not checked.
Parent element
report-drilldown
Child element
None
An example of a parameter file for a historical report is shown below.
Example of parameter file (for historical report)
<?xml version="1.0" encoding="UTF-8"?> <!-- Workload Status (Multi-Agent) report --> <!-- displays hourly workload-related data --> <!-- for multiple systems over the past 24 hours --> <!DOCTYPE pr-cli-parameters SYSTEM "rdef_create_params.dtd"> <pr-cli-parameters ver="0110"> <report-definitions> <report-definition name="Workload Status (Multi-Agent)" parent-folder="/HQ/Monthly/Windows/Operating System/Status Reporting/Daily Trend" read-only="FALSE"> <product-id>T3.0</product-id> <report-type type="historical-multiple-agents"/> <record id="PI"> <fields> <field table="true" list="false" graph="true">PROCESSES</field> <field table="true" list="false" graph="false">SERVER_SESSIONS</field> <field table="true" list="false" graph="false">CONTEXT_SWITCHES_PER_SEC</field> <field table="true" list="false" graph="false">SYSTEM_CALLS_PER_SEC</field> <field table="true" list="false" graph="false">PCT_TOTAL_PROCESSOR_TIME</field> <field table="true" list="false" graph="false">PROCESSOR_QUEUE_LENGTH</field> <field table="true" list="false" graph="false">BYTES_TOTAL_PER_SEC</field> </fields> </record> <indication-settings specify-when-displayed="false" maximum-number-of-records="1440"> <date-range>WITHIN_THE_PAST_24_HOURS</date-range> <report-interval>HOUR</report-interval> <peak-time/> </indication-settings> <view-type> <graph-properties show-areas-of-missing-data="false" series-direction="BY_COLUMN"> <graph-type>LINE</graph-type> <axis-labels> <x-axis/> <y-axis>Processes</y-axis> </axis-labels> <data-label> <data-label1>PROCESSES</data-label1> <data-label2/> </data-label> </graph-properties> </view-type> </report-definition> </report-definitions> </pr-cli-parameters> <!--End of definition for Workload Status (Multi-Agent) report-->
An example of a parameter file for a realtime report is shown below.
Example of parameter file (for realtime report)
<?xml version="1.0" encoding="UTF-8"?> <!-- CPU Usage - Top 10 Processes report --> <!-- displays top 10 processes in terms of CPU usage in real time--> <!DOCTYPE pr-cli-parameters SYSTEM "rdef_create_params.dtd"> <pr-cli-parameters ver="0110"> <report-definitions> <report-definition name="CPU Usage - Top 10 Processes" parent-folder="/HQ/Monthly/Windows/Operating System/Troubleshooting/Real-Time" read-only="FALSE"> <product-id>T3.0</product-id> <report-type type="realtime-single-agent"/> <record id="PD_PDI"> <fields> <field table="false" list="false" graph="false">INSTANCE</field> <field table="true" list="false" graph="false">ID_PROCESS</field> <field table="false" list="false" graph="true">PCT_PROCESSOR_TIME</field> </fields> </record> <realtime-indication-settings specify-when-displayed="false" indicate-delta-value="false"> <refresh-interval do-not-refresh-automatically="false" initial-value="30" minimum-value="10"/> <display-by-ranking field="PCT_PROCESSOR_TIME" display-number="10" in-descending-order="false"/> </realtime-indication-settings> <view-type> <graph-properties show-areas-of-missing-data="false" series-direction="BY_COLUMN"> <graph-type>BAR</graph-type> <axis-labels> <x-axis>Program(PID)</x-axis> <y-axis>CPU %</y-axis> </axis-labels> <data-label> <data-label1>INSTANCE</data-label1> <data-label2>ID_PROCESS</data-label2> </data-label> </graph-properties> </view-type> </report-definition> </report-definitions> </pr-cli-parameters> <!--End of definition for CPU Usage - Top 10 Processes report -->
Notes
-
The command requires authentication for PFM - Manager during execution. If a key file for authentication has not been created prior to command execution, use the jpcmkkey command to create the key file for authentication.
-
If an exception occurs while multiple report definitions are being registered, the command cancels registration of that definition and registers the next definition, if any.
-
Only two elements can be specified under the <and> and <or> tags in the <condition-expression> tag.
The following shows a specification example:
<and> <expression>expression-1</expression> <or> <expression>expression-2</expression> <or> <expression>expression-3</expression> <or> <expression>expression-4</expression> <expression>expression-5</expression> </or> </or> </or> </and>
The following shows an example of the expression specified in the <expression> tag:
<expression>SEGMENTS_RETRANSMITTED_PER_SEC>"100"</expression> <expression>RECORD_TIME>"2003 05 31 11:22:33"</expression>
-
For details about the record, field name, and data type of fields that can be defined, see the PFM - Agent or PFM - RM manuals.
-
For the parameters for which values are not specified, the command uses the default values to create the report definition. To check all the parameters in a created report definition, execute the output command with the created parameter file specified.
-
The limitations shown in the following table apply to the combinations of parameters:
Table 3‒30: Specifiable combinations of parameters (for historical reports) Report type
Record type
Data type of field
Peak time
Field display format
Table
List
Graph
display-key
Historical (single agent) report
Single-instance
string
N
Y
Y
N
Y
char
N
Y
Y
N
Y
time_t
N
Y
Y
N
Y
timeval
N
Y
Y
Y
Y
utime
N
Y
Y
Y
Y
float
Y
Y
Y
Y
Y
ulong
Y
Y
Y
Y
Y
short
Y
Y
Y
Y
Y
double
Y
Y
Y
Y
Y
long
Y
Y
Y
Y
Y
Multi-instance
string
N
Y
Y
N
Y
char
N
Y
Y
N
Y
time_t
N
Y
Y
N
Y
timeval
N
Y
Y
Y
Y
utime
N
Y
Y
Y
Y
float
N
Y
Y
Y
Y
ulong
N
Y
Y
Y
Y
short
N
Y
Y
Y
Y
double
N
Y
Y
Y
Y
long
N
Y
Y
Y
Y
Historical (multiple agents) report
Single-instance
string
N
Y
Y
N
N
char
N
Y
Y
N
N
time_t
N
Y
Y
N
N
timeval
N
Y
Y
Y
N
utime
N
Y
Y
Y
N
float
Y
Y
Y
Y
N
ulong
Y
Y
Y
Y
N
short
Y
Y
Y
Y
N
double
Y
Y
Y
Y
N
long
Y
Y
Y
Y
N
Table 3‒31: Specifiable combinations of parameters (for realtime reports) Report type
Record type
Data type of field
Display by ranking
Field display format
Table
List
Graph
display-key
Realtime (single agent) report
Single-instance
string
N
Y
Y
N
Y
char(n)
N
Y
Y
N
Y
time_t
N
Y
Y
N
Y
timeval
N
Y
Y
Y
Y
utime
N
Y
Y
Y
Y
float
N
Y
Y
Y
Y
ulong
N
Y
Y
Y
Y
short
N
Y
Y
Y
Y
double
N
Y
Y
Y
Y
long
N
Y
Y
Y
Y
Multi-instance
string
N
Y
Y
N
Y
char(n)
N
Y
Y
N
Y
time_t
N
Y
Y
N
Y
timeval
Y
Y
Y
Y
Y
utime
Y
Y
Y
Y
Y
float
Y
Y
Y
Y
Y
ulong
Y
Y
Y
Y
Y
short
Y
Y
Y
Y
Y
double
Y
Y
Y
Y
Y
long
Y
Y
Y
Y
Y
-
The report types include historical (single agent) report and historical (multiple agents) report. The record attributes supported by reports include single-instance and multi-instance. Note that historical (multiple agents) report supports only the single-instance record attribute.
If LINE, AREA, or STACKED_AREA is specified in graph-type, instance and fields cannot both be specified at the same time. The following table shows the combinations of record attribute and field that can be specified for the report:
Table 3‒32: Combinations of record attribute and fields that can be specified for reports Report type
Record attribute
Single field
Multiple fields
Historical (single agent) report
Single-instance
Y
Y
Multi-instance
Y
N
Historical (multiple agents) report
Single-instance
Y
N
Realtime (single agent) report
Single-instance
Y
Y
Multi-instance
Y
N
-
When display-key is specified, specifying LINE, AREA, or STACKED_AREA in graph-type results in an error.
-
The following table shows the filter setting conditions for fields of time_t type:
Table 3‒33: Filter setting conditions set in record specify-when-displayed setting
Conditional expression right-hand term
Field of time_t type other than Date or Time fields
Date field in time_t type
Time field in time_t type
TRUE
Value
Y
Y
Y
Omitted
Y
Y
Y
FALSE
Value
N
N
Y
Omitted
N
N
N
Table 3‒34: Filter setting conditions set in ref-field specify-when-displayed setting
Conditional expression right-hand term
Field of time_t type other than Date or Time fields
Date field in time_t type
Time field in time_t type
TRUE
Field ID
N
N
N
Value
N
N
Y
Omitted
Y
Y
Y
FALSE
Field ID
Y
Y
Y
Value
N
N
Y
Omitted
N
N
N
-
Delta values in a realtime report depend on the fields of each record that is collected by PFM - Agent or PFM - RM. For details about whether or not delta values are to be collected in the record fields, see the chapter in the PFM - Agent or PFM - RM manuals that describes the records (list of fields in each record).
The table below describes the display conditions for delta values in realtime reports and the values that are displayed. With some PFM - Agents or PFM - RM, the information provided in the table might not be applicable. For details, see the PFM - Agent or PFM - RM manuals.
Table 3‒35: Delta values in realtime reports and display conditions indicate-delta-value attribute of realtime-indication-settings
Delta value for a field
Value that is displayed
TRUE
Yes
Amount of change from the previously collected performance data to the currently collected performance data
No
Newest collected value
FALSE
Yes
Accumulated value since the collection of performance data started
No
Newest collected value
The following table lists the fields that cannot be specified in realtime reports:
Name in PFM - Web Console |
Manager name |
Description |
---|---|---|
Agent Host |
DEVICEID |
instance-name[host-name] or host name |
Agent Instance |
PROD_INST |
Agent's instance name |
Agent Type |
PROD_ID |
Agent's product ID (1-byte identifier) |
Date |
DATE |
Record creation date (Greenwich Mean Time) |
Date and Time |
DATETIME |
Combination of Date and Time |
Drawer Type |
DRAWER_TYPE |
Summation type in PI database |
GMT Offset |
GMD_ADJUST |
Difference between Greenwich Mean Time and local time (seconds) |
Time |
TIME |
Record creation time (Greenwich Mean Time) |
xxxx (Total) |
xxxx_TOTAL |
Total value obtained during data summing for PI records |
xxxx_TOTAL_SEC(Total) |
xxxx_TOTAL_SEC |
Total value in the data summing period |
xxxx_HI (Max) |
xxxx_HI |
Maximum value in the data summing period |
xxxx_LO (Min) |
xxxx_LO |
Minimum value in the data summing period |
xxxx_OV (OV) |
xxxx_OV |
Number of times overflow occurred in the calculation of total value during the data summing period |
-
Normally, you do not need to set the -mx or -ms option. If the KAVJK0401-E message, which reports insufficient memory, is output during command execution, re-execute the command with the -mx option to increase the maximum heap size. At this time, make sure that you specify 64 or a greater value for the -mx option.
-
For drilldown reports, you can specify only report definitions that have already been created before you execute the command. An attempt to specify new report definitions for drilldown reports will fail with a KAVJK0125-E message.
-
When performing multiple monitoring, you cannot execute this command from the PFM - Web Console host that is connected to the secondary PFM - Manager host.
-
When you use the jpcrdef create command to register a report, the report itself cannot be specified in the <ref-report> tag.
Return values
0 |
The command ended normally. |
1 |
The command line format is invalid. |
2 |
The user does not have execution permission for the command. |
3 |
Creation of the output file failed. |
5 |
The parameters cannot be analyzed because they do not match the DTD file. |
10 |
Creation of at least one report definition failed. |
11 |
Authentication processing for logging into PFM - Manager failed. |
12 |
An attempt was made to execute the command from the PFM - Web Console host that is connected to the secondary PFM - Manager host when multiple monitoring is performed. |
100 |
The environment is invalid. |
200 |
A memory error occurred. |
202 |
A file access error occurred. |
222 |
A communication processing error occurred. |
255 |
An unexpected error occurred. |
Usage example
This example registers a new parameter file (rdef_create.xml) that contains report definitions:
jpcrdef create rdef_create.xml
Output example
This example outputs the details of the command's processing to the standard output, standard error output, and trace log file. For details about the log specifications, see Chapter 6. Log Information Output by Performance Management.
An example is shown below of the standard output when three report definitions were specified and one of them resulted in an error.
Example of standard output
jpcrdef create connected to vserv01 at 2006 03 20 15:00:55.282 create result OK : report-definition-directory-path-1/report-definition-name-1 create result OK : report-definition-directory-path-2/report-definition-name-2 create result ERR : report-definition-directory-path-3/report-definition-name-3 Cause of error jpcrdef create disconnected at 2006 03 20 15:01:06.2