HouseholdNamingConfig | Education Cloud Developer Guide

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.

Important

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules

This object is available only if the Automatic Household Creation and Naming add-on license is enabled.

Fields

Field	Details
Description	Type textarea Properties Create, Filter, Group, Sort, Update Description The description of the household naming pattern formula and how it's used.
DeveloperName	Type string Properties Create, Filter, Group, Sort, Update Description The unique name of the HouseholdNamingConfig.
ExclusionFormula	Type textarea Properties Create, Nillable, Update Description The optional formula that defines which household members to exclude from household naming. For example: `{AccountContactRelation.ExcludeForCustomGreeting1__c} == TRUE`
HshldAcctDestFldApiName	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update, Unique Description Specifies the API name of the mapped Account destination field, such as `Account.Name` or `Account.MyCustomGreeting1__c`. This restricted picklist includes the Account Name field and custom Account text fields that are at least 80 characters and aren't formula fields. Multiple Household Naming Configuration records can’t point to the same destination field. Point each Household Naming Configuration record to a unique Account destination field API name.
IsActive	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether Household Automatic Naming Configuration is active (`true`) or not (`false`). The default value is `true`.
MasterLabel	Type string Properties Create, Filter, Group, Sort, Update Description The label of the HouseholdNamingConfig record. A user-friendly name for HouseholdNamingConfig, which is defined when HouseholdNamingConfig is created.
MaximumMemberCount	Type int Properties Create, Defaulted on create, Filter, Group, Sort, Update Description This required field specifies the number of household members to include in the greeting. After the specified number, the member limit suffix is used. Valid values are from 1 through 9. The default value is 2.
MemberLimitSuffix	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The text string to use when the maximum member count is reached to replace the remaining names. For example, Family.
NameConjunction	Type string Properties Create, Filter, Group, Sort, Update Description The text string to use to connect pairs of names. For example, `&`, or `and`.
NamePatternFormula	Type textarea Properties Create, Update Description The formula that defines how a household's name is formatted based on the members of the household. For example, `{each:Salutation} {FirstName} {LastName} Family`

Usage

Use this object to define how Salesforce formats household names and greetings from household members. Each active configuration maps a naming formula to a destination field on Account. When household membership changes, Salesforce recalculates the destination field using the active configurations.