Second-Generation Managed Packaging Developer Guide

Second-Generation Managed Packages
What’s a Second-Generation Managed Package?
Set Up Your Development Environment
Before You Create Second-Generation Managed Packages
Scratch Orgs and Package Development
Workflow for Second-Generation Managed Packages
Components Available in Second-Generation Managed Packages
Behavior of Specific Metadata in Second-Generation Managed Packages
Develop Second-Generation Managed Packages
Install and Uninstall Second-Generation Managed Packages
Prepare to Distribute Your Second-Generation Managed Package
Push a Package Upgrade for Second-Generation Managed Packages
Advanced Features for Second-Generation Managed Packages
Best Practices for Second-Generation Managed Packages
Manage Licenses for Managed Packages
Manage Features in Second-Generation Managed Packages
Get Started with AppExchange App Analytics
App Analytics Use Cases
Enable App Analytics on Your Second-Generation Managed Package
Download Package Usage Logs, Package Usage Summaries, and Subscriber Snapshots
Considerations for Custom Interactions
AppExchange App Analytics Best Practices
Package Usage Summaries
Package Usage Logs
Subscriber Snapshots
Test Custom Integrations
AppExchange App Analytics Developer Cookbook
Gaps Between First-Generation and Second-Generation Managed Packaging
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Considerations for Custom Interactions

Easily create and log custom interactions on your managed package using Apex. As subscribers interact with your package and your Apex code is executed, the custom interactions that you defined are logged. Retrieve your custom interactions in your package's AppExchange App Analytics usage logs and usage summaries.
Available in: both Salesforce Classic and Lightning Experience
Available in: Enterprise, Performance, Unlimited, and Developer Editions

As an ISV partner, the complex features that you develop in your managed packages could involve multiple actions on different objects, callouts to Apex functions, and much more. It can be difficult to interpret how your subscribers interacted with specific packaged components via your downloaded App Analytics package usage logs and summaries.

To provide you with more clarity about your subscribers’ events in custom ways and at different granularity levels, create custom interactions in your managed packages using Apex.

With Apex custom interactions, you can discover:

  • Which app feature a user interacted with
  • How users flowed through a specific user journey
  • Which UI components a user interacted with

Keep these considerations in mind:

  • A custom interaction can appear for a given user request up to 50 times. This limit avoids flooding the logs due to large loops.
  • We recommend that you don’t call IsvPartners.AppAnalytics.logCustomInteraction from inside a loop.
  • If the IsvPartners.AppAnalytics.logCustomInteraction method is called from a running Apex test, no AppExchange App Analytics package usage log or package usage summary data is produced.

Log Custom Interactions

Create and log custom interactions with your managed package using Apex.
  1. In your packaged Apex code, include Apex enums that are associated with the events that you want to log as custom interactions.
  2. In your Apex code, invoke IsvPartners.AppAnalytics.logCustomInteraction, using the enums that you created.
  3. Test your code by running it in your development environment and checking your debug logs to be certain that the custom interactions you created are being logged. Ensure that your debug log levels for Apex Code are set to FINE.
  4. After you’re finished with your implementation, publish a new version of your managed package.
  5. After subscribers install your package, retrieve your package usage logs and package usage summaries. Filter your package usage log data on custom_entity_type by CustomInteractionLabel, and on log_record_type by CustomInteraction. Or filter your package usage summary data on custom_entity_type by CustomInteractionLabel.
  6. Analyze your custom interaction data.

Example

Let’s suppose you have a Lightning Web Component (LWC). Your LWC provides a list of related contacts for each Account record, uses a table layout, and is wired to an Apex class. You add a new card layout to your LWC. To track how well users are adopting this new layout, you log an interaction when a user switches between layouts.

An example Lightning Web Component in table format showing these columns: Name, Title, Email, and Phone, plus Table and Card buttons

In your code, include Apex enums and invoke IsvPartners.AppAnalytics.logCustomInteraction.

Your LWC HTML code:

Your LWC JavaScript code:

Your Apex class:

Next, you test your code. With your Apex code debug log level set to FINE, confirm that the custom interactions are logged by finding events in your debug logs called APP_ANALYTICS_FINE, APP_ANALYTICS_WARN, or APP_ANALYTICS_ERROR.