kpi

This topic is part of the publisheddashboard SDF custom object documentation.

For information about developing publisheddashboard SDF custom objects, see Published Dashboards as XML Definitions.

The kpi field group is a DEFAULT.

Fields

Name	Type	Required / Optional	Description
kpi	single-select list	Required	For information about possible values, see the following lists: snapshot_type_period_range_not_comparable snapshot_type_period_range_comparable snapshot_type_date_range_not_comparable snapshot_type_date_range_comparable snapshot_type_custom
daterange	single-select list	Required	For information about possible values, see report_date_range.
comparedaterange	single-select list	Required (conditionally)	This field is available when the kpi value is present in any of the following lists or values: snapshot_type_date_range_comparable, snapshot_type_period_range_comparable, snapshot_type_custom. This field is mandatory when the kpi value is present in any of the following lists or values: snapshot_type_date_range_comparable, snapshot_type_period_range_comparable, snapshot_type_custom. This field is mandatory when the compare value is equal to T. For information about possible values, see report_date_range.
compareperiodrange	single-select list	Required (conditionally)	This field is available when the kpi value is present in any of the following lists or values: snapshot_type_period_range_comparable, snapshot_type_custom. This field is mandatory when the kpi value is present in any of the following lists or values: snapshot_type_period_range_comparable, snapshot_type_custom. This field is mandatory when the compare value is equal to T. For information about possible values, see report_period_range.
savedsearch	single-select list	Required (conditionally)	This field is available when the kpi value is present in snapshot_type_custom. This field is mandatory when the kpi value is present in snapshot_type_custom. This field accepts references to the savedsearch custom type.
periodrange	single-select list	Required (conditionally)	This field is available when the kpi value is present in any of the following lists or values: snapshot_type_period_range_comparable, snapshot_type_period_range_not_comparable, snapshot_type_custom. This field is mandatory when the kpi value is present in any of the following lists or values: snapshot_type_period_range_comparable, snapshot_type_period_range_not_comparable, snapshot_type_custom. For information about possible values, see report_period_range.
compare	boolean	Required (conditionally)	This field is available when the kpi value is present in any of the following lists or values: snapshot_type_date_range_comparable, snapshot_type_period_range_comparable, snapshot_type_custom. This field is mandatory when the kpi value is present in any of the following lists or values: snapshot_type_date_range_comparable, snapshot_type_period_range_comparable, snapshot_type_custom. The default value is T.
employees	single-select list	Optional	This field is available when the center value is equal to any of the following lists or values: SALESCENTER, SUPPORTCENTER. For information about possible values, see portlet_kpi_employees. The default value is 'ME_ONLY'.
headline	boolean	Optional	The default value is F.
highlightif	single-select list	Optional	For information about possible values, see portlet_kpi_highlightif.
threshold	float Float field types must be set to a valid IEEE 754 standard floating point value.	Optional

General Notices