Skip to content

Commit 755d4cd

Browse files
authored
Initial release (#1)
* Initial commit of custom objects, layouts, flexipages, console app, permission sets, and Apex schedulable batch job
1 parent f5e9d0b commit 755d4cd

File tree

76 files changed

+3594
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+3594
-0
lines changed

.forceignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# List files or directories below to ignore them when running force:source:push, force:source:pull, and force:source:status
2+
# More information: https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_exclude_source.htm
3+
#
4+
5+
package.xml
6+
7+
# LWC configuration files
8+
**/jsconfig.json
9+
**/.eslintrc.json
10+
11+
# LWC Jest
12+
**/__tests__/**

.gitignore

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Folders to exclude
2+
.localdevserver/
3+
.settings/
4+
.sfdx/
5+
.vscode/
6+
wip/
7+
8+
# NPM
9+
node_modules/
10+
yarn.lock
11+
12+
# Files to exclude
13+
*.log
14+
**/lwc/jsconfig.json

.prettierignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# List files or directories below to ignore them when running prettier
2+
# More information: https://prettier.io/docs/en/ignore.html
3+
#
4+
5+
.sfdx
6+
.vscode

.prettierrc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"trailingComma": "none",
3+
"tabWidth": 2,
4+
"useTabs": false,
5+
"printWidth": 120,
6+
"overrides": [
7+
{
8+
"files": "**/lwc/**/*.html",
9+
"options": { "parser": "lwc" }
10+
},
11+
{
12+
"files": "*.{cmp,page,component}",
13+
"options": { "parser": "html" }
14+
}
15+
]
16+
}

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Package Analytics
2+
3+
Provides reportable data about your Salesforce packages in your dev hub.
4+
5+
[![Install Unlocked Package in a Dev Hub](./images/btn-install-unlocked-package-production.png)](https://login.salesforce.com/packaging/installPackage.apexp?p0=04t4x000000FEjUAAW)
6+
7+
## Why?
8+
9+
When working with packages in Salesforce, the platform automatically tracks & stores data about your packages, package versions, and customer orgs that are using your package(s) (referred to as 'subscriber orgs'). However, the objects that store this data can only be accessed via SOQL or Apex - they are not accessible via the Salesforce UI, which also means that the data is not reportable.
10+
11+
This project aims to help ISVs better monitor their packages by extracting data into custom objects so you can easily view it in your dev hub, using standard Salesforce UI functionality. The data is also reportable, using standard Salesforce report & dashboard functionality.
12+
13+
## Getting Started
14+
15+
1. Install the package into your dev hub
16+
2. Schedule the Apex job using `new PackageDataExtractJob().scheduleHourly();`. This will also immediately run the job.
17+
3. Optional: assign permission sets to any users in your dev hub that should be able to see/report on the data.
18+
- System Admins should already have access to the objects/data, so they should not need to have any permission sets assigned
19+
- 'Package Analytics Admin' permission set - for any users that should be able to modify or delete access to the data in the included custom objects
20+
- 'Package Analytics Viewer' permission set - for any users that should have read-only access to the data in the included custom objects
21+
4. Open the app 'Package Analytics' in App Switcher
22+
5. Enjoy the reportable data about your packages. You can build your own reports & dashboards, using these custom objects
23+
- `Package__c`
24+
- `PackageVersion__c`
25+
- `PackageSubscriberOrg__c`
26+
27+
## Screenshots
28+
29+
View your list of 1GP and 2GP packages
30+
31+
![Packages list view](/images/packages-tab.png)
32+
33+
For each package, you can see the list of package versions & additional details about the package
34+
35+
![Package detail page](/images/package-detail-page.png)
36+
37+
Similarly, for each package version, you can see the list of orgs that have installed the package version, as well as additional details about the package version.
38+
39+
![Package Version detail page](/images/package-version-detail-page.png)
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"orgName": "Package Analytics - Base Scratch Org",
3+
"edition": "Enterprise",
4+
"hasSampleData": true,
5+
"country": "US",
6+
"language": "en_US",
7+
"features": [],
8+
"settings": {
9+
"userManagementSettings": {
10+
"enableEnhancedPermsetMgmt": true,
11+
"enableEnhancedProfileMgmt": true,
12+
"enableNewProfileUI": true
13+
}
14+
}
15+
}
52.6 KB
Loading

images/package-detail-page.png

135 KB
Loading
139 KB
Loading

images/packages-tab.png

50 KB
Loading

0 commit comments

Comments
 (0)