Second-Generation Managed Packaging Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
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
How Does AppExchange App Analytics Data Flow?
How Should I Plan My App Analytics Query Strategy?
Recommendations
Small-Sized Partners
Medium-Sized Partners
Large-Sized Partners
Where Do I Go for More Information About AppExchange App Analytics Queries?
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

Large-Sized Partners

Large partners have large subscriber bases and many managed packages. A large partner’s total daily data usage is more than 20 GB. Sometimes a large partner’s data from just one managed package is larger than the 20-GB daily limit. Also, large partners often must create a smaller time range for each query to complete in under the 15-minute processing time limit.
Available in: both Salesforce Classic and Lightning Experience
Available in: Enterprise, Performance, Unlimited, and Developer Editions

Large partners frequently create one query per managed package per 12, 6, or 1-hour increments throughout a 24-hour period. How frequently you schedule your queries really depends on your data volume.

We recommend that you use a combination of queries and multiple catch-up queries for all data types

Data Type How to Get Started How to Schedule Catch-Up Queries
Subscriber Snapshots One daily query per package.
  • One daily query per package.
  • Set AvailableSince to the day and time your last regular query ran.
  • Set StartTime to 30 days ago.
  • Omit EndTime.
  • Each day advance StartTime and AvailableSince by 1 day.
Package Usage Summaries One daily query per package.
  • One daily catch-up query per package.
  • Set AvailableSince to the day and time your last regular query ran.
  • Set StartTime to the first of the previous month.
  • Omit EndTime.
  • Each day advance AvailableSince by 1 day.
  • Each month advance StartTime to the first of the previous month.
Package Usage Logs
  • To retrieve all your data, create multiple segmented daily, automated App Analytics queries spread throughout the day.
  • Break up your requests by managed package and by time increments throughout the day.
 Create two levels of catch-up queries per day.
  • Create one catch-up query per package that sweeps data from 2 days ago.
  • Create a second catch-up query that sweeps data from 3 to 30 days ago.
  • Each day advance StartTime, EndTime, and AvailableSince by 1 day.

Example

Your customers use your package on all Salesforce instances around the world, and your managed packages produce significant amounts of data. You schedule queries to run at the same time, each covering a 12-hour period, and you create a layered catch-up query plan to capture data from all instances.

In this example, we show two of your dozens of managed packages.

  • On March 31 at 18:00 UTC, run your regular package usage log queries.

    Package 1

    sf data create record data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-30T00:00:00
EndTime=2021-03-30T12:00:00
DataType=PackageUsageLog
PackageIds=0336XXXXXXXXXX 
FileType=parquet
FileCompression=snappy"
    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-30T12:00:00
EndTime=2021-03-31T00:00:00
DataType=PackageUsageLog
PackageIds=0336XXXXXXXXXX
FileType=parquet
FileCompression=snappy"

    Package 2

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-30T00:00:00
EndTime=2021-03-30T12:00:00
DataType=PackageUsageLog
PackageIds=0337XXXXXXXXXX
FileType=parquet
FileCompression=snappy"
    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-30T12:00:00
EndTime=2021-03-31T00:00:00
DataType=PackageUsageLog
PackageIds=0337XXXXXXXXXX
FileType=parquet
FileCompression=snappy"
  • On April 1 at 18:00 UTC, run your regular and catch-up package usage log queries.

    Package log file regular and catch-up queries timeline on April 1.

    A. Package Usage Log Regular Queries

    Package 1

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-31T00:00:00Z
EndTime=2021-03-31T12:00:00Z
DataType=PackageUsageLog
PackageIds=0336XXXXXXXXXX 
FileType=parquet
FileCompression=snappy"
    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-31T12:00:00Z
EndTime=2021-04-01T00:00:00Z
DataType=PackageUsageLog
PackageIds=0336XXXXXXXXXX
FileType=parquet
FileCompression=snappy"

    Package 2

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-31T00:00:00Z
EndTime=2021-03-31T12:00:00Z
DataType=PackageUsageLog
PackageIds=0337XXXXXXXXXX
FileType=parquet
FileCompression=snappy"
    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-31T12:00:00Z
