---
schema_version: "1"
id: ba44de4c4e3b0532bb9a474744eed15d2dfaacbeb6e180dbf52b1897c73203f4
title: Icon
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/financial_services_cloud_object_reference/fsc_meta_icon.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/fsc_meta_icon.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 48b6918c3b32a7ef903920b118b137ea8fd63f2cfdac39b285680ce56dc7a497
description: Represents the mapping of custom icons to objects.
---
# Icon

Represents the mapping of custom icons to objects.

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.262.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field.

## File Suffix and Directory Location

Icon components have the suffix .icon and are stored in the icons folder.

## Version

Icon components are available in API version 49.0 and later.

## Special Access Rules

To use this metadata type, your Salesforce org must have the Health Cloud or Financial Services Cloud license.

## Fields

### image

- **Field Type**: string
- **Description**: Required. The image file that is mapped to the object. Use the [ContentAsset](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_contentasset.htm "HTML (New Window)") metadata type to hold the icon image referenced in the image field.

### key

- **Field Type**: string
- **Description**: Required. A field value in the object. For example, with the PersonLifeEventobject, possible values for key can be birthday, marriage, childbirth, and so on.

### usageType

- **Field Type**: IconUsageType (enumeration of type string)
- **Description**: Required. The object that is mapped to the image.
- **Possible values**:
    - PersonLifeEvent
    - InsurancePolicy
    - BusinessMilestone
    - AssetMilestone
    - FinancialAccountMilestone

## Declarative Metadata Sample Definition

The following is an example of an Icon component.

<?xml version="1.0" encoding="UTF-8"?>
<Icon xmlns="http://soap.sforce.com/2006/04/metadata">
    <usageType\>PersonLifeEvent</usageType\>
    <key\>Birth</key\>
    <image\>image</image\>
</Icon\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>icons</members\>
        <name\>Icon</name\>
    </types\>
    <version\>49.0</version\>
</Package\>