On Load

Overview

The On Load interaction allows you to perform actions automatically before displaying your Avonni Dynamic Component on the page. This is your opportunity to fetch initial data, run setup logic, and prepare variables your component will use immediately upon rendering. It's triggered only once when the component initially loads.

Common uses include:

• Pre-populating Variables: Loading data into Variable resources (e.g., Record Variables, Text Variables) from Salesforce or via calculations.

• Running Initialization Logic: Executing an autolaunched Flow to perform complex setup tasks before the UI is visible.

• Setting Initial Component States: Using fetched or calculated data to determine the initial configuration or appearance of components (e.g., setting default values, controlling visibility based on loaded data).

When to Use the On Load Interaction

While setting the Target Object API Name makes the current record's data available via $Component.record on record pages, the On Load interaction provides distinct value in specific scenarios:

• Fetching Related Records: Retrieve records related to the current record (e.g., getting the parent Account details when the component is on a Contact page). $Component.record only holds the current record's data.

• Fetching Specific, Unrelated Records: Load data from a particular configuration record (like Custom Metadata) or any record not directly tied to the page context.

• Executing Complex Logic/Calculations: Use Execute Flow to perform calculations, aggregations (like counting related records), or logic involving multiple objects before displaying the results.

• Loading Configuration Settings: Use Execute Flow to retrieve configuration values from Custom Settings or Custom Metadata Types to control component behavior.

Available Actions

The On Load interaction supports two main actions:

• Execute Flow: Runs an autolaunched Salesforce Flow. Ideal for complex logic, calculations, aggregations, or fetching configuration data.

• Get Records: This function retrieves a single Salesforce record based on its ID. It is best for fetching a specific related or known configuration record.

Configuration

Select the Component: In the Component Builder, select the Dynamic Component itself (the top-level item in the structure panel).

Add the Interaction: Find the "Interactions" section in the Properties Panel. Click to add an action to the "On Load" event.

Choose Action Type: Select either Execute Flow or Get Records.

Execute Flow Configuration

• Flow API Name: Select the API name of your autolaunched Flow.

• Flow Input Variables (Optional): Map values (static, URL parameters like @recordId, or existing resources) to the Flow's input variables.

• Output Variables (Optional): Map the Flow's output variables to Variable resources in your Dynamic Component to store the results.

Get Records Configuration

• Record Variable: Select a pre-defined Record Variable resource (of the correct object type) to store the fetched record data.

• Object API Name: Select the Salesforce object to retrieve from.

• Record ID: Specify the ID of the record to fetch. Common sources:

  • URL Parameter: @recordId (for the current record on a record page).

  • Related ID from $Component.record : like $Component.record.AccountId.

  • A Constant or Variable resource holding an ID.

• Fields: Select the specific fields you want to retrieve for this record.

Important Considerations

• Autolaunched Flows Only: Execute Flow requires an autolaunched Flow.

• Record ID Source: Ensure you provide a valid Record ID for Get Records (often @recordId or a related ID like $Component.record.AccountId).

• One-Time Execution: On Load runs only once before rendering.

• Performance: Avoid overly complex or slow operations in On Load actions, as they delay initial component visibility.

• Error Handling: Implement error handling within your Flows if needed.

In Summary

The On Load interaction is the primary way to initialize data and variables in your component before it displays. Use Get Records for fetching specific related records and Execute Flow for calculations, aggregations, or more complex setup logic.