Represents the category and subcategories that form a unified health
profile in the Unified Health Scoring feature.
Where possible, we changed noninclusive terms to align with our
company value of Equality. We maintained certain terms to avoid any effect on
customer implementations.
Parent Type
This type extends the Metadata metadata type and inherits its fullName
field.
File Suffix and Directory Location
ScoreCategory components have the suffix .scoreCategory and are stored in the scoreCategories folder.
Version
ScoreCategory components are available in API version 55.0 and later.
Special Access Rules
Field
| categoryName |
- Field Type
- string
- Description
-
Required.
The name of the score category.
|
| description |
- Field Type
- string
- Description
-
Required.
The description of the score category.
|
| developerName |
- Field Type
- string
- Description
-
Required.
This name can contain only underscores and
alphanumeric characters, and must be unique in your
org. It must begin with a letter, not include
spaces, not end with an underscore, and not contain
two consecutive underscores. This unique name
prevents conflicts with rules from other packages
that have the same masterLabel.
|
| iconUrl |
- Field Type
- string
- Description
-
Required.
- The URL for the image used as the icon of the score category.
|
| masterLabel |
- Field Type
- string
- Description
-
Required.
The user interface label of the score category
record.
|
| parentCategoryId |
- Field Type
- string
- Description
- The score category that the category is a part of. Do not use this field for top-level
categories that represent unified health profiles.
|
| scoreCategoryCalcInsights |
- Field Type
- ScoreCategoryCalcInsight[]
- Description
- Maps the score category to its calculated insight in Data Cloud.
|
| scoreRangeClassifications |
- Field Type
- ScoreRangeClassification[]
- Description
- Specifies the different score ranges and their classifications for the score
category.
|
ScoreCategoryCalcInsight
Maps the score category to its calculated insight in Data Cloud. Use this subtype type only if
you’re using Data Cloud to calculate scores for Unified Health Scoring.
| insightDateFieldName |
- Field Type
- string
- Description
-
Required.
The API name of the date field in the calculated
insight that specifies when the last calculation was
processed.
|
| insightName |
- Field Type
- string
- Description
-
Required.
The API name of the calculated insight that derives
scores for the category.
|
| insightScoreFieldName |
- Field Type
- string
- Description
-
Required.
The API name of the field in the calculated insight
that specifies the derived scores. This field is the
field that’s defined as the measure of the
calculated insight.
|
| insightSubjectFieldName |
- Field Type
- string
- Description
-
Required.
The API name of the field in the calculated insight
that references the subject of the score. The
referenced subject is either an account, lead, or
contact. This field is the field that’s defined as
the dimension of the calculated insight.
|
ScoreRangeClassification
Represents the score ranges of a score category and how scores in those ranges are
interpreted.
| classificationName |
- Field Type
- string
- Description
-
Required.
The interpretation or classification of scores in the
specified range.
Example: Good, Great, Excellent
|
| colorHexadecimalCode |
- Field Type
- string
- Description
-
Required.
The hexadecimal code for the color that represents
the range and its interpretation.
Be mindful of cultural differences
when you choose a color code. Different colors
mean different things in different
cultures.
|
| rangeEndValue |
- Field Type
- double
- Description
-
Required.
The end point of a score range classification.
|
| rangeStartValue |
- Field Type
- double
- Description
-
Required.
The start point of a score range classification.
|
Declarative Metadata Sample Definition
The following is an example of a ScoreCategory component.
1<?xml version="1.0" encoding="UTF-8"?>
2<ScoreCategory
3 xmlns="http://soap.sforce.com/2006/04/metadata">
4 <categoryName>Environmental Score 2</categoryName>
5 <description>This is second Environmental score for a person</description>
6 <developerName>env_score2</developerName>
7 <iconUrl>https://duckduckgo.com/assets/logo_header.dddv108.svg</iconUrl>
8 <masterLabel>Env Score 2</masterLabel>
9</ScoreCategory>
The following is an example package.xml that
references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
2<Package
3 xmlns="http://soap.sforce.com/2006/04/metadata">
4 <types>
5 <members>*</members>
6 <name>ScoreCategory</name>
7 </types>
8 <version>55.0</version>
9</Package>
Wildcard Support in the Manifest File
This metadata type supports the wildcard character *
(asterisk) in the package.xml manifest file. For information
about using the manifest file, see Deploying and Retrieving Metadata with the Zip
File.
j