Last updated
Was this helpful?
The Target Page Object (set in the Component Builder's Settings) is a fundamental setting for your Avonni Dynamic Component. It establishes the primary Salesforce object that your component will interact with (e.g., Account, Contact, Opportunity, My_Custom_Object__c). Think of it as providing the context for your component's data and operations.
Field Access: Setting the Target Page Object populates the Fields tab in the Component Library with the fields from the selected object. This allows you to drag and drop those fields to create data-bound components easily.
$Component.record (Record Pages): On record pages, the Target Page Object is crucial. It enables the $Component.record global variable, which gives you direct access to the current record's data. For example:
$Component.record.Id: The ID of the current record.
$Component.record.Name: The Name field of the current record.
And so on for all fields on the object.
Related Data: The Target Page Object, combined with $Component.record.Id, is essential for displaying data related to the current record. For example, on an Account page, you can show a list of related Contacts by filtering a Data Table's query based on $Component.record.Id.
Record Detail Pages: You'll almost always set the Target Object API Name when building components for record pages. This is how you access the current record's data.
Related Lists/Data: Whenever you need to display or interact with data that's related to a specific record, the Target Object API Name (and $Component.record.Id) provides the necessary context.
Master-Detail Relationships: When creating master-detail relationships between components, the Target Object API Name helps establish the connection (e.g., Contacts related to an Account, Opportunities related to an Account, Cases related to a Contact).
Standalone Components (No Record Context): If your component is entirely independent of any specific record and doesn't need to access record data directly (e.g., a simple calculator, a static navigation menu, or a component on an App Page that doesn't relate to a specific record), you might not need to set the Target Object API Name. In these cases, you would likely use other data sources (e.g., a Query that retrieves data without reference to a record ID).
Using Variables Only: If you are fetching your record information using a variable (using a Get Record on load for example)
In essence, the Target Object API Name provides the context for your Dynamic Component, telling it which Salesforce object to work with and, on record pages, which specific record to use as its primary data source.