EndTime=2021-04-01T00:00:00Z
DataType=PackageUsageLog
PackageIds=0337XXXXXXXXXX
FileType=parquet
FileCompression=snappy"

    B. Package Usage Log 2 Days Ago Catch-Up Queries

    Package 1

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-30T00:00:00Z
EndTime=2021-03-31T00:00:00Z
DataType=PackageUsageLog
PackageIds=0336XXXXXXXXXX
FileType=parquet
FileCompression=snappy
AvailableSince=2020-03-31T18:00:00Z"

    Package 2

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-30T00:00:00Z
EndTime=2021-03-31T00:00:00Z
DataType=PackageUsageLog
PackageIds=0337XXXXXXXXXX
FileType=parquet
FileCompression=snappy
AvailableSince=2020-03-31T18:00:00Z"

    C. Package Usage Log From 3 to 30 Days Ago Catch-Up Queries

    Package 1

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-01T00:00:00Z
EndTime=2021-03-30T00:00:00Z
DataType=PackageUsageLog
PackageIds=0336XXXXXXXXXX
FileType=parquet
FileCompression=snappy
AvailableSince=2020-03-31T18:00:00Z"

    Package 2

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-01T00:00:00Z
EndTime=2021-03-30T00:00:00Z
DataType=PackageUsageLog
PackageIds=0337XXXXXXXXXX
FileType=parquet
FileCompression=snappy
AvailableSince=2020-03-31T18:00:00Z"
  • On April 2 onwards, run your regular and your catch-up package usage log queries, advancing the dates by 1 day.

    Package log file regular and catch-up queries timeline on April 2.

    A. Package Usage Log Regular Queries

    Package 1

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-04-01T00:00:00Z
EndTime=2021-04-01T12:00:00Z
DataType=PackageUsageLog
PackageIds=0336XXXXXXXXXX 
FileType=parquet
FileCompression=snappy"
    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-04-01T12:00:00Z
EndTime=2021-04-02T00:00:00Z
DataType=PackageUsageLog
PackageIds=0336XXXXXXXXXX
FileType=parquet
FileCompression=snappy"

    Package 2

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-04-01T00:00:00Z
EndTime=2021-04-01T12:00:00Z
DataType=PackageUsageLog
PackageIds=0337XXXXXXXXXX
FileType=parquet
FileCompression=snappy"
    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-04-01T12:00:00Z
EndTime=2021-04-02T00:00:00Z 
DataType=PackageUsageLog
PackageIds=0337XXXXXXXXXX
FileType=parquet
FileCompression=snappy"

    B. Package Usage Log 2 Days Ago Catch-Up Queries

    Package 1

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-31T00:00:00Z
EndTime=2021-04-01T00:00:00Z
DataType=PackageUsageLog
PackageIds=0336XXXXXXXXXX
FileType=parquet
FileCompression=snappy
AvailableSince=2020-04-01T18:00:00Z”

    Package 2

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-31T00:00:00Z
EndTime=2021-04-01T00:00:00Z
DataType=PackageUsageLog
PackageIds=0337XXXXXXXXXX
FileType=parquet
FileCompression=snappy
AvailableSince=2020-04-01T18:00:00Z"

    C. Package Usage Log From 3 to 30 Days Ago Catch-Up Queries

    Package 1

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-02T00:00:00Z
EndTime=2021-03-31T00:00:00Z
DataType=PackageUsageLog
PackageIds=0336XXXXXXXXXX
FileType=parquet
FileCompression=snappy
AvailableSince=2020-04-01T18:00:00Z"

    Package 2

    sf data create record
--sobjecttype AppAnalyticsQueryRequest
--values "StartTime=2021-03-02T00:00:00Z
EndTime=2021-03-31T00:00:00Z
DataType=PackageUsageLog
PackageIds=0337XXXXXXXXXX
FileType=parquet
FileCompression=snappy
AvailableSince=2020-04-01T18:00:00Z"