sfdx-hardis 6.9.1-alpha202510262222.0 → 6.9.1-alpha202510262255.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -5539,15 +5539,12 @@
5539
5539
  "import:data:org:hardis"
5540
5540
  ]
5541
5541
  },
5542
- "hardis:org:diagnose:audittrail": {
5542
+ "hardis:org:files:export": {
5543
5543
  "aliases": [],
5544
5544
  "args": {},
5545
- "description": "Export Audit trail into a CSV file with selected criteria, and highlight suspect actions\n\nAlso detects updates of Custom Settings values (disable by defining `SKIP_AUDIT_TRAIL_CUSTOM_SETTINGS=true`)\n\nRegular setup actions performed in major orgs are filtered.\n\n- \"\"\n - createScratchOrg\n - changedsenderemail\n - deleteScratchOrg\n - loginasgrantedtopartnerbt\n- Certificate and Key Management\n - insertCertificate\n- Custom App Licenses\n - addeduserpackagelicense\n - granteduserpackagelicense\n - revokeduserpackagelicense\n- Customer Portal\n - createdcustomersuccessuser\n - CSPUserDisabled\n- Currency\n - updateddatedexchrate\n- Data Management\n - queueMembership\n- Email Administration\n - dkimRotationPreparationSuccessful\n - dkimRotationSuccessful\n- External Objects\n - xdsEncryptedFieldChange\n- Groups\n - groupMembership\n- Holidays\n - holiday_insert\n- Inbox mobile and legacy desktop apps\n - enableSIQUserNonEAC\n - siqUserAcceptedTOS\n- Manage Users\n - activateduser\n - createduser\n - changedcommunitynickname\n - changedemail\n - changedfederationid\n - changedpassword\n - changedinteractionuseroffon\n - changedinteractionuseronoff\n - changedmarketinguseroffon\n - changedmarketinguseronoff\n - changedofflineuseroffon\n - changedprofileforuserstdtostd\n - changedprofileforuser\n - changedprofileforusercusttostd\n - changedprofileforuserstdtocust\n - changedroleforusertonone\n - changedroleforuser\n - changedroleforuserfromnone\n - changedUserAdminVerifiedStatusVerified\n - changedUserEmailVerifiedStatusUnverified\n - changedUserEmailVerifiedStatusVerified\n - changedknowledgeuseroffon\n - changedsfcontentuseroffon\n - changedsupportuseroffon\n - changedusername\n - changedUserPhoneNumber\n - changedUserPhoneVerifiedStatusUnverified\n - changedUserPhoneVerifiedStatusVerified\n - deactivateduser\n - deleteAuthenticatorPairing\n - deleteTwoFactorInfo2\n - deleteTwoFactorTempCode\n - frozeuser\n - insertAuthenticatorPairing\n - insertTwoFactorInfo2\n - insertTwoFactorTempCode\n - lightningloginenroll\n - PermSetAssign\n - PermSetGroupAssign\n - PermSetGroupUnassign\n - PermSetLicenseAssign\n - PermSetUnassign\n - PermSetLicenseUnassign\n - registeredUserPhoneNumber\n - resetpassword\n - suNetworkAdminLogin\n - suNetworkAdminLogout\n - suOrgAdminLogin\n - suOrgAdminLogout\n - unfrozeuser\n - useremailchangesent\n- Mobile Administration\n - assigneduserstomobileconfig\n- Reporting Snapshots\n - createdReportJob\n - deletedReportJob\n- Sandboxes\n - DeleteSandbox\n\nBy default, deployment user defined in .sfdx-hardis.yml targetUsername property will be excluded.\n\nYou can define additional users to exclude in .sfdx-hardis.yml **monitoringExcludeUsernames** property.\n\nYou can also add more sections / actions considered as not suspect using property **monitoringAllowedSectionsActions**\n\nExample:\n\n```yaml\nmonitoringExcludeUsernames:\n - deploymentuser@cloudity.com\n - marketingcloud@cloudity.com\n - integration-user@cloudity.com\n\nmonitoringAllowedSectionsActions:\n \"Some section\": [] // Will ignore all actions from such section\n \"Some other section\": [\"actionType1\",\"actionType2\",\"actionType3\"] // Will ignore only those 3 actions from section \"Some other section\". Other actions in the same section will be considered as suspect.\n```\n\n## Excel output example\n\n![](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-monitoring-audittrail-excel.jpg)\n\n## Local output example\n\n![](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-monitoring-audittrail-local.jpg)\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-suspect-audit-trail/) and can output Grafana, Slack and MsTeams Notifications.\n",
5545
+ "description": "\n## Command Behavior\n\n**Exports file attachments (ContentVersion, Attachment) from a Salesforce org based on a predefined configuration.**\n\nThis command enables the mass download of files associated with Salesforce records, providing a robust solution for backing up files, migrating them to other systems, or integrating them with external document management solutions.\n\nKey functionalities:\n\n- **Configuration-Driven Export:** Relies on an `export.json` file within a designated file export project to define the export criteria, including the SOQL query for parent records, file types to export, output naming conventions, and file size filtering.\n- **File Size Filtering:** Supports minimum file size filtering via the `fileSizeMin` configuration parameter (in KB). Files smaller than the specified size will be skipped during export.\n- **File Validation:** After downloading each file, validates the integrity by:\n - **Checksum Validation:** For ContentVersion files, compares MD5 checksum with Salesforce's stored checksum\n - **Size Validation:** For both ContentVersion and Attachment files, verifies actual file size matches expected size\n - **Status Tracking:** Files are categorized with specific statuses: `success` (valid files), `failed` (download errors), `skipped` (filtered files), `invalid` (downloaded but failed validation)\n - All validation results are logged in the CSV export log for audit purposes\n- **Resume/Restart Capability:** \n - **Resume Mode:** When `--resume` flag is used (default in CI environments), checks existing downloaded files for validity. Valid files are skipped, invalid files are re-downloaded.\n - **Restart Mode:** When resume is disabled, clears the output folder and starts a fresh export.\n - **Interactive Mode:** When existing files are found and `--resume` is not explicitly specified (non-CI environments), prompts the user to choose between resume or restart.\n- **Interactive Project Selection:** If the file export project path is not provided via the `--path` flag, it interactively prompts the user to select one.\n- **Configurable Export Options:** Allows overriding default export settings such as `chunksize` (number of records processed in a batch), `polltimeout` (timeout for Bulk API calls), and `startchunknumber` (to resume a failed export).\n- **Support for ContentVersion and Attachment:** Handles both modern Salesforce Files (ContentVersion) and older Attachments.\n\nSee this article for a practical example:\n\n[![How to mass download notes and attachments files from a Salesforce org](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-mass-download.jpg)](https://nicolas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **FilesExporter Class:** The core logic is encapsulated within the `FilesExporter` class, which orchestrates the entire export process.\n- **SOQL Queries (Bulk API):** It uses Salesforce Bulk API queries to efficiently retrieve large volumes of parent record IDs and file metadata, including checksums and file sizes.\n- **File Download:** Downloads the actual file content from Salesforce.\n- **File Validation:** After each successful download, validates file integrity by comparing checksums (ContentVersion) and file sizes (both ContentVersion and Attachment) against Salesforce metadata.\n- **Resume Logic:** In resume mode, checks for existing files before downloading, validates their integrity, and only re-downloads invalid or missing files. This enables efficient recovery from interrupted exports.\n- **File System Operations:** Writes the downloaded files to the local file system, organizing them into folders based on the configured naming conventions.\n- **Configuration Loading:** Reads the `export.json` file to get the export configuration. It also allows for interactive overriding of these settings.\n- **Interactive Prompts:** Uses `selectFilesWorkspace` to allow the user to choose a file export project, `promptFilesExportConfiguration` for customizing export options, and prompts for resume/restart choice when existing files are found.\n- **Error Handling:** Includes mechanisms to handle potential errors during the export process, such as network issues, API limits, and file validation failures. Each file is assigned a specific status (`success`, `failed`, `skipped`, `invalid`) for comprehensive tracking and troubleshooting.\n</details>\n",
5546
5546
  "examples": [
5547
- "$ sf hardis:org:diagnose:audittrail",
5548
- "$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com",
5549
- "$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com,bertrand@titi.com",
5550
- "$ sf hardis:org:diagnose:audittrail --lastndays 5"
5547
+ "$ sf hardis:org:files:export"
5551
5548
  ],
5552
5549
  "flags": {
5553
5550
  "json": {
@@ -5565,30 +5562,48 @@
5565
5562
  "multiple": false,
5566
5563
  "type": "option"
5567
5564
  },
5568
- "excludeusers": {
5569
- "char": "e",
5570
- "description": "Comma-separated list of usernames to exclude",
5571
- "name": "excludeusers",
5565
+ "path": {
5566
+ "char": "p",
5567
+ "description": "Path to the file export project",
5568
+ "name": "path",
5572
5569
  "hasDynamicHelp": false,
5573
5570
  "multiple": false,
5574
5571
  "type": "option"
5575
5572
  },
5576
- "lastndays": {
5573
+ "chunksize": {
5574
+ "char": "c",
5575
+ "description": "Number of records to add in a chunk before it is processed",
5576
+ "name": "chunksize",
5577
+ "default": 1000,
5578
+ "hasDynamicHelp": false,
5579
+ "multiple": false,
5580
+ "type": "option"
5581
+ },
5582
+ "polltimeout": {
5577
5583
  "char": "t",
5578
- "description": "Number of days to extract from today (included)",
5579
- "name": "lastndays",
5584
+ "description": "Timeout in MS for Bulk API calls",
5585
+ "name": "polltimeout",
5586
+ "default": 300000,
5580
5587
  "hasDynamicHelp": false,
5581
5588
  "multiple": false,
5582
5589
  "type": "option"
5583
5590
  },
5584
- "outputfile": {
5585
- "char": "f",
5586
- "description": "Force the path and name of output report file. Must end with .csv",
5587
- "name": "outputfile",
5591
+ "startchunknumber": {
5592
+ "char": "s",
5593
+ "description": "Chunk number to start from",
5594
+ "name": "startchunknumber",
5595
+ "default": 0,
5588
5596
  "hasDynamicHelp": false,
5589
5597
  "multiple": false,
5590
5598
  "type": "option"
5591
5599
  },
5600
+ "resume": {
5601
+ "char": "r",
5602
+ "description": "Resume previous export by checking existing files (default in CI)",
5603
+ "name": "resume",
5604
+ "allowNo": false,
5605
+ "type": "boolean"
5606
+ },
5592
5607
  "debug": {
5593
5608
  "char": "d",
5594
5609
  "description": "Activate debug mode (more logs)",
@@ -5627,13 +5642,13 @@
5627
5642
  },
5628
5643
  "hasDynamicHelp": true,
5629
5644
  "hiddenAliases": [],
5630
- "id": "hardis:org:diagnose:audittrail",
5645
+ "id": "hardis:org:files:export",
5631
5646
  "pluginAlias": "sfdx-hardis",
5632
5647
  "pluginName": "sfdx-hardis",
5633
5648
  "pluginType": "core",
5634
5649
  "strict": true,
5635
5650
  "enableJsonFlag": true,
5636
- "title": "Diagnose content of Setup Audit Trail",
5651
+ "title": "Export files",
5637
5652
  "requiresProject": false,
5638
5653
  "isESM": true,
5639
5654
  "relativePath": [
@@ -5641,43 +5656,43 @@
5641
5656
  "commands",
5642
5657
  "hardis",
5643
5658
  "org",
5644
- "diagnose",
5645
- "audittrail.js"
5659
+ "files",
5660
+ "export.js"
5646
5661
  ],
5647
5662
  "aliasPermutations": [],
5648
5663
  "permutations": [
5649
- "hardis:org:diagnose:audittrail",
5650
- "org:hardis:diagnose:audittrail",
5651
- "org:diagnose:hardis:audittrail",
5652
- "org:diagnose:audittrail:hardis",
5653
- "hardis:diagnose:org:audittrail",
5654
- "diagnose:hardis:org:audittrail",
5655
- "diagnose:org:hardis:audittrail",
5656
- "diagnose:org:audittrail:hardis",
5657
- "hardis:diagnose:audittrail:org",
5658
- "diagnose:hardis:audittrail:org",
5659
- "diagnose:audittrail:hardis:org",
5660
- "diagnose:audittrail:org:hardis",
5661
- "hardis:org:audittrail:diagnose",
5662
- "org:hardis:audittrail:diagnose",
5663
- "org:audittrail:hardis:diagnose",
5664
- "org:audittrail:diagnose:hardis",
5665
- "hardis:audittrail:org:diagnose",
5666
- "audittrail:hardis:org:diagnose",
5667
- "audittrail:org:hardis:diagnose",
5668
- "audittrail:org:diagnose:hardis",
5669
- "hardis:audittrail:diagnose:org",
5670
- "audittrail:hardis:diagnose:org",
5671
- "audittrail:diagnose:hardis:org",
5672
- "audittrail:diagnose:org:hardis"
5664
+ "hardis:org:files:export",
5665
+ "org:hardis:files:export",
5666
+ "org:files:hardis:export",
5667
+ "org:files:export:hardis",
5668
+ "hardis:files:org:export",
5669
+ "files:hardis:org:export",
5670
+ "files:org:hardis:export",
5671
+ "files:org:export:hardis",
5672
+ "hardis:files:export:org",
5673
+ "files:hardis:export:org",
5674
+ "files:export:hardis:org",
5675
+ "files:export:org:hardis",
5676
+ "hardis:org:export:files",
5677
+ "org:hardis:export:files",
5678
+ "org:export:hardis:files",
5679
+ "org:export:files:hardis",
5680
+ "hardis:export:org:files",
5681
+ "export:hardis:org:files",
5682
+ "export:org:hardis:files",
5683
+ "export:org:files:hardis",
5684
+ "hardis:export:files:org",
5685
+ "export:hardis:files:org",
5686
+ "export:files:hardis:org",
5687
+ "export:files:org:hardis"
5673
5688
  ]
5674
5689
  },
5675
- "hardis:org:diagnose:instanceupgrade": {
5690
+ "hardis:org:files:import": {
5676
5691
  "aliases": [],
5677
5692
  "args": {},
5678
- "description": "\n## Command Behavior\n\n**Retrieves and displays the scheduled upgrade date for a Salesforce org's instance.**\n\nThis command provides crucial information about when your Salesforce instance will be upgraded to the next major release (Spring, Summer, or Winter). This is vital for release planning, testing, and ensuring compatibility with upcoming Salesforce features.\n\nKey functionalities:\n\n- **Instance Identification:** Determines the Salesforce instance name of your target org.\n- **Upgrade Date Retrieval:** Fetches the planned start time of the next major core service upgrade for that instance from the Salesforce Status API.\n- **Days Until Upgrade:** Calculates and displays the number of days remaining until the next major upgrade.\n- **Severity-Based Logging:** Adjusts the log severity (info, warning) based on the proximity of the upgrade date, providing a visual cue for urgency.\n- **Notifications:** Sends notifications to configured channels (e.g., Slack, MS Teams, Grafana) with the upgrade information, making it suitable for automated monitoring.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Query:** It first queries the `Organization` object in Salesforce to get the `InstanceName` of the target org.\n- **Salesforce Status API Integration:** It makes an HTTP GET request to the Salesforce Status API (`https://api.status.salesforce.com/v1/instances/{instanceName}/status`) to retrieve detailed information about the instance, including scheduled maintenances.\n- **Data Parsing:** It parses the JSON response from the Status API to extract the relevant major release upgrade information.\n- **Date Calculation:** Uses the `moment` library to calculate the difference in days between the current date and the planned upgrade date.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including the instance name, upgrade date, and days remaining, along with relevant metrics for monitoring dashboards.\n- **User Feedback:** Provides clear messages to the user about the upgrade status and proximity.\n</details>\n",
5693
+ "description": "\nThis command facilitates the mass upload of files into Salesforce, allowing you to populate records with associated documents, images, or other file types. It's a crucial tool for data migration, content seeding, or synchronizing external file repositories with Salesforce.\n\nKey functionalities:\n\n- **Configuration-Driven Import:** Relies on an `export.json` file within a designated file export project (created using `sf hardis:org:configure:files`) to determine which files to import and how they should be associated with Salesforce records.\n- **Interactive Project Selection:** If the file import project path is not provided via the `--path` flag, it interactively prompts the user to select one.\n- **Overwrite Option:** The `--overwrite` flag allows you to replace existing files in Salesforce with local versions that have the same name. Be aware that this option doubles the number of API calls used.\n- **Support for ContentVersion and Attachment:** Handles both modern Salesforce Files (ContentVersion) and older Attachments.\n\nSee this article for how to export files, which is often a prerequisite for importing:\n\n[![How to mass download notes and attachments files from a Salesforce org](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-mass-download.jpg)](https://nicolas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **FilesImporter Class:** The core logic is encapsulated within the `FilesImporter` class, which orchestrates the entire import process.\n- **File System Scan:** Scans the local file system within the configured project directory to identify files for import.\n- **Salesforce API Interaction:** Uses Salesforce APIs (e.g., ContentVersion, Attachment) to upload files and associate them with records.\n- **Configuration Loading:** Reads the `export.json` file to get the import configuration, including SOQL queries to identify parent records for file association.\n- **Interactive Prompts:** Uses `selectFilesWorkspace` to allow the user to choose a file import project and `prompts` for confirming the overwrite behavior.\n- **Error Handling:** Includes mechanisms to handle potential errors during the import process, such as API limits or file upload failures.\n</details>\n",
5679
5694
  "examples": [
5680
- "$ sf hardis:org:diagnose:instanceupgrade"
5695
+ "$ sf hardis:org:files:import"
5681
5696
  ],
5682
5697
  "flags": {
5683
5698
  "json": {
@@ -5695,6 +5710,21 @@
5695
5710
  "multiple": false,
5696
5711
  "type": "option"
5697
5712
  },
5713
+ "path": {
5714
+ "char": "p",
5715
+ "description": "Path to the file export project",
5716
+ "name": "path",
5717
+ "hasDynamicHelp": false,
5718
+ "multiple": false,
5719
+ "type": "option"
5720
+ },
5721
+ "overwrite": {
5722
+ "char": "f",
5723
+ "description": "Override existing files (doubles the number of API calls)",
5724
+ "name": "overwrite",
5725
+ "allowNo": false,
5726
+ "type": "boolean"
5727
+ },
5698
5728
  "debug": {
5699
5729
  "char": "d",
5700
5730
  "description": "Activate debug mode (more logs)",
@@ -5733,13 +5763,13 @@
5733
5763
  },
5734
5764
  "hasDynamicHelp": true,
5735
5765
  "hiddenAliases": [],
5736
- "id": "hardis:org:diagnose:instanceupgrade",
5766
+ "id": "hardis:org:files:import",
5737
5767
  "pluginAlias": "sfdx-hardis",
5738
5768
  "pluginName": "sfdx-hardis",
5739
5769
  "pluginType": "core",
5740
5770
  "strict": true,
5741
5771
  "enableJsonFlag": true,
5742
- "title": "Get Instance Upgrade date",
5772
+ "title": "Import files",
5743
5773
  "requiresProject": false,
5744
5774
  "isESM": true,
5745
5775
  "relativePath": [
@@ -5747,46 +5777,44 @@
5747
5777
  "commands",
5748
5778
  "hardis",
5749
5779
  "org",
5750
- "diagnose",
5751
- "instanceupgrade.js"
5780
+ "files",
5781
+ "import.js"
5752
5782
  ],
5753
5783
  "aliasPermutations": [],
5754
5784
  "permutations": [
5755
- "hardis:org:diagnose:instanceupgrade",
5756
- "org:hardis:diagnose:instanceupgrade",
5757
- "org:diagnose:hardis:instanceupgrade",
5758
- "org:diagnose:instanceupgrade:hardis",
5759
- "hardis:diagnose:org:instanceupgrade",
5760
- "diagnose:hardis:org:instanceupgrade",
5761
- "diagnose:org:hardis:instanceupgrade",
5762
- "diagnose:org:instanceupgrade:hardis",
5763
- "hardis:diagnose:instanceupgrade:org",
5764
- "diagnose:hardis:instanceupgrade:org",
5765
- "diagnose:instanceupgrade:hardis:org",
5766
- "diagnose:instanceupgrade:org:hardis",
5767
- "hardis:org:instanceupgrade:diagnose",
5768
- "org:hardis:instanceupgrade:diagnose",
5769
- "org:instanceupgrade:hardis:diagnose",
5770
- "org:instanceupgrade:diagnose:hardis",
5771
- "hardis:instanceupgrade:org:diagnose",
5772
- "instanceupgrade:hardis:org:diagnose",
5773
- "instanceupgrade:org:hardis:diagnose",
5774
- "instanceupgrade:org:diagnose:hardis",
5775
- "hardis:instanceupgrade:diagnose:org",
5776
- "instanceupgrade:hardis:diagnose:org",
5777
- "instanceupgrade:diagnose:hardis:org",
5778
- "instanceupgrade:diagnose:org:hardis"
5785
+ "hardis:org:files:import",
5786
+ "org:hardis:files:import",
5787
+ "org:files:hardis:import",
5788
+ "org:files:import:hardis",
5789
+ "hardis:files:org:import",
5790
+ "files:hardis:org:import",
5791
+ "files:org:hardis:import",
5792
+ "files:org:import:hardis",
5793
+ "hardis:files:import:org",
5794
+ "files:hardis:import:org",
5795
+ "files:import:hardis:org",
5796
+ "files:import:org:hardis",
5797
+ "hardis:org:import:files",
5798
+ "org:hardis:import:files",
5799
+ "org:import:hardis:files",
5800
+ "org:import:files:hardis",
5801
+ "hardis:import:org:files",
5802
+ "import:hardis:org:files",
5803
+ "import:org:hardis:files",
5804
+ "import:org:files:hardis",
5805
+ "hardis:import:files:org",
5806
+ "import:hardis:files:org",
5807
+ "import:files:hardis:org",
5808
+ "import:files:org:hardis"
5779
5809
  ]
5780
5810
  },
5781
- "hardis:org:diagnose:legacyapi": {
5811
+ "hardis:org:fix:listviewmine": {
5782
5812
  "aliases": [],
5783
5813
  "args": {},
5784
- "description": "Checks if an org uses retired or someday retired API version\n\n\nSee article below\n\n[![Handle Salesforce API versions Deprecation like a pro](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-deprecated-api.jpg)](https://nicolas.vuillamy.fr/handle-salesforce-api-versions-deprecation-like-a-pro-335065f52238)\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-deprecated-api-calls/) and can output Grafana, Slack and MsTeams Notifications.\n",
5814
+ "description": "Fix listviews whose scope Mine has been replaced by Everything\n\n[![Invalid scope:Mine, not allowed ? Deploy your ListViews anyway !](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-invalid-scope-mine.jpg)](https://nicolas.vuillamy.fr/invalid-scope-mine-not-allowed-deploy-your-listviews-anyway-443aceca8ac7)\n\nList of ListViews can be:\n\n- read from .sfdx-hardis.yml file in property **listViewsToSetToMine**\n- sent in argument listviews\n\nNote: property **listViewsToSetToMine** can be auto-generated by command hardis:work:save if .sfdx-hardis.yml contains the following configuration\n\n```yaml\nautoCleanTypes:\n - listViewsMine\n```\n\n- Example of sfdx-hardis.yml property `listViewsToSetToMine`:\n\n```yaml\nlistViewsToSetToMine:\n - \"force-app/main/default/objects/Operation__c/listViews/MyCurrentOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Operation__c/listViews/MyFinalizedOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/Default_Opportunity_Pipeline.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MyCurrentSubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MySubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Account/listViews/MyActivePartners.listView-meta.xml\"\n```\n\n- If manually written, this could also be:\n\n```yaml\nlistViewsToSetToMine:\n - \"Operation__c:MyCurrentOperations\"\n - \"Operation__c:MyFinalizedOperations\"\n - \"Opportunity:Default_Opportunity_Pipeline\"\n - \"Opportunity:MyCurrentSubscriptions\"\n - \"Opportunity:MySubscriptions\"\n - \"Account:MyActivePartners\"\n```\n\nTroubleshooting: if you need to run this command from an alpine-linux based docker image, use this workaround in your dockerfile:\n\n```dockerfile\n# Do not use puppeteer embedded chromium\nRUN apk add --update --no-cache chromium\nENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=\"true\"\nENV CHROMIUM_PATH=\"/usr/bin/chromium-browser\"\nENV PUPPETEER_EXECUTABLE_PATH=\"$\\{CHROMIUM_PATH}\" // remove \\ before {\n```\n",
5785
5815
  "examples": [
5786
- "$ sf hardis:org:diagnose:legacyapi",
5787
- "$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com",
5788
- "$ sf hardis:org:diagnose:legacyapi --outputfile 'c:/path/to/folder/legacyapi.csv'",
5789
- "$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com --outputfile ./tmp/legacyapi.csv"
5816
+ "$ sf hardis:org:fix:listviewmine",
5817
+ "$ sf hardis:org:fix:listviewmine --listviews Opportunity:MySubscriptions,Account:MyActivePartners"
5790
5818
  ],
5791
5819
  "flags": {
5792
5820
  "json": {
@@ -5804,28 +5832,10 @@
5804
5832
  "multiple": false,
5805
5833
  "type": "option"
5806
5834
  },
5807
- "eventtype": {
5808
- "char": "e",
5809
- "description": "Type of EventLogFile event to analyze",
5810
- "name": "eventtype",
5811
- "default": "ApiTotalUsage",
5812
- "hasDynamicHelp": false,
5813
- "multiple": false,
5814
- "type": "option"
5815
- },
5816
- "limit": {
5835
+ "listviews": {
5817
5836
  "char": "l",
5818
- "description": "Number of latest EventLogFile events to analyze",
5819
- "name": "limit",
5820
- "default": 999,
5821
- "hasDynamicHelp": false,
5822
- "multiple": false,
5823
- "type": "option"
5824
- },
5825
- "outputfile": {
5826
- "char": "f",
5827
- "description": "Force the path and name of output report file. Must end with .csv",
5828
- "name": "outputfile",
5837
+ "description": "Comma-separated list of listviews following format Object:ListViewName\nExample: Contact:MyContacts,Contact:MyActiveContacts,Opportunity:MYClosedOpportunities",
5838
+ "name": "listviews",
5829
5839
  "hasDynamicHelp": false,
5830
5840
  "multiple": false,
5831
5841
  "type": "option"
@@ -5868,57 +5878,59 @@
5868
5878
  },
5869
5879
  "hasDynamicHelp": true,
5870
5880
  "hiddenAliases": [],
5871
- "id": "hardis:org:diagnose:legacyapi",
5881
+ "id": "hardis:org:fix:listviewmine",
5872
5882
  "pluginAlias": "sfdx-hardis",
5873
5883
  "pluginName": "sfdx-hardis",
5874
5884
  "pluginType": "core",
5875
5885
  "strict": true,
5876
5886
  "enableJsonFlag": true,
5877
- "title": "Check for legacy API use",
5878
- "requiresProject": false,
5887
+ "title": "Fix listviews with ",
5888
+ "requiresProject": true,
5879
5889
  "isESM": true,
5880
5890
  "relativePath": [
5881
5891
  "lib",
5882
5892
  "commands",
5883
5893
  "hardis",
5884
5894
  "org",
5885
- "diagnose",
5886
- "legacyapi.js"
5895
+ "fix",
5896
+ "listviewmine.js"
5887
5897
  ],
5888
5898
  "aliasPermutations": [],
5889
5899
  "permutations": [
5890
- "hardis:org:diagnose:legacyapi",
5891
- "org:hardis:diagnose:legacyapi",
5892
- "org:diagnose:hardis:legacyapi",
5893
- "org:diagnose:legacyapi:hardis",
5894
- "hardis:diagnose:org:legacyapi",
5895
- "diagnose:hardis:org:legacyapi",
5896
- "diagnose:org:hardis:legacyapi",
5897
- "diagnose:org:legacyapi:hardis",
5898
- "hardis:diagnose:legacyapi:org",
5899
- "diagnose:hardis:legacyapi:org",
5900
- "diagnose:legacyapi:hardis:org",
5901
- "diagnose:legacyapi:org:hardis",
5902
- "hardis:org:legacyapi:diagnose",
5903
- "org:hardis:legacyapi:diagnose",
5904
- "org:legacyapi:hardis:diagnose",
5905
- "org:legacyapi:diagnose:hardis",
5906
- "hardis:legacyapi:org:diagnose",
5907
- "legacyapi:hardis:org:diagnose",
5908
- "legacyapi:org:hardis:diagnose",
5909
- "legacyapi:org:diagnose:hardis",
5910
- "hardis:legacyapi:diagnose:org",
5911
- "legacyapi:hardis:diagnose:org",
5912
- "legacyapi:diagnose:hardis:org",
5913
- "legacyapi:diagnose:org:hardis"
5914
- ]
5915
- },
5916
- "hardis:org:diagnose:licenses": {
5917
- "aliases": [],
5918
- "args": {},
5919
- "description": "\n**Lists and analyzes User Licenses and Permission Set Licenses subscribed and used in a Salesforce org.**\n\nThis command provides a comprehensive overview of your Salesforce license consumption. It's particularly useful for:\n\n- **License Management:** Understanding which licenses are active, how many are available, and how many are being used.\n- **Cost Optimization:** Identifying unused or underutilized licenses that could be reallocated or decommissioned.\n- **Compliance:** Ensuring that your organization is compliant with Salesforce licensing agreements.\n- **Monitoring:** Tracking license usage trends over time.\n\nKey functionalities:\n\n- **User License Details:** Retrieves information about standard and custom User Licenses, including `MasterLabel`, `Name`, `TotalLicenses`, and `UsedLicenses`.\n- **Permission Set License Details:** Retrieves information about Permission Set Licenses, including `MasterLabel`, `PermissionSetLicenseKey`, `TotalLicenses`, and `UsedLicenses`.\n- **Used Licenses Filter:** The `--usedonly` flag allows you to filter the report to show only licenses that have at least one `UsedLicenses` count greater than zero.\n- **CSV Report Generation:** Generates a CSV file containing all the retrieved license information, suitable for detailed analysis.\n- **Notifications:** Sends notifications to configured channels (e.g., Grafana, Slack, MS Teams) with a summary of license usage, including lists of active and used licenses.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Queries:** It executes SOQL queries against the `UserLicense` and `PermissionSetLicense` objects in Salesforce to retrieve license data.\n- **Data Transformation:** It processes the query results, reformatting the data to be more readable and consistent for reporting purposes (e.g., removing `Id` and `attributes`, renaming `PermissionSetLicenseKey` to `Name`).\n- **Data Aggregation:** It aggregates license information, creating a `licensesByKey` object for quick lookups and a `usedLicenses` array for a concise list of actively used licenses.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of license data.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **User Feedback:** Provides clear messages to the user about the license extraction process and the used licenses.\n</details>\n",
5900
+ "hardis:org:fix:listviewmine",
5901
+ "org:hardis:fix:listviewmine",
5902
+ "org:fix:hardis:listviewmine",
5903
+ "org:fix:listviewmine:hardis",
5904
+ "hardis:fix:org:listviewmine",
5905
+ "fix:hardis:org:listviewmine",
5906
+ "fix:org:hardis:listviewmine",
5907
+ "fix:org:listviewmine:hardis",
5908
+ "hardis:fix:listviewmine:org",
5909
+ "fix:hardis:listviewmine:org",
5910
+ "fix:listviewmine:hardis:org",
5911
+ "fix:listviewmine:org:hardis",
5912
+ "hardis:org:listviewmine:fix",
5913
+ "org:hardis:listviewmine:fix",
5914
+ "org:listviewmine:hardis:fix",
5915
+ "org:listviewmine:fix:hardis",
5916
+ "hardis:listviewmine:org:fix",
5917
+ "listviewmine:hardis:org:fix",
5918
+ "listviewmine:org:hardis:fix",
5919
+ "listviewmine:org:fix:hardis",
5920
+ "hardis:listviewmine:fix:org",
5921
+ "listviewmine:hardis:fix:org",
5922
+ "listviewmine:fix:hardis:org",
5923
+ "listviewmine:fix:org:hardis"
5924
+ ]
5925
+ },
5926
+ "hardis:org:generate:packagexmlfull": {
5927
+ "aliases": [],
5928
+ "args": {},
5929
+ "description": "\n## Command Behavior\n\n**Generates a comprehensive `package.xml` file for a Salesforce org, including all metadata components, even managed ones.**\n\nThis command is essential for various Salesforce development and administration tasks, especially when you need a complete snapshot of an org's metadata. It goes beyond typical source tracking by including managed package components, which is crucial for understanding the full metadata footprint of an org.\n\nKey functionalities:\n\n- **Full Org Metadata Retrieval:** Connects to a specified Salesforce org (or prompts for one if not provided) and retrieves a complete list of all metadata types and their members.\n- **Managed Package Inclusion:** Unlike standard source retrieval, this command explicitly includes metadata from managed packages, providing a truly comprehensive `package.xml`.\n- **Customizable Output:** Allows you to specify the output file path for the generated `package.xml`.\n- **Interactive Org Selection:** If no target org is specified, it interactively prompts the user to choose an org. (or use --no-prompt to skip this step)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce Metadata API Interaction:** It leverages the Salesforce Metadata API to list all available metadata types and then retrieve all components for each type.\n- **`buildOrgManifest` Utility:** The core logic for querying the org's metadata and constructing the `package.xml` is encapsulated within the `buildOrgManifest` utility function.\n- **XML Generation:** It dynamically builds the XML structure of the `package.xml` file, including the `types` and `members` elements for all retrieved metadata.\n- **File System Operations:** It writes the generated `package.xml` file to the specified output path.\n- **Interactive Prompts:** Uses `promptOrgUsernameDefault` to guide the user in selecting the target Salesforce org.\n</details>\n",
5920
5930
  "examples": [
5921
- "$ sf hardis:org:diagnose:licenses"
5931
+ "$ sf hardis:org:generate:packagexmlfull",
5932
+ "$ sf hardis:org:generate:packagexmlfull --outputfile /tmp/packagexmlfull.xml",
5933
+ "$ sf hardis:org:generate:packagexmlfull --target-org nico@example.com"
5922
5934
  ],
5923
5935
  "flags": {
5924
5936
  "json": {
@@ -5937,20 +5949,12 @@
5937
5949
  "type": "option"
5938
5950
  },
5939
5951
  "outputfile": {
5940
- "char": "f",
5941
- "description": "Force the path and name of output report file. Must end with .csv",
5952
+ "description": "Output package.xml file",
5942
5953
  "name": "outputfile",
5943
5954
  "hasDynamicHelp": false,
5944
5955
  "multiple": false,
5945
5956
  "type": "option"
5946
5957
  },
5947
- "usedonly": {
5948
- "char": "u",
5949
- "description": "Filter to have only used licenses",
5950
- "name": "usedonly",
5951
- "allowNo": false,
5952
- "type": "boolean"
5953
- },
5954
5958
  "debug": {
5955
5959
  "char": "d",
5956
5960
  "description": "Activate debug mode (more logs)",
@@ -5958,6 +5962,13 @@
5958
5962
  "allowNo": false,
5959
5963
  "type": "boolean"
5960
5964
  },
5965
+ "no-prompt": {
5966
+ "char": "n",
5967
+ "description": "Do not prompt for org username, use the default one",
5968
+ "name": "no-prompt",
5969
+ "allowNo": false,
5970
+ "type": "boolean"
5971
+ },
5961
5972
  "websocket": {
5962
5973
  "description": "Websocket host:port for VsCode SFDX Hardis UI integration",
5963
5974
  "name": "websocket",
@@ -5989,13 +6000,13 @@
5989
6000
  },
5990
6001
  "hasDynamicHelp": true,
5991
6002
  "hiddenAliases": [],
5992
- "id": "hardis:org:diagnose:licenses",
6003
+ "id": "hardis:org:generate:packagexmlfull",
5993
6004
  "pluginAlias": "sfdx-hardis",
5994
6005
  "pluginName": "sfdx-hardis",
5995
6006
  "pluginType": "core",
5996
6007
  "strict": true,
5997
6008
  "enableJsonFlag": true,
5998
- "title": "List licenses subscribed and used in a Salesforce org",
6009
+ "title": "Generate Full Org package.xml",
5999
6010
  "requiresProject": false,
6000
6011
  "isESM": true,
6001
6012
  "relativePath": [
@@ -6003,43 +6014,44 @@
6003
6014
  "commands",
6004
6015
  "hardis",
6005
6016
  "org",
6006
- "diagnose",
6007
- "licenses.js"
6017
+ "generate",
6018
+ "packagexmlfull.js"
6008
6019
  ],
6009
6020
  "aliasPermutations": [],
6010
6021
  "permutations": [
6011
- "hardis:org:diagnose:licenses",
6012
- "org:hardis:diagnose:licenses",
6013
- "org:diagnose:hardis:licenses",
6014
- "org:diagnose:licenses:hardis",
6015
- "hardis:diagnose:org:licenses",
6016
- "diagnose:hardis:org:licenses",
6017
- "diagnose:org:hardis:licenses",
6018
- "diagnose:org:licenses:hardis",
6019
- "hardis:diagnose:licenses:org",
6020
- "diagnose:hardis:licenses:org",
6021
- "diagnose:licenses:hardis:org",
6022
- "diagnose:licenses:org:hardis",
6023
- "hardis:org:licenses:diagnose",
6024
- "org:hardis:licenses:diagnose",
6025
- "org:licenses:hardis:diagnose",
6026
- "org:licenses:diagnose:hardis",
6027
- "hardis:licenses:org:diagnose",
6028
- "licenses:hardis:org:diagnose",
6029
- "licenses:org:hardis:diagnose",
6030
- "licenses:org:diagnose:hardis",
6031
- "hardis:licenses:diagnose:org",
6032
- "licenses:hardis:diagnose:org",
6033
- "licenses:diagnose:hardis:org",
6034
- "licenses:diagnose:org:hardis"
6022
+ "hardis:org:generate:packagexmlfull",
6023
+ "org:hardis:generate:packagexmlfull",
6024
+ "org:generate:hardis:packagexmlfull",
6025
+ "org:generate:packagexmlfull:hardis",
6026
+ "hardis:generate:org:packagexmlfull",
6027
+ "generate:hardis:org:packagexmlfull",
6028
+ "generate:org:hardis:packagexmlfull",
6029
+ "generate:org:packagexmlfull:hardis",
6030
+ "hardis:generate:packagexmlfull:org",
6031
+ "generate:hardis:packagexmlfull:org",
6032
+ "generate:packagexmlfull:hardis:org",
6033
+ "generate:packagexmlfull:org:hardis",
6034
+ "hardis:org:packagexmlfull:generate",
6035
+ "org:hardis:packagexmlfull:generate",
6036
+ "org:packagexmlfull:hardis:generate",
6037
+ "org:packagexmlfull:generate:hardis",
6038
+ "hardis:packagexmlfull:org:generate",
6039
+ "packagexmlfull:hardis:org:generate",
6040
+ "packagexmlfull:org:hardis:generate",
6041
+ "packagexmlfull:org:generate:hardis",
6042
+ "hardis:packagexmlfull:generate:org",
6043
+ "packagexmlfull:hardis:generate:org",
6044
+ "packagexmlfull:generate:hardis:org",
6045
+ "packagexmlfull:generate:org:hardis"
6035
6046
  ]
6036
6047
  },
6037
- "hardis:org:diagnose:releaseupdates": {
6048
+ "hardis:org:purge:apexlog": {
6038
6049
  "aliases": [],
6039
6050
  "args": {},
6040
- "description": "Export Release Updates into a CSV file with selected criteria, and highlight Release Updates that should be checked.\n\nBefore publishing **Breaking Changes** ❌, Salesforce announce them in the setup menu [**Release Updates**](https://help.salesforce.com/s/articleView?id=sf.release_updates.htm&type=5)\n\n⚠️ Some of them are very important, because if you don't make the related upgrades in time (ex: before Winter 25) , your production org can crash !\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-release-updates/) and can output Grafana, Slack and MsTeams Notifications.\n",
6051
+ "description": "\n**Purges Apex debug logs from a Salesforce org.**\n\nThis command provides a quick and efficient way to clear out accumulated Apex debug logs from your Salesforce environment. This is particularly useful for:\n\n- **Storage Management:** Freeing up valuable data storage space in your Salesforce org.\n- **Performance Optimization:** Reducing the overhead associated with large volumes of debug logs.\n- **Troubleshooting:** Ensuring that new debug logs are generated cleanly without interference from old, irrelevant logs.\n\nKey functionalities:\n\n- **Log Identification:** Queries the `ApexLog` object to identify all existing debug logs.\n- **Confirmation Prompt:** Before deletion, it prompts for user confirmation, displaying the number of Apex logs that will be deleted.\n- **Bulk Deletion:** Uses the Salesforce Bulk API to efficiently delete a large number of Apex logs.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Query:** It executes a SOQL query (`SELECT Id FROM ApexLog LIMIT 50000`) to retrieve the IDs of Apex logs to be deleted. The limit is set to 50,000 to handle large volumes of logs.\n- **CSV Export:** The retrieved log IDs are temporarily exported to a CSV file (`ApexLogsToDelete_*.csv`) in the `./tmp` directory.\n- **User Confirmation:** It uses the `prompts` library to ask for user confirmation before proceeding with the deletion, displaying the count of logs to be purged.\n- **Bulk API Deletion:** It then uses the Salesforce CLI's `sf data delete bulk` command, pointing to the generated CSV file, to perform the mass deletion of Apex logs.\n- **File System Operations:** It uses `fs-extra` to create the temporary directory and manage the CSV file.\n- **Error Handling:** Includes error handling for the query and deletion operations.\n</details>\n",
6041
6052
  "examples": [
6042
- "$ sf hardis:org:diagnose:releaseupdates"
6053
+ "$ sf hardis:org:purge:apexlog",
6054
+ "$ sf hardis:org:purge:apexlog --target-org nicolas.vuillamy@gmail.com"
6043
6055
  ],
6044
6056
  "flags": {
6045
6057
  "json": {
@@ -6057,13 +6069,12 @@
6057
6069
  "multiple": false,
6058
6070
  "type": "option"
6059
6071
  },
6060
- "outputfile": {
6061
- "char": "f",
6062
- "description": "Force the path and name of output report file. Must end with .csv",
6063
- "name": "outputfile",
6064
- "hasDynamicHelp": false,
6065
- "multiple": false,
6066
- "type": "option"
6072
+ "prompt": {
6073
+ "char": "z",
6074
+ "description": "Prompt for confirmation (true by default, use --no-prompt to skip)",
6075
+ "name": "prompt",
6076
+ "allowNo": true,
6077
+ "type": "boolean"
6067
6078
  },
6068
6079
  "debug": {
6069
6080
  "char": "d",
@@ -6103,13 +6114,13 @@
6103
6114
  },
6104
6115
  "hasDynamicHelp": true,
6105
6116
  "hiddenAliases": [],
6106
- "id": "hardis:org:diagnose:releaseupdates",
6117
+ "id": "hardis:org:purge:apexlog",
6107
6118
  "pluginAlias": "sfdx-hardis",
6108
6119
  "pluginName": "sfdx-hardis",
6109
6120
  "pluginType": "core",
6110
6121
  "strict": true,
6111
6122
  "enableJsonFlag": true,
6112
- "title": "Check Release Updates of an org",
6123
+ "title": "Purge Apex Logs",
6113
6124
  "requiresProject": false,
6114
6125
  "isESM": true,
6115
6126
  "relativePath": [
@@ -6117,43 +6128,45 @@
6117
6128
  "commands",
6118
6129
  "hardis",
6119
6130
  "org",
6120
- "diagnose",
6121
- "releaseupdates.js"
6131
+ "purge",
6132
+ "apexlog.js"
6122
6133
  ],
6123
6134
  "aliasPermutations": [],
6124
6135
  "permutations": [
6125
- "hardis:org:diagnose:releaseupdates",
6126
- "org:hardis:diagnose:releaseupdates",
6127
- "org:diagnose:hardis:releaseupdates",
6128
- "org:diagnose:releaseupdates:hardis",
6129
- "hardis:diagnose:org:releaseupdates",
6130
- "diagnose:hardis:org:releaseupdates",
6131
- "diagnose:org:hardis:releaseupdates",
6132
- "diagnose:org:releaseupdates:hardis",
6133
- "hardis:diagnose:releaseupdates:org",
6134
- "diagnose:hardis:releaseupdates:org",
6135
- "diagnose:releaseupdates:hardis:org",
6136
- "diagnose:releaseupdates:org:hardis",
6137
- "hardis:org:releaseupdates:diagnose",
6138
- "org:hardis:releaseupdates:diagnose",
6139
- "org:releaseupdates:hardis:diagnose",
6140
- "org:releaseupdates:diagnose:hardis",
6141
- "hardis:releaseupdates:org:diagnose",
6142
- "releaseupdates:hardis:org:diagnose",
6143
- "releaseupdates:org:hardis:diagnose",
6144
- "releaseupdates:org:diagnose:hardis",
6145
- "hardis:releaseupdates:diagnose:org",
6146
- "releaseupdates:hardis:diagnose:org",
6147
- "releaseupdates:diagnose:hardis:org",
6148
- "releaseupdates:diagnose:org:hardis"
6136
+ "hardis:org:purge:apexlog",
6137
+ "org:hardis:purge:apexlog",
6138
+ "org:purge:hardis:apexlog",
6139
+ "org:purge:apexlog:hardis",
6140
+ "hardis:purge:org:apexlog",
6141
+ "purge:hardis:org:apexlog",
6142
+ "purge:org:hardis:apexlog",
6143
+ "purge:org:apexlog:hardis",
6144
+ "hardis:purge:apexlog:org",
6145
+ "purge:hardis:apexlog:org",
6146
+ "purge:apexlog:hardis:org",
6147
+ "purge:apexlog:org:hardis",
6148
+ "hardis:org:apexlog:purge",
6149
+ "org:hardis:apexlog:purge",
6150
+ "org:apexlog:hardis:purge",
6151
+ "org:apexlog:purge:hardis",
6152
+ "hardis:apexlog:org:purge",
6153
+ "apexlog:hardis:org:purge",
6154
+ "apexlog:org:hardis:purge",
6155
+ "apexlog:org:purge:hardis",
6156
+ "hardis:apexlog:purge:org",
6157
+ "apexlog:hardis:purge:org",
6158
+ "apexlog:purge:hardis:org",
6159
+ "apexlog:purge:org:hardis"
6149
6160
  ]
6150
6161
  },
6151
- "hardis:org:diagnose:unsecure-connected-apps": {
6162
+ "hardis:org:purge:flow": {
6152
6163
  "aliases": [],
6153
6164
  "args": {},
6154
- "description": "\n## Command Behavior\n\n**Detects unsecured Connected Apps in a Salesforce org and generates detailed reports for security analysis.**\n\nThis command is a critical security diagnostic tool that helps administrators identify Connected Apps that may pose security risks due to improper configuration. It provides comprehensive analysis of OAuth tokens and Connected App security settings to ensure proper access control.\n\nKey functionalities:\n\n- **OAuth Token Analysis:** Queries all OAuth tokens in the org using SOQL to retrieve comprehensive token information including app names, users, authorization status, and usage statistics.\n- **Security Status Assessment:** Evaluates each Connected App's security configuration by checking the `IsUsingAdminAuthorization` flag to determine if admin pre-approval is required.\n- **Unsecured App Detection:** Identifies Connected Apps that allow users to authorize themselves without admin approval, which can pose security risks.\n- **Detailed Reporting:** Generates two comprehensive CSV reports:\n - **OAuth Tokens Report:** Lists all OAuth tokens with security status, user information, and usage data\n - **Connected Apps Summary:** Aggregates unsecured Connected Apps with counts of associated OAuth tokens\n- **Visual Indicators:** Uses status icons (❌ for unsecured, for secured) to provide immediate visual feedback on security status.\n- **Security Recommendations:** Provides actionable guidance on how to secure Connected Apps through proper configuration.\n- **Notifications:** Sends alerts to configured channels (Grafana, Slack, MS Teams) with security findings and attached reports.\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-org-security/) and can output Grafana, Slack and MsTeams Notifications.\n\n<iframe width=\"560\" height=\"315\" src=\"https://www.youtube.com/embed/jHv8yrSK8Dg\" title=\"YouTube video player\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Query Execution:** Executes a comprehensive SOQL query on the `OauthToken` object, joining with `AppMenuItem` and `User` objects to gather complete security context.\n- **Security Analysis Logic:** Analyzes the `AppMenuItem.IsUsingAdminAuthorization` field to determine if a Connected App requires admin pre-approval for user authorization.\n- **Data Transformation:** Processes raw SOQL results to add security status indicators and reorganize data for optimal reporting and analysis.\n- **Aggregation Processing:** Groups OAuth tokens by Connected App name to provide summary statistics and identify the most problematic applications.\n- **Report Generation:** Uses `generateCsvFile` to create structured CSV reports with proper formatting and metadata for easy analysis and sharing.\n- **Notification Integration:** Integrates with the `NotifProvider` to send security alerts with detailed metrics, including the number of unsecured Connected Apps and associated OAuth tokens.\n- **File Management:** Generates multiple output formats (CSV, XLSX) and manages file paths using `generateReportPath` for consistent report organization.\n- **Connection Management:** Uses `setConnectionVariables` to ensure proper authentication context for notification providers that require org connection details.\n</details>\n",
6165
+ "description": "\n**Purges old or unwanted Flow versions from a Salesforce org, with an option to delete related Flow Interviews.**\n\nThis command helps maintain a clean and performant Salesforce org by removing obsolete Flow versions. Over time, multiple versions of Flows can accumulate, consuming storage and potentially impacting performance. This tool provides a controlled way to clean up these versions.\n\nKey functionalities:\n\n- **Targeted Flow Selection:** Allows you to filter Flow versions to delete by name (`--name`) and status (`--status`, e.g., `Obsolete`, `Draft`, `Inactive`).\n- **Flow Interview Deletion:** If a Flow version cannot be deleted due to active Flow Interviews, the `--delete-flow-interviews` flag (or interactive prompt) allows you to delete these interviews first, then retry the Flow version deletion.\n- **Confirmation Prompt:** In interactive mode, it prompts for confirmation before proceeding with the deletion of Flow versions and Flow Interviews.\n- **Partial Success Handling:** The `--allowpurgefailure` flag (default `true`) allows the command to continue even if some deletions fail, reporting the errors.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Queries (Tooling API):** It queries the `Flow` object (using the Tooling API) to list Flow versions based on the provided filters (name, status, manageable state).\n- **Bulk Deletion (Tooling API):** It uses `bulkDeleteTooling` to perform mass deletions of Flow versions. If deletion fails due to active interviews, it extracts the interview IDs.\n- **Flow Interview Management:** If `delete-flow-interviews` is enabled, it queries `FlowInterview` objects, performs bulk deletion of the identified interviews using `bulkDelete`, and then retries the Flow version deletion.\n- **Interactive Prompts:** Uses the `prompts` library to interact with the user for selecting Flows, statuses, and confirming deletion actions.\n- **Error Reporting:** Logs detailed error messages for failed deletions, including the specific reasons.\n- **Command-Line Execution:** Uses `execSfdxJson` to execute Salesforce CLI commands for querying Flow data.\n</details>\n",
6155
6166
  "examples": [
6156
- "$ sf hardis:org:diagnose:unsecure-connected-apps"
6167
+ "$ sf hardis:org:purge:flow",
6168
+ "$ sf hardis:org:purge:flow --target-org nicolas.vuillamy@gmail.com --no-prompt --delete-flow-interviews",
6169
+ "$ sf hardis:org:purge:flow --target-org nicolas.vuillamy@gmail.com --status \"Obsolete,Draft,InvalidDraft\" --name TestFlow"
6157
6170
  ],
6158
6171
  "flags": {
6159
6172
  "json": {
@@ -6171,10 +6184,48 @@
6171
6184
  "multiple": false,
6172
6185
  "type": "option"
6173
6186
  },
6174
- "outputfile": {
6187
+ "prompt": {
6188
+ "char": "z",
6189
+ "description": "Prompt for confirmation (true by default, use --no-prompt to skip)",
6190
+ "name": "prompt",
6191
+ "allowNo": true,
6192
+ "type": "boolean"
6193
+ },
6194
+ "name": {
6195
+ "char": "n",
6196
+ "description": "Filter according to Name criteria",
6197
+ "name": "name",
6198
+ "hasDynamicHelp": false,
6199
+ "multiple": false,
6200
+ "type": "option"
6201
+ },
6202
+ "status": {
6203
+ "char": "s",
6204
+ "description": "Filter according to Status criteria",
6205
+ "name": "status",
6206
+ "hasDynamicHelp": false,
6207
+ "multiple": false,
6208
+ "type": "option"
6209
+ },
6210
+ "delete-flow-interviews": {
6211
+ "char": "w",
6212
+ "description": "If the presence of Flow interviews prevent to delete flows versions, delete them before retrying to delete flow versions",
6213
+ "name": "delete-flow-interviews",
6214
+ "allowNo": false,
6215
+ "type": "boolean"
6216
+ },
6217
+ "allowpurgefailure": {
6175
6218
  "char": "f",
6176
- "description": "Force the path and name of output report file. Must end with .csv",
6177
- "name": "outputfile",
6219
+ "description": "Allows purges to fail without exiting with 1. Use --no-allowpurgefailure to disable",
6220
+ "name": "allowpurgefailure",
6221
+ "allowNo": true,
6222
+ "type": "boolean"
6223
+ },
6224
+ "instanceurl": {
6225
+ "char": "r",
6226
+ "description": "URL of org instance",
6227
+ "name": "instanceurl",
6228
+ "default": "https://login.salesforce.com",
6178
6229
  "hasDynamicHelp": false,
6179
6230
  "multiple": false,
6180
6231
  "type": "option"
@@ -6217,13 +6268,13 @@
6217
6268
  },
6218
6269
  "hasDynamicHelp": true,
6219
6270
  "hiddenAliases": [],
6220
- "id": "hardis:org:diagnose:unsecure-connected-apps",
6271
+ "id": "hardis:org:purge:flow",
6221
6272
  "pluginAlias": "sfdx-hardis",
6222
6273
  "pluginName": "sfdx-hardis",
6223
6274
  "pluginType": "core",
6224
6275
  "strict": true,
6225
6276
  "enableJsonFlag": true,
6226
- "title": "Detect Unsecured Connected Apps",
6277
+ "title": "Purge Flow versions",
6227
6278
  "requiresProject": false,
6228
6279
  "isESM": true,
6229
6280
  "relativePath": [
@@ -6231,44 +6282,46 @@
6231
6282
  "commands",
6232
6283
  "hardis",
6233
6284
  "org",
6234
- "diagnose",
6235
- "unsecure-connected-apps.js"
6285
+ "purge",
6286
+ "flow.js"
6236
6287
  ],
6237
6288
  "aliasPermutations": [],
6238
6289
  "permutations": [
6239
- "hardis:org:diagnose:unsecure-connected-apps",
6240
- "org:hardis:diagnose:unsecure-connected-apps",
6241
- "org:diagnose:hardis:unsecure-connected-apps",
6242
- "org:diagnose:unsecure-connected-apps:hardis",
6243
- "hardis:diagnose:org:unsecure-connected-apps",
6244
- "diagnose:hardis:org:unsecure-connected-apps",
6245
- "diagnose:org:hardis:unsecure-connected-apps",
6246
- "diagnose:org:unsecure-connected-apps:hardis",
6247
- "hardis:diagnose:unsecure-connected-apps:org",
6248
- "diagnose:hardis:unsecure-connected-apps:org",
6249
- "diagnose:unsecure-connected-apps:hardis:org",
6250
- "diagnose:unsecure-connected-apps:org:hardis",
6251
- "hardis:org:unsecure-connected-apps:diagnose",
6252
- "org:hardis:unsecure-connected-apps:diagnose",
6253
- "org:unsecure-connected-apps:hardis:diagnose",
6254
- "org:unsecure-connected-apps:diagnose:hardis",
6255
- "hardis:unsecure-connected-apps:org:diagnose",
6256
- "unsecure-connected-apps:hardis:org:diagnose",
6257
- "unsecure-connected-apps:org:hardis:diagnose",
6258
- "unsecure-connected-apps:org:diagnose:hardis",
6259
- "hardis:unsecure-connected-apps:diagnose:org",
6260
- "unsecure-connected-apps:hardis:diagnose:org",
6261
- "unsecure-connected-apps:diagnose:hardis:org",
6262
- "unsecure-connected-apps:diagnose:org:hardis"
6290
+ "hardis:org:purge:flow",
6291
+ "org:hardis:purge:flow",
6292
+ "org:purge:hardis:flow",
6293
+ "org:purge:flow:hardis",
6294
+ "hardis:purge:org:flow",
6295
+ "purge:hardis:org:flow",
6296
+ "purge:org:hardis:flow",
6297
+ "purge:org:flow:hardis",
6298
+ "hardis:purge:flow:org",
6299
+ "purge:hardis:flow:org",
6300
+ "purge:flow:hardis:org",
6301
+ "purge:flow:org:hardis",
6302
+ "hardis:org:flow:purge",
6303
+ "org:hardis:flow:purge",
6304
+ "org:flow:hardis:purge",
6305
+ "org:flow:purge:hardis",
6306
+ "hardis:flow:org:purge",
6307
+ "flow:hardis:org:purge",
6308
+ "flow:org:hardis:purge",
6309
+ "flow:org:purge:hardis",
6310
+ "hardis:flow:purge:org",
6311
+ "flow:hardis:purge:org",
6312
+ "flow:purge:hardis:org",
6313
+ "flow:purge:org:hardis"
6263
6314
  ]
6264
6315
  },
6265
- "hardis:org:diagnose:unused-apex-classes": {
6316
+ "hardis:org:diagnose:audittrail": {
6266
6317
  "aliases": [],
6267
6318
  "args": {},
6268
- "description": "List all async Apex classes (Batch,Queueable,Schedulable) that has not been called for more than 365 days.\n \nThe result class list probably can be removed from the project, and that will improve your test classes performances 😊\n\nThe number of unused day is overridable using --days option. \n\nThe command uses queries on AsyncApexJob and CronTrigger technical tables to build the result.\n\nApex Classes CreatedBy and CreatedOn fields are calculated from MIN(date from git, date from org)\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-unused-apex-classes/) and can output Grafana, Slack and MsTeams Notifications.\n\n![](https://sfdx-hardis.cloudity.com/assets/images/screenshot-monitoring-unused-apex-grafana.jpg)\n",
6319
+ "description": "Export Audit trail into a CSV file with selected criteria, and highlight suspect actions\n\nAlso detects updates of Custom Settings values (disable by defining `SKIP_AUDIT_TRAIL_CUSTOM_SETTINGS=true`)\n\nRegular setup actions performed in major orgs are filtered.\n\n- \"\"\n - createScratchOrg\n - changedsenderemail\n - deleteScratchOrg\n - loginasgrantedtopartnerbt\n- Certificate and Key Management\n - insertCertificate\n- Custom App Licenses\n - addeduserpackagelicense\n - granteduserpackagelicense\n - revokeduserpackagelicense\n- Customer Portal\n - createdcustomersuccessuser\n - CSPUserDisabled\n- Currency\n - updateddatedexchrate\n- Data Management\n - queueMembership\n- Email Administration\n - dkimRotationPreparationSuccessful\n - dkimRotationSuccessful\n- External Objects\n - xdsEncryptedFieldChange\n- Groups\n - groupMembership\n- Holidays\n - holiday_insert\n- Inbox mobile and legacy desktop apps\n - enableSIQUserNonEAC\n - siqUserAcceptedTOS\n- Manage Users\n - activateduser\n - createduser\n - changedcommunitynickname\n - changedemail\n - changedfederationid\n - changedpassword\n - changedinteractionuseroffon\n - changedinteractionuseronoff\n - changedmarketinguseroffon\n - changedmarketinguseronoff\n - changedofflineuseroffon\n - changedprofileforuserstdtostd\n - changedprofileforuser\n - changedprofileforusercusttostd\n - changedprofileforuserstdtocust\n - changedroleforusertonone\n - changedroleforuser\n - changedroleforuserfromnone\n - changedUserAdminVerifiedStatusVerified\n - changedUserEmailVerifiedStatusUnverified\n - changedUserEmailVerifiedStatusVerified\n - changedknowledgeuseroffon\n - changedsfcontentuseroffon\n - changedsupportuseroffon\n - changedusername\n - changedUserPhoneNumber\n - changedUserPhoneVerifiedStatusUnverified\n - changedUserPhoneVerifiedStatusVerified\n - deactivateduser\n - deleteAuthenticatorPairing\n - deleteTwoFactorInfo2\n - deleteTwoFactorTempCode\n - frozeuser\n - insertAuthenticatorPairing\n - insertTwoFactorInfo2\n - insertTwoFactorTempCode\n - lightningloginenroll\n - PermSetAssign\n - PermSetGroupAssign\n - PermSetGroupUnassign\n - PermSetLicenseAssign\n - PermSetUnassign\n - PermSetLicenseUnassign\n - registeredUserPhoneNumber\n - resetpassword\n - suNetworkAdminLogin\n - suNetworkAdminLogout\n - suOrgAdminLogin\n - suOrgAdminLogout\n - unfrozeuser\n - useremailchangesent\n- Mobile Administration\n - assigneduserstomobileconfig\n- Reporting Snapshots\n - createdReportJob\n - deletedReportJob\n- Sandboxes\n - DeleteSandbox\n\nBy default, deployment user defined in .sfdx-hardis.yml targetUsername property will be excluded.\n\nYou can define additional users to exclude in .sfdx-hardis.yml **monitoringExcludeUsernames** property.\n\nYou can also add more sections / actions considered as not suspect using property **monitoringAllowedSectionsActions**\n\nExample:\n\n```yaml\nmonitoringExcludeUsernames:\n - deploymentuser@cloudity.com\n - marketingcloud@cloudity.com\n - integration-user@cloudity.com\n\nmonitoringAllowedSectionsActions:\n \"Some section\": [] // Will ignore all actions from such section\n \"Some other section\": [\"actionType1\",\"actionType2\",\"actionType3\"] // Will ignore only those 3 actions from section \"Some other section\". Other actions in the same section will be considered as suspect.\n```\n\n## Excel output example\n\n![](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-monitoring-audittrail-excel.jpg)\n\n## Local output example\n\n![](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/screenshot-monitoring-audittrail-local.jpg)\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-suspect-audit-trail/) and can output Grafana, Slack and MsTeams Notifications.\n",
6269
6320
  "examples": [
6270
- "$ sf hardis:org:diagnose:unused-apex-classes",
6271
- "$ sf hardis:org:diagnose:unused-apex-classes --days 700"
6321
+ "$ sf hardis:org:diagnose:audittrail",
6322
+ "$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com",
6323
+ "$ sf hardis:org:diagnose:audittrail --excludeusers baptiste@titi.com,bertrand@titi.com",
6324
+ "$ sf hardis:org:diagnose:audittrail --lastndays 5"
6272
6325
  ],
6273
6326
  "flags": {
6274
6327
  "json": {
@@ -6286,18 +6339,26 @@
6286
6339
  "multiple": false,
6287
6340
  "type": "option"
6288
6341
  },
6289
- "outputfile": {
6290
- "char": "f",
6291
- "description": "Force the path and name of output report file. Must end with .csv",
6292
- "name": "outputfile",
6342
+ "excludeusers": {
6343
+ "char": "e",
6344
+ "description": "Comma-separated list of usernames to exclude",
6345
+ "name": "excludeusers",
6293
6346
  "hasDynamicHelp": false,
6294
6347
  "multiple": false,
6295
6348
  "type": "option"
6296
6349
  },
6297
- "days": {
6350
+ "lastndays": {
6298
6351
  "char": "t",
6299
- "description": "Extracts the users that have been inactive for the amount of days specified. In CI, default is 180 days",
6300
- "name": "days",
6352
+ "description": "Number of days to extract from today (included)",
6353
+ "name": "lastndays",
6354
+ "hasDynamicHelp": false,
6355
+ "multiple": false,
6356
+ "type": "option"
6357
+ },
6358
+ "outputfile": {
6359
+ "char": "f",
6360
+ "description": "Force the path and name of output report file. Must end with .csv",
6361
+ "name": "outputfile",
6301
6362
  "hasDynamicHelp": false,
6302
6363
  "multiple": false,
6303
6364
  "type": "option"
@@ -6340,13 +6401,13 @@
6340
6401
  },
6341
6402
  "hasDynamicHelp": true,
6342
6403
  "hiddenAliases": [],
6343
- "id": "hardis:org:diagnose:unused-apex-classes",
6404
+ "id": "hardis:org:diagnose:audittrail",
6344
6405
  "pluginAlias": "sfdx-hardis",
6345
6406
  "pluginName": "sfdx-hardis",
6346
6407
  "pluginType": "core",
6347
6408
  "strict": true,
6348
6409
  "enableJsonFlag": true,
6349
- "title": "Detect unused Apex classes in an org",
6410
+ "title": "Diagnose content of Setup Audit Trail",
6350
6411
  "requiresProject": false,
6351
6412
  "isESM": true,
6352
6413
  "relativePath": [
@@ -6355,42 +6416,42 @@
6355
6416
  "hardis",
6356
6417
  "org",
6357
6418
  "diagnose",
6358
- "unused-apex-classes.js"
6419
+ "audittrail.js"
6359
6420
  ],
6360
6421
  "aliasPermutations": [],
6361
6422
  "permutations": [
6362
- "hardis:org:diagnose:unused-apex-classes",
6363
- "org:hardis:diagnose:unused-apex-classes",
6364
- "org:diagnose:hardis:unused-apex-classes",
6365
- "org:diagnose:unused-apex-classes:hardis",
6366
- "hardis:diagnose:org:unused-apex-classes",
6367
- "diagnose:hardis:org:unused-apex-classes",
6368
- "diagnose:org:hardis:unused-apex-classes",
6369
- "diagnose:org:unused-apex-classes:hardis",
6370
- "hardis:diagnose:unused-apex-classes:org",
6371
- "diagnose:hardis:unused-apex-classes:org",
6372
- "diagnose:unused-apex-classes:hardis:org",
6373
- "diagnose:unused-apex-classes:org:hardis",
6374
- "hardis:org:unused-apex-classes:diagnose",
6375
- "org:hardis:unused-apex-classes:diagnose",
6376
- "org:unused-apex-classes:hardis:diagnose",
6377
- "org:unused-apex-classes:diagnose:hardis",
6378
- "hardis:unused-apex-classes:org:diagnose",
6379
- "unused-apex-classes:hardis:org:diagnose",
6380
- "unused-apex-classes:org:hardis:diagnose",
6381
- "unused-apex-classes:org:diagnose:hardis",
6382
- "hardis:unused-apex-classes:diagnose:org",
6383
- "unused-apex-classes:hardis:diagnose:org",
6384
- "unused-apex-classes:diagnose:hardis:org",
6385
- "unused-apex-classes:diagnose:org:hardis"
6423
+ "hardis:org:diagnose:audittrail",
6424
+ "org:hardis:diagnose:audittrail",
6425
+ "org:diagnose:hardis:audittrail",
6426
+ "org:diagnose:audittrail:hardis",
6427
+ "hardis:diagnose:org:audittrail",
6428
+ "diagnose:hardis:org:audittrail",
6429
+ "diagnose:org:hardis:audittrail",
6430
+ "diagnose:org:audittrail:hardis",
6431
+ "hardis:diagnose:audittrail:org",
6432
+ "diagnose:hardis:audittrail:org",
6433
+ "diagnose:audittrail:hardis:org",
6434
+ "diagnose:audittrail:org:hardis",
6435
+ "hardis:org:audittrail:diagnose",
6436
+ "org:hardis:audittrail:diagnose",
6437
+ "org:audittrail:hardis:diagnose",
6438
+ "org:audittrail:diagnose:hardis",
6439
+ "hardis:audittrail:org:diagnose",
6440
+ "audittrail:hardis:org:diagnose",
6441
+ "audittrail:org:hardis:diagnose",
6442
+ "audittrail:org:diagnose:hardis",
6443
+ "hardis:audittrail:diagnose:org",
6444
+ "audittrail:hardis:diagnose:org",
6445
+ "audittrail:diagnose:hardis:org",
6446
+ "audittrail:diagnose:org:hardis"
6386
6447
  ]
6387
6448
  },
6388
- "hardis:org:diagnose:unused-connected-apps": {
6449
+ "hardis:org:diagnose:instanceupgrade": {
6389
6450
  "aliases": [],
6390
6451
  "args": {},
6391
- "description": "\n## Command Behavior\n\n**Identifies and reports on potentially unused Connected Apps in a Salesforce org, suggesting candidates for deletion or deactivation.**\n\nThis command helps improve org security and reduce technical debt by pinpointing Connected Apps that are no longer actively used. Connected Apps can pose security risks if left unmonitored, and cleaning them up contributes to a healthier Salesforce environment.\n\nKey functionalities:\n\n- **Connected App Data Collection:** Gathers information about all Connected Apps in the org, including creation and last modified dates, and associated users.\n- **Usage Analysis:** Analyzes `LoginHistory` and `OAuthToken` records to determine the last usage date of each Connected App.\n- **Inactivity Detection:** Flags Connected Apps as potentially unused if they have no recent login history or OAuth token usage.\n- **Accessibility Check:** Examines Connected App metadata to identify if they are accessible (e.g., if they require admin approval and have no profiles or permission sets assigned).\n- **Ignored Apps:** Automatically ignores a predefined list of common Salesforce Connected Apps (e.g., `Salesforce CLI`, `Salesforce Mobile Dashboards`). You can extend this list by defining the `ALLOWED_INACTIVE_CONNECTED_APPS` environment variable.\n- **CSV Report Generation:** Generates a CSV file containing details of all analyzed Connected Apps, including their usage status, last usage date, and reasons for being flagged as potentially unused.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of potentially unused Connected Apps.\n\n**Default Ignored Connected Apps:**\n\n- Ant Migration Tool\n- Chatter Desktop\n- Chatter Mobile for BlackBerry\n- Force.com IDE\n- OIQ_Integration\n- Salesforce CLI\n- Salesforce Files\n- Salesforce Mobile Dashboards\n- Salesforce Touch\n- Salesforce for Outlook\n- SalesforceA\n- SalesforceA for Android\n- SalesforceA for iOS\n- SalesforceDX Namespace Registry\n- SalesforceIQ\n\nYou can add more ignored apps by defining a comma-separated list of names in the `ALLOWED_INACTIVE_CONNECTED_APPS` environment variable.\n\n_Example: \nALLOWED_INACTIVE_CONNECTED_APPS=My App 1,My App 2, My App 3_\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-unused-connected-apps/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Queries:** It performs SOQL queries against `ConnectedApplication`, `LoginHistory`, and `OAuthToken` objects to gather comprehensive data about Connected Apps and their usage.\n- **Temporary SFDX Project:** It creates a temporary SFDX project to retrieve Connected App metadata, allowing for local parsing and analysis of their XML files.\n- **Metadata Parsing:** It parses the `connectedApp-meta.xml` files to check for `isAdminApproved` and the presence of `profileName` or `permissionsetName` to determine accessibility.\n- **Data Correlation:** It correlates data from various Salesforce objects to build a complete picture of each Connected App's usage and status.\n- **Date Calculation:** Uses `moment` to calculate the time since the last OAuth token usage.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of unused Connected Apps.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **File System Operations:** Uses `fs-extra` for creating and removing temporary directories and files.\n- **Environment Variable Reading:** Reads the `ALLOWED_INACTIVE_CONNECTED_APPS` environment variable to customize the list of ignored Connected Apps.\n</details>\n",
6452
+ "description": "\n## Command Behavior\n\n**Retrieves and displays the scheduled upgrade date for a Salesforce org's instance.**\n\nThis command provides crucial information about when your Salesforce instance will be upgraded to the next major release (Spring, Summer, or Winter). This is vital for release planning, testing, and ensuring compatibility with upcoming Salesforce features.\n\nKey functionalities:\n\n- **Instance Identification:** Determines the Salesforce instance name of your target org.\n- **Upgrade Date Retrieval:** Fetches the planned start time of the next major core service upgrade for that instance from the Salesforce Status API.\n- **Days Until Upgrade:** Calculates and displays the number of days remaining until the next major upgrade.\n- **Severity-Based Logging:** Adjusts the log severity (info, warning) based on the proximity of the upgrade date, providing a visual cue for urgency.\n- **Notifications:** Sends notifications to configured channels (e.g., Slack, MS Teams, Grafana) with the upgrade information, making it suitable for automated monitoring.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Query:** It first queries the `Organization` object in Salesforce to get the `InstanceName` of the target org.\n- **Salesforce Status API Integration:** It makes an HTTP GET request to the Salesforce Status API (`https://api.status.salesforce.com/v1/instances/{instanceName}/status`) to retrieve detailed information about the instance, including scheduled maintenances.\n- **Data Parsing:** It parses the JSON response from the Status API to extract the relevant major release upgrade information.\n- **Date Calculation:** Uses the `moment` library to calculate the difference in days between the current date and the planned upgrade date.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including the instance name, upgrade date, and days remaining, along with relevant metrics for monitoring dashboards.\n- **User Feedback:** Provides clear messages to the user about the upgrade status and proximity.\n</details>\n",
6392
6453
  "examples": [
6393
- "$ sf hardis:org:diagnose:unused-connected-apps"
6454
+ "$ sf hardis:org:diagnose:instanceupgrade"
6394
6455
  ],
6395
6456
  "flags": {
6396
6457
  "json": {
@@ -6408,14 +6469,6 @@
6408
6469
  "multiple": false,
6409
6470
  "type": "option"
6410
6471
  },
6411
- "outputfile": {
6412
- "char": "f",
6413
- "description": "Force the path and name of output report file. Must end with .csv",
6414
- "name": "outputfile",
6415
- "hasDynamicHelp": false,
6416
- "multiple": false,
6417
- "type": "option"
6418
- },
6419
6472
  "debug": {
6420
6473
  "char": "d",
6421
6474
  "description": "Activate debug mode (more logs)",
@@ -6454,30 +6507,13 @@
6454
6507
  },
6455
6508
  "hasDynamicHelp": true,
6456
6509
  "hiddenAliases": [],
6457
- "id": "hardis:org:diagnose:unused-connected-apps",
6510
+ "id": "hardis:org:diagnose:instanceupgrade",
6458
6511
  "pluginAlias": "sfdx-hardis",
6459
6512
  "pluginName": "sfdx-hardis",
6460
6513
  "pluginType": "core",
6461
6514
  "strict": true,
6462
6515
  "enableJsonFlag": true,
6463
- "title": "Unused Connected Apps in an org",
6464
- "allowedInactiveConnectedApps": [
6465
- "Ant Migration Tool",
6466
- "Chatter Desktop",
6467
- "Chatter Mobile for BlackBerry",
6468
- "Force.com IDE",
6469
- "OIQ_Integration",
6470
- "Salesforce CLI",
6471
- "Salesforce Files",
6472
- "Salesforce Mobile Dashboards",
6473
- "Salesforce Touch",
6474
- "Salesforce for Outlook",
6475
- "SalesforceA",
6476
- "SalesforceA for Android",
6477
- "SalesforceA for iOS",
6478
- "SalesforceDX Namespace Registry",
6479
- "SalesforceIQ"
6480
- ],
6516
+ "title": "Get Instance Upgrade date",
6481
6517
  "requiresProject": false,
6482
6518
  "isESM": true,
6483
6519
  "relativePath": [
@@ -6486,43 +6522,45 @@
6486
6522
  "hardis",
6487
6523
  "org",
6488
6524
  "diagnose",
6489
- "unused-connected-apps.js"
6525
+ "instanceupgrade.js"
6490
6526
  ],
6491
6527
  "aliasPermutations": [],
6492
6528
  "permutations": [
6493
- "hardis:org:diagnose:unused-connected-apps",
6494
- "org:hardis:diagnose:unused-connected-apps",
6495
- "org:diagnose:hardis:unused-connected-apps",
6496
- "org:diagnose:unused-connected-apps:hardis",
6497
- "hardis:diagnose:org:unused-connected-apps",
6498
- "diagnose:hardis:org:unused-connected-apps",
6499
- "diagnose:org:hardis:unused-connected-apps",
6500
- "diagnose:org:unused-connected-apps:hardis",
6501
- "hardis:diagnose:unused-connected-apps:org",
6502
- "diagnose:hardis:unused-connected-apps:org",
6503
- "diagnose:unused-connected-apps:hardis:org",
6504
- "diagnose:unused-connected-apps:org:hardis",
6505
- "hardis:org:unused-connected-apps:diagnose",
6506
- "org:hardis:unused-connected-apps:diagnose",
6507
- "org:unused-connected-apps:hardis:diagnose",
6508
- "org:unused-connected-apps:diagnose:hardis",
6509
- "hardis:unused-connected-apps:org:diagnose",
6510
- "unused-connected-apps:hardis:org:diagnose",
6511
- "unused-connected-apps:org:hardis:diagnose",
6512
- "unused-connected-apps:org:diagnose:hardis",
6513
- "hardis:unused-connected-apps:diagnose:org",
6514
- "unused-connected-apps:hardis:diagnose:org",
6515
- "unused-connected-apps:diagnose:hardis:org",
6516
- "unused-connected-apps:diagnose:org:hardis"
6529
+ "hardis:org:diagnose:instanceupgrade",
6530
+ "org:hardis:diagnose:instanceupgrade",
6531
+ "org:diagnose:hardis:instanceupgrade",
6532
+ "org:diagnose:instanceupgrade:hardis",
6533
+ "hardis:diagnose:org:instanceupgrade",
6534
+ "diagnose:hardis:org:instanceupgrade",
6535
+ "diagnose:org:hardis:instanceupgrade",
6536
+ "diagnose:org:instanceupgrade:hardis",
6537
+ "hardis:diagnose:instanceupgrade:org",
6538
+ "diagnose:hardis:instanceupgrade:org",
6539
+ "diagnose:instanceupgrade:hardis:org",
6540
+ "diagnose:instanceupgrade:org:hardis",
6541
+ "hardis:org:instanceupgrade:diagnose",
6542
+ "org:hardis:instanceupgrade:diagnose",
6543
+ "org:instanceupgrade:hardis:diagnose",
6544
+ "org:instanceupgrade:diagnose:hardis",
6545
+ "hardis:instanceupgrade:org:diagnose",
6546
+ "instanceupgrade:hardis:org:diagnose",
6547
+ "instanceupgrade:org:hardis:diagnose",
6548
+ "instanceupgrade:org:diagnose:hardis",
6549
+ "hardis:instanceupgrade:diagnose:org",
6550
+ "instanceupgrade:hardis:diagnose:org",
6551
+ "instanceupgrade:diagnose:hardis:org",
6552
+ "instanceupgrade:diagnose:org:hardis"
6517
6553
  ]
6518
6554
  },
6519
- "hardis:org:diagnose:unusedlicenses": {
6555
+ "hardis:org:diagnose:legacyapi": {
6520
6556
  "aliases": [],
6521
6557
  "args": {},
6522
- "description": "\n## Command Behavior\n\n**Detects and suggests the deletion of unused Permission Set License Assignments in a Salesforce org.**\n\nWhen a Permission Set (PS) linked to a Permission Set License (PSL) is assigned to a user, a Permission Set License Assignment (PSLA) is automatically created. However, when that PS is unassigned from the user, the PSLA is *not* automatically deleted. This can lead to organizations being charged for unused PSLAs, representing a hidden cost and technical debt.\n\nThis command identifies such useless PSLAs and provides options to delete them, helping to optimize license usage and reduce unnecessary expenses.\n\nKey functionalities:\n\n- **PSLA Detection:** Queries the Salesforce org to find all active PSLAs.\n- **Usage Verification:** Correlates PSLAs with actual Permission Set Assignments and Permission Set Group Assignments to determine if the underlying Permission Sets are still assigned to the user.\n- **Special Case Handling:** Accounts for specific scenarios where profiles might implicitly assign PSLAs (e.g., `Salesforce API Only` profile assigning `SalesforceAPIIntegrationPsl`) and allows for always excluding certain PSLAs from the unused check.\n- **Reporting:** Generates a CSV report of all identified unused PSLAs, including the user and the associated Permission Set License.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of unused PSLAs.\n- **Interactive Deletion:** In non-CI environments, it offers an interactive prompt to bulk delete the identified unused PSLAs.\n\nMany thanks to [Vincent Finet](https://www.linkedin.com/in/vincentfinet/) for the inspiration during his great speaker session at [French Touch Dreamin '23](https://frenchtouchdreamin.com/), and his kind agreement for reusing such inspiration in this command 😊\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-unused-licenses/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves extensive querying of Salesforce objects and data correlation:\n\n- **SOQL Queries (Bulk API):** It uses `bulkQuery` and `bulkQueryChunksIn` to efficiently retrieve large volumes of data from `PermissionSetLicenseAssign`, `PermissionSetLicense`, `PermissionSet`, `PermissionSetGroupComponent`, and `PermissionSetAssignment` objects.\n- **Data Correlation:** It meticulously correlates data across these objects to determine if a `PermissionSetLicenseAssign` record has a corresponding active assignment to a Permission Set or Permission Set Group for the same user.\n- **Filtering Logic:** It applies complex filtering logic to exclude PSLAs that are genuinely in use or are part of predefined exceptions (e.g., `alwaysExcludeForActiveUsersPermissionSetLicenses`).\n- **Bulk Deletion:** If the user opts to delete unused PSLAs, it uses `bulkUpdate` with the `delete` operation to efficiently remove multiple records.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of unused PSLAs.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **User Interaction:** Uses `prompts` for interactive confirmation before performing deletion operations.\n</details>\n",
6558
+ "description": "Checks if an org uses retired or someday retired API version\n\n\nSee article below\n\n[![Handle Salesforce API versions Deprecation like a pro](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-deprecated-api.jpg)](https://nicolas.vuillamy.fr/handle-salesforce-api-versions-deprecation-like-a-pro-335065f52238)\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-deprecated-api-calls/) and can output Grafana, Slack and MsTeams Notifications.\n",
6523
6559
  "examples": [
6524
- "$ sf hardis:org:diagnose:unusedlicenses",
6525
- "$ sf hardis:org:diagnose:unusedlicenses --fix"
6560
+ "$ sf hardis:org:diagnose:legacyapi",
6561
+ "$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com",
6562
+ "$ sf hardis:org:diagnose:legacyapi --outputfile 'c:/path/to/folder/legacyapi.csv'",
6563
+ "$ sf hardis:org:diagnose:legacyapi -u hardis@myclient.com --outputfile ./tmp/legacyapi.csv"
6526
6564
  ],
6527
6565
  "flags": {
6528
6566
  "json": {
@@ -6540,6 +6578,24 @@
6540
6578
  "multiple": false,
6541
6579
  "type": "option"
6542
6580
  },
6581
+ "eventtype": {
6582
+ "char": "e",
6583
+ "description": "Type of EventLogFile event to analyze",
6584
+ "name": "eventtype",
6585
+ "default": "ApiTotalUsage",
6586
+ "hasDynamicHelp": false,
6587
+ "multiple": false,
6588
+ "type": "option"
6589
+ },
6590
+ "limit": {
6591
+ "char": "l",
6592
+ "description": "Number of latest EventLogFile events to analyze",
6593
+ "name": "limit",
6594
+ "default": 999,
6595
+ "hasDynamicHelp": false,
6596
+ "multiple": false,
6597
+ "type": "option"
6598
+ },
6543
6599
  "outputfile": {
6544
6600
  "char": "f",
6545
6601
  "description": "Force the path and name of output report file. Must end with .csv",
@@ -6586,32 +6642,14 @@
6586
6642
  },
6587
6643
  "hasDynamicHelp": true,
6588
6644
  "hiddenAliases": [],
6589
- "id": "hardis:org:diagnose:unusedlicenses",
6645
+ "id": "hardis:org:diagnose:legacyapi",
6590
6646
  "pluginAlias": "sfdx-hardis",
6591
6647
  "pluginName": "sfdx-hardis",
6592
6648
  "pluginType": "core",
6593
6649
  "strict": true,
6594
6650
  "enableJsonFlag": true,
6595
- "title": "Detect unused Permission Set Licenses (beta)",
6651
+ "title": "Check for legacy API use",
6596
6652
  "requiresProject": false,
6597
- "additionalPermissionSetsToAlwaysGet": [
6598
- "Sales_User"
6599
- ],
6600
- "permSetsPermSetLicenses": [
6601
- {
6602
- "permSet": "Sales_User",
6603
- "permSetLicense": "SalesUserPsl"
6604
- }
6605
- ],
6606
- "profilesPermissionSetLicenses": [
6607
- {
6608
- "profile": "Salesforce API Only",
6609
- "permSetLicense": "SalesforceAPIIntegrationPsl"
6610
- }
6611
- ],
6612
- "alwaysExcludeForActiveUsersPermissionSetLicenses": [
6613
- "IdentityConnect"
6614
- ],
6615
6653
  "isESM": true,
6616
6654
  "relativePath": [
6617
6655
  "lib",
@@ -6619,46 +6657,42 @@
6619
6657
  "hardis",
6620
6658
  "org",
6621
6659
  "diagnose",
6622
- "unusedlicenses.js"
6660
+ "legacyapi.js"
6623
6661
  ],
6624
6662
  "aliasPermutations": [],
6625
6663
  "permutations": [
6626
- "hardis:org:diagnose:unusedlicenses",
6627
- "org:hardis:diagnose:unusedlicenses",
6628
- "org:diagnose:hardis:unusedlicenses",
6629
- "org:diagnose:unusedlicenses:hardis",
6630
- "hardis:diagnose:org:unusedlicenses",
6631
- "diagnose:hardis:org:unusedlicenses",
6632
- "diagnose:org:hardis:unusedlicenses",
6633
- "diagnose:org:unusedlicenses:hardis",
6634
- "hardis:diagnose:unusedlicenses:org",
6635
- "diagnose:hardis:unusedlicenses:org",
6636
- "diagnose:unusedlicenses:hardis:org",
6637
- "diagnose:unusedlicenses:org:hardis",
6638
- "hardis:org:unusedlicenses:diagnose",
6639
- "org:hardis:unusedlicenses:diagnose",
6640
- "org:unusedlicenses:hardis:diagnose",
6641
- "org:unusedlicenses:diagnose:hardis",
6642
- "hardis:unusedlicenses:org:diagnose",
6643
- "unusedlicenses:hardis:org:diagnose",
6644
- "unusedlicenses:org:hardis:diagnose",
6645
- "unusedlicenses:org:diagnose:hardis",
6646
- "hardis:unusedlicenses:diagnose:org",
6647
- "unusedlicenses:hardis:diagnose:org",
6648
- "unusedlicenses:diagnose:hardis:org",
6649
- "unusedlicenses:diagnose:org:hardis"
6664
+ "hardis:org:diagnose:legacyapi",
6665
+ "org:hardis:diagnose:legacyapi",
6666
+ "org:diagnose:hardis:legacyapi",
6667
+ "org:diagnose:legacyapi:hardis",
6668
+ "hardis:diagnose:org:legacyapi",
6669
+ "diagnose:hardis:org:legacyapi",
6670
+ "diagnose:org:hardis:legacyapi",
6671
+ "diagnose:org:legacyapi:hardis",
6672
+ "hardis:diagnose:legacyapi:org",
6673
+ "diagnose:hardis:legacyapi:org",
6674
+ "diagnose:legacyapi:hardis:org",
6675
+ "diagnose:legacyapi:org:hardis",
6676
+ "hardis:org:legacyapi:diagnose",
6677
+ "org:hardis:legacyapi:diagnose",
6678
+ "org:legacyapi:hardis:diagnose",
6679
+ "org:legacyapi:diagnose:hardis",
6680
+ "hardis:legacyapi:org:diagnose",
6681
+ "legacyapi:hardis:org:diagnose",
6682
+ "legacyapi:org:hardis:diagnose",
6683
+ "legacyapi:org:diagnose:hardis",
6684
+ "hardis:legacyapi:diagnose:org",
6685
+ "legacyapi:hardis:diagnose:org",
6686
+ "legacyapi:diagnose:hardis:org",
6687
+ "legacyapi:diagnose:org:hardis"
6650
6688
  ]
6651
6689
  },
6652
- "hardis:org:diagnose:unusedusers": {
6690
+ "hardis:org:diagnose:licenses": {
6653
6691
  "aliases": [],
6654
6692
  "args": {},
6655
- "description": "\n## Command Behavior\n\n**Detects and reports on inactive or unused Salesforce user accounts, helping to optimize license usage and enhance security.**\n\nEfficient user management is vital in Salesforce to ensure resources are optimized and costs are controlled. However, inactive or unused user accounts can often go unnoticed, leading to wasted licenses and potential security risks. This tool addresses this challenge by enabling administrators to identify users who haven't logged in within a specified period.\n\nBy analyzing user login activity and last login timestamps, this feature highlights inactive user accounts, allowing administrators to take appropriate action. Whether it's deactivating dormant accounts, freeing up licenses, or ensuring compliance with security policies, this functionality empowers administrators to maintain a lean and secure Salesforce environment.\n\nKey functionalities:\n\n- **Inactivity Detection:** Identifies users who have not logged in for a specified number of days (`--days` flag, default 180 days in CI, 365 days otherwise).\n- **License Type Filtering:** Allows filtering users by license type using `--licensetypes` (e.g., `all-crm`, `all-paying`) or specific license identifiers using `--licenseidentifiers`.\n - `all-crm`: Includes `SFDC`, `AUL`, `AUL1`, `AULL_IGHT` licenses.\n - `all-paying`: Includes `SFDC`, `AUL`, `AUL1`, `AULL_IGHT`, `PID_Customer_Community`, `PID_Customer_Community_Login`, `PID_Partner_Community`, `PID_Partner_Community_Login` licenses.\n - Note: You can see the full list of available license identifiers in [Salesforce Documentation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/sfdx_cli_reference/sforce_api_objects_userlicense.htm).\n- **Active User Retrieval:** The `--returnactiveusers` flag inverts the command, allowing you to retrieve active users who *have* logged in during the specified period.\n- **CSV Report Generation:** Generates a CSV file containing details of all identified users (inactive or active), including their last login date, profile, and license information.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of inactive or active users.\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-inactive-users/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Query (Bulk API):** It uses `bulkQuery` to efficiently retrieve user records from the Salesforce `User` object. The SOQL query dynamically constructs its WHERE clause based on the `--days`, `--licensetypes`, `--licenseidentifiers`, and `--returnactiveusers` flags.\n- **Interactive Prompts:** Uses `prompts` to interactively ask the user for the number of inactive days and license types if not provided via flags.\n- **License Mapping:** Internally maps common license type aliases (e.g., `all-crm`) to their corresponding Salesforce `LicenseDefinitionKey` values.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of users.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **User Feedback:** Provides a summary of the findings in the console, indicating the number of inactive or active users found.\n</details>",
6693
+ "description": "\n**Lists and analyzes User Licenses and Permission Set Licenses subscribed and used in a Salesforce org.**\n\nThis command provides a comprehensive overview of your Salesforce license consumption. It's particularly useful for:\n\n- **License Management:** Understanding which licenses are active, how many are available, and how many are being used.\n- **Cost Optimization:** Identifying unused or underutilized licenses that could be reallocated or decommissioned.\n- **Compliance:** Ensuring that your organization is compliant with Salesforce licensing agreements.\n- **Monitoring:** Tracking license usage trends over time.\n\nKey functionalities:\n\n- **User License Details:** Retrieves information about standard and custom User Licenses, including `MasterLabel`, `Name`, `TotalLicenses`, and `UsedLicenses`.\n- **Permission Set License Details:** Retrieves information about Permission Set Licenses, including `MasterLabel`, `PermissionSetLicenseKey`, `TotalLicenses`, and `UsedLicenses`.\n- **Used Licenses Filter:** The `--usedonly` flag allows you to filter the report to show only licenses that have at least one `UsedLicenses` count greater than zero.\n- **CSV Report Generation:** Generates a CSV file containing all the retrieved license information, suitable for detailed analysis.\n- **Notifications:** Sends notifications to configured channels (e.g., Grafana, Slack, MS Teams) with a summary of license usage, including lists of active and used licenses.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Queries:** It executes SOQL queries against the `UserLicense` and `PermissionSetLicense` objects in Salesforce to retrieve license data.\n- **Data Transformation:** It processes the query results, reformatting the data to be more readable and consistent for reporting purposes (e.g., removing `Id` and `attributes`, renaming `PermissionSetLicenseKey` to `Name`).\n- **Data Aggregation:** It aggregates license information, creating a `licensesByKey` object for quick lookups and a `usedLicenses` array for a concise list of actively used licenses.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of license data.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **User Feedback:** Provides clear messages to the user about the license extraction process and the used licenses.\n</details>\n",
6656
6694
  "examples": [
6657
- "$ sf hardis:org:diagnose:unusedusers",
6658
- "$ sf hardis:org:diagnose:unusedusers --days 365",
6659
- "$ sf hardis:org:diagnose:unusedusers --days 60 --licensetypes all-crm",
6660
- "$ sf hardis:org:diagnose:unusedusers --days 60 --licenseidentifiers SFDC,AUL,AUL1",
6661
- "$ sf hardis:org:diagnose:unusedusers --days 60 --licensetypes all-crm --returnactiveusers"
6695
+ "$ sf hardis:org:diagnose:licenses"
6662
6696
  ],
6663
6697
  "flags": {
6664
6698
  "json": {
@@ -6684,38 +6718,10 @@
6684
6718
  "multiple": false,
6685
6719
  "type": "option"
6686
6720
  },
6687
- "days": {
6688
- "char": "t",
6689
- "description": "Extracts the users that have been inactive for the amount of days specified. In CI, default is 180 days",
6690
- "name": "days",
6691
- "hasDynamicHelp": false,
6692
- "multiple": false,
6693
- "type": "option"
6694
- },
6695
- "licensetypes": {
6696
- "char": "l",
6697
- "description": "Type of licenses to check. If set, do not use licenseidentifiers option. In CI, default is all-crm",
6698
- "name": "licensetypes",
6699
- "hasDynamicHelp": false,
6700
- "multiple": false,
6701
- "options": [
6702
- "all",
6703
- "all-crm",
6704
- "all-paying"
6705
- ],
6706
- "type": "option"
6707
- },
6708
- "licenseidentifiers": {
6709
- "char": "i",
6710
- "description": "Comma-separated list of license identifiers, in case licensetypes is not used.. Identifiers available at https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userlicense.htm",
6711
- "name": "licenseidentifiers",
6712
- "hasDynamicHelp": false,
6713
- "multiple": false,
6714
- "type": "option"
6715
- },
6716
- "returnactiveusers": {
6717
- "description": "Inverts the command by returning the active users",
6718
- "name": "returnactiveusers",
6721
+ "usedonly": {
6722
+ "char": "u",
6723
+ "description": "Filter to have only used licenses",
6724
+ "name": "usedonly",
6719
6725
  "allowNo": false,
6720
6726
  "type": "boolean"
6721
6727
  },
@@ -6757,13 +6763,13 @@
6757
6763
  },
6758
6764
  "hasDynamicHelp": true,
6759
6765
  "hiddenAliases": [],
6760
- "id": "hardis:org:diagnose:unusedusers",
6766
+ "id": "hardis:org:diagnose:licenses",
6761
6767
  "pluginAlias": "sfdx-hardis",
6762
6768
  "pluginName": "sfdx-hardis",
6763
6769
  "pluginType": "core",
6764
6770
  "strict": true,
6765
6771
  "enableJsonFlag": true,
6766
- "title": "Detect unused Users in Salesforce",
6772
+ "title": "List licenses subscribed and used in a Salesforce org",
6767
6773
  "requiresProject": false,
6768
6774
  "isESM": true,
6769
6775
  "relativePath": [
@@ -6772,42 +6778,42 @@
6772
6778
  "hardis",
6773
6779
  "org",
6774
6780
  "diagnose",
6775
- "unusedusers.js"
6781
+ "licenses.js"
6776
6782
  ],
6777
6783
  "aliasPermutations": [],
6778
6784
  "permutations": [
6779
- "hardis:org:diagnose:unusedusers",
6780
- "org:hardis:diagnose:unusedusers",
6781
- "org:diagnose:hardis:unusedusers",
6782
- "org:diagnose:unusedusers:hardis",
6783
- "hardis:diagnose:org:unusedusers",
6784
- "diagnose:hardis:org:unusedusers",
6785
- "diagnose:org:hardis:unusedusers",
6786
- "diagnose:org:unusedusers:hardis",
6787
- "hardis:diagnose:unusedusers:org",
6788
- "diagnose:hardis:unusedusers:org",
6789
- "diagnose:unusedusers:hardis:org",
6790
- "diagnose:unusedusers:org:hardis",
6791
- "hardis:org:unusedusers:diagnose",
6792
- "org:hardis:unusedusers:diagnose",
6793
- "org:unusedusers:hardis:diagnose",
6794
- "org:unusedusers:diagnose:hardis",
6795
- "hardis:unusedusers:org:diagnose",
6796
- "unusedusers:hardis:org:diagnose",
6797
- "unusedusers:org:hardis:diagnose",
6798
- "unusedusers:org:diagnose:hardis",
6799
- "hardis:unusedusers:diagnose:org",
6800
- "unusedusers:hardis:diagnose:org",
6801
- "unusedusers:diagnose:hardis:org",
6802
- "unusedusers:diagnose:org:hardis"
6785
+ "hardis:org:diagnose:licenses",
6786
+ "org:hardis:diagnose:licenses",
6787
+ "org:diagnose:hardis:licenses",
6788
+ "org:diagnose:licenses:hardis",
6789
+ "hardis:diagnose:org:licenses",
6790
+ "diagnose:hardis:org:licenses",
6791
+ "diagnose:org:hardis:licenses",
6792
+ "diagnose:org:licenses:hardis",
6793
+ "hardis:diagnose:licenses:org",
6794
+ "diagnose:hardis:licenses:org",
6795
+ "diagnose:licenses:hardis:org",
6796
+ "diagnose:licenses:org:hardis",
6797
+ "hardis:org:licenses:diagnose",
6798
+ "org:hardis:licenses:diagnose",
6799
+ "org:licenses:hardis:diagnose",
6800
+ "org:licenses:diagnose:hardis",
6801
+ "hardis:licenses:org:diagnose",
6802
+ "licenses:hardis:org:diagnose",
6803
+ "licenses:org:hardis:diagnose",
6804
+ "licenses:org:diagnose:hardis",
6805
+ "hardis:licenses:diagnose:org",
6806
+ "licenses:hardis:diagnose:org",
6807
+ "licenses:diagnose:hardis:org",
6808
+ "licenses:diagnose:org:hardis"
6803
6809
  ]
6804
6810
  },
6805
- "hardis:org:files:export": {
6811
+ "hardis:org:diagnose:releaseupdates": {
6806
6812
  "aliases": [],
6807
6813
  "args": {},
6808
- "description": "\n## Command Behavior\n\n**Exports file attachments (ContentVersion, Attachment) from a Salesforce org based on a predefined configuration.**\n\nThis command enables the mass download of files associated with Salesforce records, providing a robust solution for backing up files, migrating them to other systems, or integrating them with external document management solutions.\n\nKey functionalities:\n\n- **Configuration-Driven Export:** Relies on an `export.json` file within a designated file export project to define the export criteria, including the SOQL query for parent records, file types to export, output naming conventions, and file size filtering.\n- **File Size Filtering:** Supports minimum file size filtering via the `fileSizeMin` configuration parameter (in KB). Files smaller than the specified size will be skipped during export.\n- **File Validation:** After downloading each file, validates the integrity by:\n - **Checksum Validation:** For ContentVersion files, compares MD5 checksum with Salesforce's stored checksum\n - **Size Validation:** For both ContentVersion and Attachment files, verifies actual file size matches expected size\n - **Status Tracking:** Files are categorized with specific statuses: `success` (valid files), `failed` (download errors), `skipped` (filtered files), `invalid` (downloaded but failed validation)\n - All validation results are logged in the CSV export log for audit purposes\n- **Resume/Restart Capability:** \n - **Resume Mode:** When `--resume` flag is used (default in CI environments), checks existing downloaded files for validity. Valid files are skipped, invalid files are re-downloaded.\n - **Restart Mode:** When resume is disabled, clears the output folder and starts a fresh export.\n - **Interactive Mode:** When existing files are found and `--resume` is not explicitly specified (non-CI environments), prompts the user to choose between resume or restart.\n- **Interactive Project Selection:** If the file export project path is not provided via the `--path` flag, it interactively prompts the user to select one.\n- **Configurable Export Options:** Allows overriding default export settings such as `chunksize` (number of records processed in a batch), `polltimeout` (timeout for Bulk API calls), and `startchunknumber` (to resume a failed export).\n- **Support for ContentVersion and Attachment:** Handles both modern Salesforce Files (ContentVersion) and older Attachments.\n\nSee this article for a practical example:\n\n[![How to mass download notes and attachments files from a Salesforce org](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-mass-download.jpg)](https://nicolas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **FilesExporter Class:** The core logic is encapsulated within the `FilesExporter` class, which orchestrates the entire export process.\n- **SOQL Queries (Bulk API):** It uses Salesforce Bulk API queries to efficiently retrieve large volumes of parent record IDs and file metadata, including checksums and file sizes.\n- **File Download:** Downloads the actual file content from Salesforce.\n- **File Validation:** After each successful download, validates file integrity by comparing checksums (ContentVersion) and file sizes (both ContentVersion and Attachment) against Salesforce metadata.\n- **Resume Logic:** In resume mode, checks for existing files before downloading, validates their integrity, and only re-downloads invalid or missing files. This enables efficient recovery from interrupted exports.\n- **File System Operations:** Writes the downloaded files to the local file system, organizing them into folders based on the configured naming conventions.\n- **Configuration Loading:** Reads the `export.json` file to get the export configuration. It also allows for interactive overriding of these settings.\n- **Interactive Prompts:** Uses `selectFilesWorkspace` to allow the user to choose a file export project, `promptFilesExportConfiguration` for customizing export options, and prompts for resume/restart choice when existing files are found.\n- **Error Handling:** Includes mechanisms to handle potential errors during the export process, such as network issues, API limits, and file validation failures. Each file is assigned a specific status (`success`, `failed`, `skipped`, `invalid`) for comprehensive tracking and troubleshooting.\n</details>\n",
6814
+ "description": "Export Release Updates into a CSV file with selected criteria, and highlight Release Updates that should be checked.\n\nBefore publishing **Breaking Changes** ❌, Salesforce announce them in the setup menu [**Release Updates**](https://help.salesforce.com/s/articleView?id=sf.release_updates.htm&type=5)\n\n⚠️ Some of them are very important, because if you don't make the related upgrades in time (ex: before Winter 25) , your production org can crash !\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-release-updates/) and can output Grafana, Slack and MsTeams Notifications.\n",
6809
6815
  "examples": [
6810
- "$ sf hardis:org:files:export"
6816
+ "$ sf hardis:org:diagnose:releaseupdates"
6811
6817
  ],
6812
6818
  "flags": {
6813
6819
  "json": {
@@ -6825,48 +6831,14 @@
6825
6831
  "multiple": false,
6826
6832
  "type": "option"
6827
6833
  },
6828
- "path": {
6829
- "char": "p",
6830
- "description": "Path to the file export project",
6831
- "name": "path",
6832
- "hasDynamicHelp": false,
6833
- "multiple": false,
6834
- "type": "option"
6835
- },
6836
- "chunksize": {
6837
- "char": "c",
6838
- "description": "Number of records to add in a chunk before it is processed",
6839
- "name": "chunksize",
6840
- "default": 1000,
6841
- "hasDynamicHelp": false,
6842
- "multiple": false,
6843
- "type": "option"
6844
- },
6845
- "polltimeout": {
6846
- "char": "t",
6847
- "description": "Timeout in MS for Bulk API calls",
6848
- "name": "polltimeout",
6849
- "default": 300000,
6850
- "hasDynamicHelp": false,
6851
- "multiple": false,
6852
- "type": "option"
6853
- },
6854
- "startchunknumber": {
6855
- "char": "s",
6856
- "description": "Chunk number to start from",
6857
- "name": "startchunknumber",
6858
- "default": 0,
6834
+ "outputfile": {
6835
+ "char": "f",
6836
+ "description": "Force the path and name of output report file. Must end with .csv",
6837
+ "name": "outputfile",
6859
6838
  "hasDynamicHelp": false,
6860
6839
  "multiple": false,
6861
6840
  "type": "option"
6862
6841
  },
6863
- "resume": {
6864
- "char": "r",
6865
- "description": "Resume previous export by checking existing files (default in CI)",
6866
- "name": "resume",
6867
- "allowNo": false,
6868
- "type": "boolean"
6869
- },
6870
6842
  "debug": {
6871
6843
  "char": "d",
6872
6844
  "description": "Activate debug mode (more logs)",
@@ -6905,13 +6877,13 @@
6905
6877
  },
6906
6878
  "hasDynamicHelp": true,
6907
6879
  "hiddenAliases": [],
6908
- "id": "hardis:org:files:export",
6880
+ "id": "hardis:org:diagnose:releaseupdates",
6909
6881
  "pluginAlias": "sfdx-hardis",
6910
6882
  "pluginName": "sfdx-hardis",
6911
6883
  "pluginType": "core",
6912
6884
  "strict": true,
6913
6885
  "enableJsonFlag": true,
6914
- "title": "Export files",
6886
+ "title": "Check Release Updates of an org",
6915
6887
  "requiresProject": false,
6916
6888
  "isESM": true,
6917
6889
  "relativePath": [
@@ -6919,43 +6891,43 @@
6919
6891
  "commands",
6920
6892
  "hardis",
6921
6893
  "org",
6922
- "files",
6923
- "export.js"
6894
+ "diagnose",
6895
+ "releaseupdates.js"
6924
6896
  ],
6925
6897
  "aliasPermutations": [],
6926
6898
  "permutations": [
6927
- "hardis:org:files:export",
6928
- "org:hardis:files:export",
6929
- "org:files:hardis:export",
6930
- "org:files:export:hardis",
6931
- "hardis:files:org:export",
6932
- "files:hardis:org:export",
6933
- "files:org:hardis:export",
6934
- "files:org:export:hardis",
6935
- "hardis:files:export:org",
6936
- "files:hardis:export:org",
6937
- "files:export:hardis:org",
6938
- "files:export:org:hardis",
6939
- "hardis:org:export:files",
6940
- "org:hardis:export:files",
6941
- "org:export:hardis:files",
6942
- "org:export:files:hardis",
6943
- "hardis:export:org:files",
6944
- "export:hardis:org:files",
6945
- "export:org:hardis:files",
6946
- "export:org:files:hardis",
6947
- "hardis:export:files:org",
6948
- "export:hardis:files:org",
6949
- "export:files:hardis:org",
6950
- "export:files:org:hardis"
6899
+ "hardis:org:diagnose:releaseupdates",
6900
+ "org:hardis:diagnose:releaseupdates",
6901
+ "org:diagnose:hardis:releaseupdates",
6902
+ "org:diagnose:releaseupdates:hardis",
6903
+ "hardis:diagnose:org:releaseupdates",
6904
+ "diagnose:hardis:org:releaseupdates",
6905
+ "diagnose:org:hardis:releaseupdates",
6906
+ "diagnose:org:releaseupdates:hardis",
6907
+ "hardis:diagnose:releaseupdates:org",
6908
+ "diagnose:hardis:releaseupdates:org",
6909
+ "diagnose:releaseupdates:hardis:org",
6910
+ "diagnose:releaseupdates:org:hardis",
6911
+ "hardis:org:releaseupdates:diagnose",
6912
+ "org:hardis:releaseupdates:diagnose",
6913
+ "org:releaseupdates:hardis:diagnose",
6914
+ "org:releaseupdates:diagnose:hardis",
6915
+ "hardis:releaseupdates:org:diagnose",
6916
+ "releaseupdates:hardis:org:diagnose",
6917
+ "releaseupdates:org:hardis:diagnose",
6918
+ "releaseupdates:org:diagnose:hardis",
6919
+ "hardis:releaseupdates:diagnose:org",
6920
+ "releaseupdates:hardis:diagnose:org",
6921
+ "releaseupdates:diagnose:hardis:org",
6922
+ "releaseupdates:diagnose:org:hardis"
6951
6923
  ]
6952
6924
  },
6953
- "hardis:org:files:import": {
6925
+ "hardis:org:diagnose:unsecure-connected-apps": {
6954
6926
  "aliases": [],
6955
6927
  "args": {},
6956
- "description": "\nThis command facilitates the mass upload of files into Salesforce, allowing you to populate records with associated documents, images, or other file types. It's a crucial tool for data migration, content seeding, or synchronizing external file repositories with Salesforce.\n\nKey functionalities:\n\n- **Configuration-Driven Import:** Relies on an `export.json` file within a designated file export project (created using `sf hardis:org:configure:files`) to determine which files to import and how they should be associated with Salesforce records.\n- **Interactive Project Selection:** If the file import project path is not provided via the `--path` flag, it interactively prompts the user to select one.\n- **Overwrite Option:** The `--overwrite` flag allows you to replace existing files in Salesforce with local versions that have the same name. Be aware that this option doubles the number of API calls used.\n- **Support for ContentVersion and Attachment:** Handles both modern Salesforce Files (ContentVersion) and older Attachments.\n\nSee this article for how to export files, which is often a prerequisite for importing:\n\n[![How to mass download notes and attachments files from a Salesforce org](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-mass-download.jpg)](https://nicolas.vuillamy.fr/how-to-mass-download-notes-and-attachments-files-from-a-salesforce-org-83a028824afd)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **FilesImporter Class:** The core logic is encapsulated within the `FilesImporter` class, which orchestrates the entire import process.\n- **File System Scan:** Scans the local file system within the configured project directory to identify files for import.\n- **Salesforce API Interaction:** Uses Salesforce APIs (e.g., ContentVersion, Attachment) to upload files and associate them with records.\n- **Configuration Loading:** Reads the `export.json` file to get the import configuration, including SOQL queries to identify parent records for file association.\n- **Interactive Prompts:** Uses `selectFilesWorkspace` to allow the user to choose a file import project and `prompts` for confirming the overwrite behavior.\n- **Error Handling:** Includes mechanisms to handle potential errors during the import process, such as API limits or file upload failures.\n</details>\n",
6928
+ "description": "\n## Command Behavior\n\n**Detects unsecured Connected Apps in a Salesforce org and generates detailed reports for security analysis.**\n\nThis command is a critical security diagnostic tool that helps administrators identify Connected Apps that may pose security risks due to improper configuration. It provides comprehensive analysis of OAuth tokens and Connected App security settings to ensure proper access control.\n\nKey functionalities:\n\n- **OAuth Token Analysis:** Queries all OAuth tokens in the org using SOQL to retrieve comprehensive token information including app names, users, authorization status, and usage statistics.\n- **Security Status Assessment:** Evaluates each Connected App's security configuration by checking the `IsUsingAdminAuthorization` flag to determine if admin pre-approval is required.\n- **Unsecured App Detection:** Identifies Connected Apps that allow users to authorize themselves without admin approval, which can pose security risks.\n- **Detailed Reporting:** Generates two comprehensive CSV reports:\n - **OAuth Tokens Report:** Lists all OAuth tokens with security status, user information, and usage data\n - **Connected Apps Summary:** Aggregates unsecured Connected Apps with counts of associated OAuth tokens\n- **Visual Indicators:** Uses status icons (❌ for unsecured, for secured) to provide immediate visual feedback on security status.\n- **Security Recommendations:** Provides actionable guidance on how to secure Connected Apps through proper configuration.\n- **Notifications:** Sends alerts to configured channels (Grafana, Slack, MS Teams) with security findings and attached reports.\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-org-security/) and can output Grafana, Slack and MsTeams Notifications.\n\n<iframe width=\"560\" height=\"315\" src=\"https://www.youtube.com/embed/jHv8yrSK8Dg\" title=\"YouTube video player\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Query Execution:** Executes a comprehensive SOQL query on the `OauthToken` object, joining with `AppMenuItem` and `User` objects to gather complete security context.\n- **Security Analysis Logic:** Analyzes the `AppMenuItem.IsUsingAdminAuthorization` field to determine if a Connected App requires admin pre-approval for user authorization.\n- **Data Transformation:** Processes raw SOQL results to add security status indicators and reorganize data for optimal reporting and analysis.\n- **Aggregation Processing:** Groups OAuth tokens by Connected App name to provide summary statistics and identify the most problematic applications.\n- **Report Generation:** Uses `generateCsvFile` to create structured CSV reports with proper formatting and metadata for easy analysis and sharing.\n- **Notification Integration:** Integrates with the `NotifProvider` to send security alerts with detailed metrics, including the number of unsecured Connected Apps and associated OAuth tokens.\n- **File Management:** Generates multiple output formats (CSV, XLSX) and manages file paths using `generateReportPath` for consistent report organization.\n- **Connection Management:** Uses `setConnectionVariables` to ensure proper authentication context for notification providers that require org connection details.\n</details>\n",
6957
6929
  "examples": [
6958
- "$ sf hardis:org:files:import"
6930
+ "$ sf hardis:org:diagnose:unsecure-connected-apps"
6959
6931
  ],
6960
6932
  "flags": {
6961
6933
  "json": {
@@ -6973,21 +6945,14 @@
6973
6945
  "multiple": false,
6974
6946
  "type": "option"
6975
6947
  },
6976
- "path": {
6977
- "char": "p",
6978
- "description": "Path to the file export project",
6979
- "name": "path",
6948
+ "outputfile": {
6949
+ "char": "f",
6950
+ "description": "Force the path and name of output report file. Must end with .csv",
6951
+ "name": "outputfile",
6980
6952
  "hasDynamicHelp": false,
6981
6953
  "multiple": false,
6982
6954
  "type": "option"
6983
6955
  },
6984
- "overwrite": {
6985
- "char": "f",
6986
- "description": "Override existing files (doubles the number of API calls)",
6987
- "name": "overwrite",
6988
- "allowNo": false,
6989
- "type": "boolean"
6990
- },
6991
6956
  "debug": {
6992
6957
  "char": "d",
6993
6958
  "description": "Activate debug mode (more logs)",
@@ -7026,13 +6991,13 @@
7026
6991
  },
7027
6992
  "hasDynamicHelp": true,
7028
6993
  "hiddenAliases": [],
7029
- "id": "hardis:org:files:import",
6994
+ "id": "hardis:org:diagnose:unsecure-connected-apps",
7030
6995
  "pluginAlias": "sfdx-hardis",
7031
6996
  "pluginName": "sfdx-hardis",
7032
6997
  "pluginType": "core",
7033
6998
  "strict": true,
7034
6999
  "enableJsonFlag": true,
7035
- "title": "Import files",
7000
+ "title": "Detect Unsecured Connected Apps",
7036
7001
  "requiresProject": false,
7037
7002
  "isESM": true,
7038
7003
  "relativePath": [
@@ -7040,44 +7005,44 @@
7040
7005
  "commands",
7041
7006
  "hardis",
7042
7007
  "org",
7043
- "files",
7044
- "import.js"
7008
+ "diagnose",
7009
+ "unsecure-connected-apps.js"
7045
7010
  ],
7046
7011
  "aliasPermutations": [],
7047
7012
  "permutations": [
7048
- "hardis:org:files:import",
7049
- "org:hardis:files:import",
7050
- "org:files:hardis:import",
7051
- "org:files:import:hardis",
7052
- "hardis:files:org:import",
7053
- "files:hardis:org:import",
7054
- "files:org:hardis:import",
7055
- "files:org:import:hardis",
7056
- "hardis:files:import:org",
7057
- "files:hardis:import:org",
7058
- "files:import:hardis:org",
7059
- "files:import:org:hardis",
7060
- "hardis:org:import:files",
7061
- "org:hardis:import:files",
7062
- "org:import:hardis:files",
7063
- "org:import:files:hardis",
7064
- "hardis:import:org:files",
7065
- "import:hardis:org:files",
7066
- "import:org:hardis:files",
7067
- "import:org:files:hardis",
7068
- "hardis:import:files:org",
7069
- "import:hardis:files:org",
7070
- "import:files:hardis:org",
7071
- "import:files:org:hardis"
7013
+ "hardis:org:diagnose:unsecure-connected-apps",
7014
+ "org:hardis:diagnose:unsecure-connected-apps",
7015
+ "org:diagnose:hardis:unsecure-connected-apps",
7016
+ "org:diagnose:unsecure-connected-apps:hardis",
7017
+ "hardis:diagnose:org:unsecure-connected-apps",
7018
+ "diagnose:hardis:org:unsecure-connected-apps",
7019
+ "diagnose:org:hardis:unsecure-connected-apps",
7020
+ "diagnose:org:unsecure-connected-apps:hardis",
7021
+ "hardis:diagnose:unsecure-connected-apps:org",
7022
+ "diagnose:hardis:unsecure-connected-apps:org",
7023
+ "diagnose:unsecure-connected-apps:hardis:org",
7024
+ "diagnose:unsecure-connected-apps:org:hardis",
7025
+ "hardis:org:unsecure-connected-apps:diagnose",
7026
+ "org:hardis:unsecure-connected-apps:diagnose",
7027
+ "org:unsecure-connected-apps:hardis:diagnose",
7028
+ "org:unsecure-connected-apps:diagnose:hardis",
7029
+ "hardis:unsecure-connected-apps:org:diagnose",
7030
+ "unsecure-connected-apps:hardis:org:diagnose",
7031
+ "unsecure-connected-apps:org:hardis:diagnose",
7032
+ "unsecure-connected-apps:org:diagnose:hardis",
7033
+ "hardis:unsecure-connected-apps:diagnose:org",
7034
+ "unsecure-connected-apps:hardis:diagnose:org",
7035
+ "unsecure-connected-apps:diagnose:hardis:org",
7036
+ "unsecure-connected-apps:diagnose:org:hardis"
7072
7037
  ]
7073
7038
  },
7074
- "hardis:org:fix:listviewmine": {
7039
+ "hardis:org:diagnose:unused-apex-classes": {
7075
7040
  "aliases": [],
7076
7041
  "args": {},
7077
- "description": "Fix listviews whose scope Mine has been replaced by Everything\n\n[![Invalid scope:Mine, not allowed ? Deploy your ListViews anyway !](https://github.com/hardisgroupcom/sfdx-hardis/raw/main/docs/assets/images/article-invalid-scope-mine.jpg)](https://nicolas.vuillamy.fr/invalid-scope-mine-not-allowed-deploy-your-listviews-anyway-443aceca8ac7)\n\nList of ListViews can be:\n\n- read from .sfdx-hardis.yml file in property **listViewsToSetToMine**\n- sent in argument listviews\n\nNote: property **listViewsToSetToMine** can be auto-generated by command hardis:work:save if .sfdx-hardis.yml contains the following configuration\n\n```yaml\nautoCleanTypes:\n - listViewsMine\n```\n\n- Example of sfdx-hardis.yml property `listViewsToSetToMine`:\n\n```yaml\nlistViewsToSetToMine:\n - \"force-app/main/default/objects/Operation__c/listViews/MyCurrentOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Operation__c/listViews/MyFinalizedOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/Default_Opportunity_Pipeline.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MyCurrentSubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MySubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Account/listViews/MyActivePartners.listView-meta.xml\"\n```\n\n- If manually written, this could also be:\n\n```yaml\nlistViewsToSetToMine:\n - \"Operation__c:MyCurrentOperations\"\n - \"Operation__c:MyFinalizedOperations\"\n - \"Opportunity:Default_Opportunity_Pipeline\"\n - \"Opportunity:MyCurrentSubscriptions\"\n - \"Opportunity:MySubscriptions\"\n - \"Account:MyActivePartners\"\n```\n\nTroubleshooting: if you need to run this command from an alpine-linux based docker image, use this workaround in your dockerfile:\n\n```dockerfile\n# Do not use puppeteer embedded chromium\nRUN apk add --update --no-cache chromium\nENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=\"true\"\nENV CHROMIUM_PATH=\"/usr/bin/chromium-browser\"\nENV PUPPETEER_EXECUTABLE_PATH=\"$\\{CHROMIUM_PATH}\" // remove \\ before {\n```\n",
7042
+ "description": "List all async Apex classes (Batch,Queueable,Schedulable) that has not been called for more than 365 days.\n \nThe result class list probably can be removed from the project, and that will improve your test classes performances 😊\n\nThe number of unused day is overridable using --days option. \n\nThe command uses queries on AsyncApexJob and CronTrigger technical tables to build the result.\n\nApex Classes CreatedBy and CreatedOn fields are calculated from MIN(date from git, date from org)\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-unused-apex-classes/) and can output Grafana, Slack and MsTeams Notifications.\n\n![](https://sfdx-hardis.cloudity.com/assets/images/screenshot-monitoring-unused-apex-grafana.jpg)\n",
7078
7043
  "examples": [
7079
- "$ sf hardis:org:fix:listviewmine",
7080
- "$ sf hardis:org:fix:listviewmine --listviews Opportunity:MySubscriptions,Account:MyActivePartners"
7044
+ "$ sf hardis:org:diagnose:unused-apex-classes",
7045
+ "$ sf hardis:org:diagnose:unused-apex-classes --days 700"
7081
7046
  ],
7082
7047
  "flags": {
7083
7048
  "json": {
@@ -7095,10 +7060,18 @@
7095
7060
  "multiple": false,
7096
7061
  "type": "option"
7097
7062
  },
7098
- "listviews": {
7099
- "char": "l",
7100
- "description": "Comma-separated list of listviews following format Object:ListViewName\nExample: Contact:MyContacts,Contact:MyActiveContacts,Opportunity:MYClosedOpportunities",
7101
- "name": "listviews",
7063
+ "outputfile": {
7064
+ "char": "f",
7065
+ "description": "Force the path and name of output report file. Must end with .csv",
7066
+ "name": "outputfile",
7067
+ "hasDynamicHelp": false,
7068
+ "multiple": false,
7069
+ "type": "option"
7070
+ },
7071
+ "days": {
7072
+ "char": "t",
7073
+ "description": "Extracts the users that have been inactive for the amount of days specified. In CI, default is 180 days",
7074
+ "name": "days",
7102
7075
  "hasDynamicHelp": false,
7103
7076
  "multiple": false,
7104
7077
  "type": "option"
@@ -7141,59 +7114,57 @@
7141
7114
  },
7142
7115
  "hasDynamicHelp": true,
7143
7116
  "hiddenAliases": [],
7144
- "id": "hardis:org:fix:listviewmine",
7117
+ "id": "hardis:org:diagnose:unused-apex-classes",
7145
7118
  "pluginAlias": "sfdx-hardis",
7146
7119
  "pluginName": "sfdx-hardis",
7147
7120
  "pluginType": "core",
7148
7121
  "strict": true,
7149
7122
  "enableJsonFlag": true,
7150
- "title": "Fix listviews with ",
7151
- "requiresProject": true,
7123
+ "title": "Detect unused Apex classes in an org",
7124
+ "requiresProject": false,
7152
7125
  "isESM": true,
7153
7126
  "relativePath": [
7154
7127
  "lib",
7155
7128
  "commands",
7156
7129
  "hardis",
7157
7130
  "org",
7158
- "fix",
7159
- "listviewmine.js"
7131
+ "diagnose",
7132
+ "unused-apex-classes.js"
7160
7133
  ],
7161
7134
  "aliasPermutations": [],
7162
7135
  "permutations": [
7163
- "hardis:org:fix:listviewmine",
7164
- "org:hardis:fix:listviewmine",
7165
- "org:fix:hardis:listviewmine",
7166
- "org:fix:listviewmine:hardis",
7167
- "hardis:fix:org:listviewmine",
7168
- "fix:hardis:org:listviewmine",
7169
- "fix:org:hardis:listviewmine",
7170
- "fix:org:listviewmine:hardis",
7171
- "hardis:fix:listviewmine:org",
7172
- "fix:hardis:listviewmine:org",
7173
- "fix:listviewmine:hardis:org",
7174
- "fix:listviewmine:org:hardis",
7175
- "hardis:org:listviewmine:fix",
7176
- "org:hardis:listviewmine:fix",
7177
- "org:listviewmine:hardis:fix",
7178
- "org:listviewmine:fix:hardis",
7179
- "hardis:listviewmine:org:fix",
7180
- "listviewmine:hardis:org:fix",
7181
- "listviewmine:org:hardis:fix",
7182
- "listviewmine:org:fix:hardis",
7183
- "hardis:listviewmine:fix:org",
7184
- "listviewmine:hardis:fix:org",
7185
- "listviewmine:fix:hardis:org",
7186
- "listviewmine:fix:org:hardis"
7136
+ "hardis:org:diagnose:unused-apex-classes",
7137
+ "org:hardis:diagnose:unused-apex-classes",
7138
+ "org:diagnose:hardis:unused-apex-classes",
7139
+ "org:diagnose:unused-apex-classes:hardis",
7140
+ "hardis:diagnose:org:unused-apex-classes",
7141
+ "diagnose:hardis:org:unused-apex-classes",
7142
+ "diagnose:org:hardis:unused-apex-classes",
7143
+ "diagnose:org:unused-apex-classes:hardis",
7144
+ "hardis:diagnose:unused-apex-classes:org",
7145
+ "diagnose:hardis:unused-apex-classes:org",
7146
+ "diagnose:unused-apex-classes:hardis:org",
7147
+ "diagnose:unused-apex-classes:org:hardis",
7148
+ "hardis:org:unused-apex-classes:diagnose",
7149
+ "org:hardis:unused-apex-classes:diagnose",
7150
+ "org:unused-apex-classes:hardis:diagnose",
7151
+ "org:unused-apex-classes:diagnose:hardis",
7152
+ "hardis:unused-apex-classes:org:diagnose",
7153
+ "unused-apex-classes:hardis:org:diagnose",
7154
+ "unused-apex-classes:org:hardis:diagnose",
7155
+ "unused-apex-classes:org:diagnose:hardis",
7156
+ "hardis:unused-apex-classes:diagnose:org",
7157
+ "unused-apex-classes:hardis:diagnose:org",
7158
+ "unused-apex-classes:diagnose:hardis:org",
7159
+ "unused-apex-classes:diagnose:org:hardis"
7187
7160
  ]
7188
7161
  },
7189
- "hardis:org:generate:packagexmlfull": {
7162
+ "hardis:org:diagnose:unused-connected-apps": {
7190
7163
  "aliases": [],
7191
7164
  "args": {},
7192
- "description": "\n## Command Behavior\n\n**Generates a comprehensive `package.xml` file for a Salesforce org, including all metadata components, even managed ones.**\n\nThis command is essential for various Salesforce development and administration tasks, especially when you need a complete snapshot of an org's metadata. It goes beyond typical source tracking by including managed package components, which is crucial for understanding the full metadata footprint of an org.\n\nKey functionalities:\n\n- **Full Org Metadata Retrieval:** Connects to a specified Salesforce org (or prompts for one if not provided) and retrieves a complete list of all metadata types and their members.\n- **Managed Package Inclusion:** Unlike standard source retrieval, this command explicitly includes metadata from managed packages, providing a truly comprehensive `package.xml`.\n- **Customizable Output:** Allows you to specify the output file path for the generated `package.xml`.\n- **Interactive Org Selection:** If no target org is specified, it interactively prompts the user to choose an org. (or use --no-prompt to skip this step)\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce Metadata API Interaction:** It leverages the Salesforce Metadata API to list all available metadata types and then retrieve all components for each type.\n- **`buildOrgManifest` Utility:** The core logic for querying the org's metadata and constructing the `package.xml` is encapsulated within the `buildOrgManifest` utility function.\n- **XML Generation:** It dynamically builds the XML structure of the `package.xml` file, including the `types` and `members` elements for all retrieved metadata.\n- **File System Operations:** It writes the generated `package.xml` file to the specified output path.\n- **Interactive Prompts:** Uses `promptOrgUsernameDefault` to guide the user in selecting the target Salesforce org.\n</details>\n",
7165
+ "description": "\n## Command Behavior\n\n**Identifies and reports on potentially unused Connected Apps in a Salesforce org, suggesting candidates for deletion or deactivation.**\n\nThis command helps improve org security and reduce technical debt by pinpointing Connected Apps that are no longer actively used. Connected Apps can pose security risks if left unmonitored, and cleaning them up contributes to a healthier Salesforce environment.\n\nKey functionalities:\n\n- **Connected App Data Collection:** Gathers information about all Connected Apps in the org, including creation and last modified dates, and associated users.\n- **Usage Analysis:** Analyzes `LoginHistory` and `OAuthToken` records to determine the last usage date of each Connected App.\n- **Inactivity Detection:** Flags Connected Apps as potentially unused if they have no recent login history or OAuth token usage.\n- **Accessibility Check:** Examines Connected App metadata to identify if they are accessible (e.g., if they require admin approval and have no profiles or permission sets assigned).\n- **Ignored Apps:** Automatically ignores a predefined list of common Salesforce Connected Apps (e.g., `Salesforce CLI`, `Salesforce Mobile Dashboards`). You can extend this list by defining the `ALLOWED_INACTIVE_CONNECTED_APPS` environment variable.\n- **CSV Report Generation:** Generates a CSV file containing details of all analyzed Connected Apps, including their usage status, last usage date, and reasons for being flagged as potentially unused.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of potentially unused Connected Apps.\n\n**Default Ignored Connected Apps:**\n\n- Ant Migration Tool\n- Chatter Desktop\n- Chatter Mobile for BlackBerry\n- Force.com IDE\n- OIQ_Integration\n- Salesforce CLI\n- Salesforce Files\n- Salesforce Mobile Dashboards\n- Salesforce Touch\n- Salesforce for Outlook\n- SalesforceA\n- SalesforceA for Android\n- SalesforceA for iOS\n- SalesforceDX Namespace Registry\n- SalesforceIQ\n\nYou can add more ignored apps by defining a comma-separated list of names in the `ALLOWED_INACTIVE_CONNECTED_APPS` environment variable.\n\n_Example: \nALLOWED_INACTIVE_CONNECTED_APPS=My App 1,My App 2, My App 3_\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-unused-connected-apps/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce SOQL Queries:** It performs SOQL queries against `ConnectedApplication`, `LoginHistory`, and `OAuthToken` objects to gather comprehensive data about Connected Apps and their usage.\n- **Temporary SFDX Project:** It creates a temporary SFDX project to retrieve Connected App metadata, allowing for local parsing and analysis of their XML files.\n- **Metadata Parsing:** It parses the `connectedApp-meta.xml` files to check for `isAdminApproved` and the presence of `profileName` or `permissionsetName` to determine accessibility.\n- **Data Correlation:** It correlates data from various Salesforce objects to build a complete picture of each Connected App's usage and status.\n- **Date Calculation:** Uses `moment` to calculate the time since the last OAuth token usage.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of unused Connected Apps.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **File System Operations:** Uses `fs-extra` for creating and removing temporary directories and files.\n- **Environment Variable Reading:** Reads the `ALLOWED_INACTIVE_CONNECTED_APPS` environment variable to customize the list of ignored Connected Apps.\n</details>\n",
7193
7166
  "examples": [
7194
- "$ sf hardis:org:generate:packagexmlfull",
7195
- "$ sf hardis:org:generate:packagexmlfull --outputfile /tmp/packagexmlfull.xml",
7196
- "$ sf hardis:org:generate:packagexmlfull --target-org nico@example.com"
7167
+ "$ sf hardis:org:diagnose:unused-connected-apps"
7197
7168
  ],
7198
7169
  "flags": {
7199
7170
  "json": {
@@ -7212,7 +7183,8 @@
7212
7183
  "type": "option"
7213
7184
  },
7214
7185
  "outputfile": {
7215
- "description": "Output package.xml file",
7186
+ "char": "f",
7187
+ "description": "Force the path and name of output report file. Must end with .csv",
7216
7188
  "name": "outputfile",
7217
7189
  "hasDynamicHelp": false,
7218
7190
  "multiple": false,
@@ -7225,13 +7197,6 @@
7225
7197
  "allowNo": false,
7226
7198
  "type": "boolean"
7227
7199
  },
7228
- "no-prompt": {
7229
- "char": "n",
7230
- "description": "Do not prompt for org username, use the default one",
7231
- "name": "no-prompt",
7232
- "allowNo": false,
7233
- "type": "boolean"
7234
- },
7235
7200
  "websocket": {
7236
7201
  "description": "Websocket host:port for VsCode SFDX Hardis UI integration",
7237
7202
  "name": "websocket",
@@ -7263,13 +7228,30 @@
7263
7228
  },
7264
7229
  "hasDynamicHelp": true,
7265
7230
  "hiddenAliases": [],
7266
- "id": "hardis:org:generate:packagexmlfull",
7231
+ "id": "hardis:org:diagnose:unused-connected-apps",
7267
7232
  "pluginAlias": "sfdx-hardis",
7268
7233
  "pluginName": "sfdx-hardis",
7269
7234
  "pluginType": "core",
7270
7235
  "strict": true,
7271
7236
  "enableJsonFlag": true,
7272
- "title": "Generate Full Org package.xml",
7237
+ "title": "Unused Connected Apps in an org",
7238
+ "allowedInactiveConnectedApps": [
7239
+ "Ant Migration Tool",
7240
+ "Chatter Desktop",
7241
+ "Chatter Mobile for BlackBerry",
7242
+ "Force.com IDE",
7243
+ "OIQ_Integration",
7244
+ "Salesforce CLI",
7245
+ "Salesforce Files",
7246
+ "Salesforce Mobile Dashboards",
7247
+ "Salesforce Touch",
7248
+ "Salesforce for Outlook",
7249
+ "SalesforceA",
7250
+ "SalesforceA for Android",
7251
+ "SalesforceA for iOS",
7252
+ "SalesforceDX Namespace Registry",
7253
+ "SalesforceIQ"
7254
+ ],
7273
7255
  "requiresProject": false,
7274
7256
  "isESM": true,
7275
7257
  "relativePath": [
@@ -7277,43 +7259,44 @@
7277
7259
  "commands",
7278
7260
  "hardis",
7279
7261
  "org",
7280
- "generate",
7281
- "packagexmlfull.js"
7262
+ "diagnose",
7263
+ "unused-connected-apps.js"
7282
7264
  ],
7283
7265
  "aliasPermutations": [],
7284
7266
  "permutations": [
7285
- "hardis:org:generate:packagexmlfull",
7286
- "org:hardis:generate:packagexmlfull",
7287
- "org:generate:hardis:packagexmlfull",
7288
- "org:generate:packagexmlfull:hardis",
7289
- "hardis:generate:org:packagexmlfull",
7290
- "generate:hardis:org:packagexmlfull",
7291
- "generate:org:hardis:packagexmlfull",
7292
- "generate:org:packagexmlfull:hardis",
7293
- "hardis:generate:packagexmlfull:org",
7294
- "generate:hardis:packagexmlfull:org",
7295
- "generate:packagexmlfull:hardis:org",
7296
- "generate:packagexmlfull:org:hardis",
7297
- "hardis:org:packagexmlfull:generate",
7298
- "org:hardis:packagexmlfull:generate",
7299
- "org:packagexmlfull:hardis:generate",
7300
- "org:packagexmlfull:generate:hardis",
7301
- "hardis:packagexmlfull:org:generate",
7302
- "packagexmlfull:hardis:org:generate",
7303
- "packagexmlfull:org:hardis:generate",
7304
- "packagexmlfull:org:generate:hardis",
7305
- "hardis:packagexmlfull:generate:org",
7306
- "packagexmlfull:hardis:generate:org",
7307
- "packagexmlfull:generate:hardis:org",
7308
- "packagexmlfull:generate:org:hardis"
7267
+ "hardis:org:diagnose:unused-connected-apps",
7268
+ "org:hardis:diagnose:unused-connected-apps",
7269
+ "org:diagnose:hardis:unused-connected-apps",
7270
+ "org:diagnose:unused-connected-apps:hardis",
7271
+ "hardis:diagnose:org:unused-connected-apps",
7272
+ "diagnose:hardis:org:unused-connected-apps",
7273
+ "diagnose:org:hardis:unused-connected-apps",
7274
+ "diagnose:org:unused-connected-apps:hardis",
7275
+ "hardis:diagnose:unused-connected-apps:org",
7276
+ "diagnose:hardis:unused-connected-apps:org",
7277
+ "diagnose:unused-connected-apps:hardis:org",
7278
+ "diagnose:unused-connected-apps:org:hardis",
7279
+ "hardis:org:unused-connected-apps:diagnose",
7280
+ "org:hardis:unused-connected-apps:diagnose",
7281
+ "org:unused-connected-apps:hardis:diagnose",
7282
+ "org:unused-connected-apps:diagnose:hardis",
7283
+ "hardis:unused-connected-apps:org:diagnose",
7284
+ "unused-connected-apps:hardis:org:diagnose",
7285
+ "unused-connected-apps:org:hardis:diagnose",
7286
+ "unused-connected-apps:org:diagnose:hardis",
7287
+ "hardis:unused-connected-apps:diagnose:org",
7288
+ "unused-connected-apps:hardis:diagnose:org",
7289
+ "unused-connected-apps:diagnose:hardis:org",
7290
+ "unused-connected-apps:diagnose:org:hardis"
7309
7291
  ]
7310
7292
  },
7311
- "hardis:org:monitor:all": {
7293
+ "hardis:org:diagnose:unusedlicenses": {
7312
7294
  "aliases": [],
7313
7295
  "args": {},
7314
- "description": "Monitor org, generate reports and sends notifications\n\nYou can disable some commands defining either a **monitoringDisable** property in `.sfdx-hardis.yml`, or a comma separated list in env variable **MONITORING_DISABLE**\n\nExample in .sfdx-hardis.yml:\n \n```yaml\nmonitoringDisable:\n - METADATA_STATUS\n - MISSING_ATTRIBUTES\n - UNUSED_METADATAS\n```\n \nExample in env var:\n\n```sh\nMONITORING_DISABLE=METADATA_STATUS,MISSING_ATTRIBUTES,UNUSED_METADATAS\n```\n\nA [default list of monitoring commands](https://sfdx-hardis.cloudity.com/salesforce-monitoring-home/#monitoring-commands) is used, if you want to override it you can define property **monitoringCommands** in your .sfdx-hardis.yml file\n\nExample:\n\n```yaml\nmonitoringCommands:\n - title: My Custom command\n command: sf my:custom:command\n - title: My Custom command 2\n command: sf my:other:custom:command\n```\n\nYou can force the daily run of all commands by defining env var `MONITORING_IGNORE_FREQUENCY=true`\n\nThe default list of commands is the following:\n\n| Key | Description | Command | Frequency |\n| :---: | :---- | :---- | :-----: |\n| [AUDIT_TRAIL](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/audittrail) | Detect suspect setup actions in major org | [sf hardis:org:diagnose:audittrail](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/audittrail) | daily |\n| [LEGACY_API](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/legacyapi) | Detect calls to deprecated API versions | [sf hardis:org:diagnose:legacyapi](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/legacyapi) | daily |\n| [ORG_LIMITS](https://sfdx-hardis.cloudity.com/hardis/org/monitor/limits) | Detect if org limits are close to be reached | [sf hardis:org:monitor:limits](https://sfdx-hardis.cloudity.com/hardis/org/monitor/limits) | daily |\n| [UNSECURED_CONNECTED_APPS](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unsecure-connected-apps) | Detect unsecured Connected Apps in an org | [sf hardis:org:diagnose:unsecure-connected-apps](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unsecure-connected-apps) | daily |\n| [LICENSES](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/licenses) | Extract licenses information | [sf hardis:org:diagnose:licenses](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/licenses) | weekly |\n| [LINT_ACCESS](https://sfdx-hardis.cloudity.com/hardis/lint/access) | Detect custom elements with no access rights defined in permission sets | [sf hardis:lint:access](https://sfdx-hardis.cloudity.com/hardis/lint/access) | weekly |\n| [UNUSED_LICENSES](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unusedlicenses) | Detect permission set licenses that are assigned to users that do not need them | [sf hardis:org:diagnose:unusedlicenses](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unusedlicenses) | weekly |\n| [UNUSED_USERS](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unusedusers) | Detect active users without recent logins | [sf hardis:org:diagnose:unusedusers](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unusedusers) | weekly |\n| [ACTIVE_USERS](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unusedusers) | Detect active users with recent logins | [sf hardis:org:diagnose:unusedusers --returnactiveusers](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unusedusers) | weekly |\n| [ORG_INFO](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/instanceupgrade) | Get org info + SF instance info + next major upgrade date | [sf hardis:org:diagnose:instanceupgrade](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/instanceupgrade) | weekly |\n| [RELEASE_UPDATES](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/releaseupdates) | Gather warnings about incoming and overdue Release Updates | [sf hardis:org:diagnose:releaseupdates](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/releaseupdates) | weekly |\n| [UNUSED_METADATAS](https://sfdx-hardis.cloudity.com/hardis/lint/unusedmetadatas) | Detect custom labels and custom permissions that are not in use | [sf hardis:lint:unusedmetadatas](https://sfdx-hardis.cloudity.com/hardis/lint/unusedmetadatas) | weekly |\n| [UNUSED_APEX_CLASSES](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unused-apex-classes) | Detect unused Apex classes in an org | [sf hardis:org:diagnose:unused-apex-classes](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unused-apex-classes) | weekly |\n| [CONNECTED_APPS](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unused-connected-apps) | Detect unused Connected Apps in an org | [sf hardis:org:diagnose:unused-connected-apps](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unused-connected-apps) | weekly |\n| [METADATA_STATUS](https://sfdx-hardis.cloudity.com/hardis/lint/metadatastatus) | Detect inactive metadata | [sf hardis:lint:metadatastatus](https://sfdx-hardis.cloudity.com/hardis/lint/metadatastatus) | weekly |\n| [MISSING_ATTRIBUTES](https://sfdx-hardis.cloudity.com/hardis/lint/missingattributes) | Detect missing description on custom field | [sf hardis:lint:missingattributes](https://sfdx-hardis.cloudity.com/hardis/lint/missingattributes) | weekly |\n\n",
7296
+ "description": "\n## Command Behavior\n\n**Detects and suggests the deletion of unused Permission Set License Assignments in a Salesforce org.**\n\nWhen a Permission Set (PS) linked to a Permission Set License (PSL) is assigned to a user, a Permission Set License Assignment (PSLA) is automatically created. However, when that PS is unassigned from the user, the PSLA is *not* automatically deleted. This can lead to organizations being charged for unused PSLAs, representing a hidden cost and technical debt.\n\nThis command identifies such useless PSLAs and provides options to delete them, helping to optimize license usage and reduce unnecessary expenses.\n\nKey functionalities:\n\n- **PSLA Detection:** Queries the Salesforce org to find all active PSLAs.\n- **Usage Verification:** Correlates PSLAs with actual Permission Set Assignments and Permission Set Group Assignments to determine if the underlying Permission Sets are still assigned to the user.\n- **Special Case Handling:** Accounts for specific scenarios where profiles might implicitly assign PSLAs (e.g., `Salesforce API Only` profile assigning `SalesforceAPIIntegrationPsl`) and allows for always excluding certain PSLAs from the unused check.\n- **Reporting:** Generates a CSV report of all identified unused PSLAs, including the user and the associated Permission Set License.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of unused PSLAs.\n- **Interactive Deletion:** In non-CI environments, it offers an interactive prompt to bulk delete the identified unused PSLAs.\n\nMany thanks to [Vincent Finet](https://www.linkedin.com/in/vincentfinet/) for the inspiration during his great speaker session at [French Touch Dreamin '23](https://frenchtouchdreamin.com/), and his kind agreement for reusing such inspiration in this command 😊\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-unused-licenses/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves extensive querying of Salesforce objects and data correlation:\n\n- **SOQL Queries (Bulk API):** It uses `bulkQuery` and `bulkQueryChunksIn` to efficiently retrieve large volumes of data from `PermissionSetLicenseAssign`, `PermissionSetLicense`, `PermissionSet`, `PermissionSetGroupComponent`, and `PermissionSetAssignment` objects.\n- **Data Correlation:** It meticulously correlates data across these objects to determine if a `PermissionSetLicenseAssign` record has a corresponding active assignment to a Permission Set or Permission Set Group for the same user.\n- **Filtering Logic:** It applies complex filtering logic to exclude PSLAs that are genuinely in use or are part of predefined exceptions (e.g., `alwaysExcludeForActiveUsersPermissionSetLicenses`).\n- **Bulk Deletion:** If the user opts to delete unused PSLAs, it uses `bulkUpdate` with the `delete` operation to efficiently remove multiple records.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of unused PSLAs.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **User Interaction:** Uses `prompts` for interactive confirmation before performing deletion operations.\n</details>\n",
7315
7297
  "examples": [
7316
- "$ sf hardis:org:monitor:all"
7298
+ "$ sf hardis:org:diagnose:unusedlicenses",
7299
+ "$ sf hardis:org:diagnose:unusedlicenses --fix"
7317
7300
  ],
7318
7301
  "flags": {
7319
7302
  "json": {
@@ -7331,7 +7314,15 @@
7331
7314
  "multiple": false,
7332
7315
  "type": "option"
7333
7316
  },
7334
- "debug": {
7317
+ "outputfile": {
7318
+ "char": "f",
7319
+ "description": "Force the path and name of output report file. Must end with .csv",
7320
+ "name": "outputfile",
7321
+ "hasDynamicHelp": false,
7322
+ "multiple": false,
7323
+ "type": "option"
7324
+ },
7325
+ "debug": {
7335
7326
  "char": "d",
7336
7327
  "description": "Activate debug mode (more logs)",
7337
7328
  "name": "debug",
@@ -7369,159 +7360,79 @@
7369
7360
  },
7370
7361
  "hasDynamicHelp": true,
7371
7362
  "hiddenAliases": [],
7372
- "id": "hardis:org:monitor:all",
7363
+ "id": "hardis:org:diagnose:unusedlicenses",
7373
7364
  "pluginAlias": "sfdx-hardis",
7374
7365
  "pluginName": "sfdx-hardis",
7375
7366
  "pluginType": "core",
7376
7367
  "strict": true,
7377
7368
  "enableJsonFlag": true,
7378
- "title": "Monitor org",
7379
- "monitoringCommandsDefault": [
7380
- {
7381
- "key": "AUDIT_TRAIL",
7382
- "title": "Detect suspect setup actions in major org",
7383
- "command": "sf hardis:org:diagnose:audittrail",
7384
- "frequency": "daily"
7385
- },
7386
- {
7387
- "key": "LEGACY_API",
7388
- "title": "Detect calls to deprecated API versions",
7389
- "command": "sf hardis:org:diagnose:legacyapi",
7390
- "frequency": "daily"
7391
- },
7392
- {
7393
- "key": "ORG_LIMITS",
7394
- "title": "Detect if org limits are close to be reached",
7395
- "command": "sf hardis:org:monitor:limits",
7396
- "frequency": "daily"
7397
- },
7398
- {
7399
- "key": "UNSECURED_CONNECTED_APPS",
7400
- "title": "Detect unsecured Connected Apps in an org",
7401
- "command": "sf hardis:org:diagnose:unsecure-connected-apps",
7402
- "frequency": "daily"
7403
- },
7404
- {
7405
- "key": "LICENSES",
7406
- "title": "Extract licenses information",
7407
- "command": "sf hardis:org:diagnose:licenses",
7408
- "frequency": "weekly"
7409
- },
7410
- {
7411
- "key": "LINT_ACCESS",
7412
- "title": "Detect custom elements with no access rights defined in permission sets",
7413
- "command": "sf hardis:lint:access",
7414
- "frequency": "weekly"
7415
- },
7416
- {
7417
- "key": "UNUSED_LICENSES",
7418
- "title": "Detect permission set licenses that are assigned to users that do not need them",
7419
- "command": "sf hardis:org:diagnose:unusedlicenses",
7420
- "frequency": "weekly"
7421
- },
7422
- {
7423
- "key": "UNUSED_USERS",
7424
- "title": "Detect active users without recent logins",
7425
- "command": "sf hardis:org:diagnose:unusedusers",
7426
- "frequency": "weekly"
7427
- },
7428
- {
7429
- "key": "ACTIVE_USERS",
7430
- "title": "Detect active users with recent logins",
7431
- "command": "sf hardis:org:diagnose:unusedusers --returnactiveusers",
7432
- "frequency": "weekly"
7433
- },
7434
- {
7435
- "key": "ORG_INFO",
7436
- "title": "Get org info + SF instance info + next major upgrade date",
7437
- "command": "sf hardis:org:diagnose:instanceupgrade",
7438
- "frequency": "weekly"
7439
- },
7440
- {
7441
- "key": "RELEASE_UPDATES",
7442
- "title": "Gather warnings about incoming and overdue Release Updates",
7443
- "command": "sf hardis:org:diagnose:releaseupdates",
7444
- "frequency": "weekly"
7445
- },
7446
- {
7447
- "key": "UNUSED_METADATAS",
7448
- "title": "Detect custom labels and custom permissions that are not in use",
7449
- "command": "sf hardis:lint:unusedmetadatas",
7450
- "frequency": "weekly"
7451
- },
7452
- {
7453
- "key": "UNUSED_APEX_CLASSES",
7454
- "title": "Detect unused Apex classes in an org",
7455
- "command": "sf hardis:org:diagnose:unused-apex-classes",
7456
- "frequency": "weekly"
7457
- },
7458
- {
7459
- "key": "CONNECTED_APPS",
7460
- "title": "Detect unused Connected Apps in an org",
7461
- "command": "sf hardis:org:diagnose:unused-connected-apps",
7462
- "frequency": "weekly"
7463
- },
7369
+ "title": "Detect unused Permission Set Licenses (beta)",
7370
+ "requiresProject": false,
7371
+ "additionalPermissionSetsToAlwaysGet": [
7372
+ "Sales_User"
7373
+ ],
7374
+ "permSetsPermSetLicenses": [
7464
7375
  {
7465
- "key": "METADATA_STATUS",
7466
- "title": "Detect inactive metadata",
7467
- "command": "sf hardis:lint:metadatastatus",
7468
- "frequency": "weekly"
7469
- },
7376
+ "permSet": "Sales_User",
7377
+ "permSetLicense": "SalesUserPsl"
7378
+ }
7379
+ ],
7380
+ "profilesPermissionSetLicenses": [
7470
7381
  {
7471
- "key": "MISSING_ATTRIBUTES",
7472
- "title": "Detect missing description on custom field",
7473
- "command": "sf hardis:lint:missingattributes",
7474
- "frequency": "weekly"
7382
+ "profile": "Salesforce API Only",
7383
+ "permSetLicense": "SalesforceAPIIntegrationPsl"
7475
7384
  }
7476
7385
  ],
7477
- "requiresProject": true,
7478
- "triggerNotification": true,
7386
+ "alwaysExcludeForActiveUsersPermissionSetLicenses": [
7387
+ "IdentityConnect"
7388
+ ],
7479
7389
  "isESM": true,
7480
7390
  "relativePath": [
7481
7391
  "lib",
7482
7392
  "commands",
7483
7393
  "hardis",
7484
7394
  "org",
7485
- "monitor",
7486
- "all.js"
7395
+ "diagnose",
7396
+ "unusedlicenses.js"
7487
7397
  ],
7488
7398
  "aliasPermutations": [],
7489
7399
  "permutations": [
7490
- "hardis:org:monitor:all",
7491
- "org:hardis:monitor:all",
7492
- "org:monitor:hardis:all",
7493
- "org:monitor:all:hardis",
7494
- "hardis:monitor:org:all",
7495
- "monitor:hardis:org:all",
7496
- "monitor:org:hardis:all",
7497
- "monitor:org:all:hardis",
7498
- "hardis:monitor:all:org",
7499
- "monitor:hardis:all:org",
7500
- "monitor:all:hardis:org",
7501
- "monitor:all:org:hardis",
7502
- "hardis:org:all:monitor",
7503
- "org:hardis:all:monitor",
7504
- "org:all:hardis:monitor",
7505
- "org:all:monitor:hardis",
7506
- "hardis:all:org:monitor",
7507
- "all:hardis:org:monitor",
7508
- "all:org:hardis:monitor",
7509
- "all:org:monitor:hardis",
7510
- "hardis:all:monitor:org",
7511
- "all:hardis:monitor:org",
7512
- "all:monitor:hardis:org",
7513
- "all:monitor:org:hardis"
7400
+ "hardis:org:diagnose:unusedlicenses",
7401
+ "org:hardis:diagnose:unusedlicenses",
7402
+ "org:diagnose:hardis:unusedlicenses",
7403
+ "org:diagnose:unusedlicenses:hardis",
7404
+ "hardis:diagnose:org:unusedlicenses",
7405
+ "diagnose:hardis:org:unusedlicenses",
7406
+ "diagnose:org:hardis:unusedlicenses",
7407
+ "diagnose:org:unusedlicenses:hardis",
7408
+ "hardis:diagnose:unusedlicenses:org",
7409
+ "diagnose:hardis:unusedlicenses:org",
7410
+ "diagnose:unusedlicenses:hardis:org",
7411
+ "diagnose:unusedlicenses:org:hardis",
7412
+ "hardis:org:unusedlicenses:diagnose",
7413
+ "org:hardis:unusedlicenses:diagnose",
7414
+ "org:unusedlicenses:hardis:diagnose",
7415
+ "org:unusedlicenses:diagnose:hardis",
7416
+ "hardis:unusedlicenses:org:diagnose",
7417
+ "unusedlicenses:hardis:org:diagnose",
7418
+ "unusedlicenses:org:hardis:diagnose",
7419
+ "unusedlicenses:org:diagnose:hardis",
7420
+ "hardis:unusedlicenses:diagnose:org",
7421
+ "unusedlicenses:hardis:diagnose:org",
7422
+ "unusedlicenses:diagnose:hardis:org",
7423
+ "unusedlicenses:diagnose:org:hardis"
7514
7424
  ]
7515
7425
  },
7516
- "hardis:org:monitor:backup": {
7426
+ "hardis:org:diagnose:unusedusers": {
7517
7427
  "aliases": [],
7518
7428
  "args": {},
7519
- "description": "Retrieve sfdx sources in the context of a monitoring backup\n\nThe command exists in 2 modes: filtered(default & recommended) and full.\n\n## Filtered mode (default, better performances)\n\nAutomatically skips metadatas from installed packages with namespace. \n\nYou can remove more metadata types from backup, especially in case you have too many metadatas and that provokes a crash, using:\n\n- Manual update of `manifest/package-skip-items.xml` config file (then commit & push in the same branch)\n\n - Works with full wildcard (`<members>*</members>`) , named metadata (`<members>Account.Name</members>`) or partial wildcards names (`<members>pi__*</members>` , `<members>*__dlm</members>` , or `<members>prefix*suffix</members>`)\n\n- Environment variable MONITORING_BACKUP_SKIP_METADATA_TYPES (example: `MONITORING_BACKUP_SKIP_METADATA_TYPES=CustomLabel,StaticResource,Translation`): that will be applied to all monitoring branches.\n\n## Full mode\n\nActivate it with **--full** parameter, or variable MONITORING_BACKUP_MODE_FULL=true\n\nIgnores filters (namespaces items & manifest/package-skip-items.xml) to retrieve ALL metadatas, including those you might not care about (reports, translations...)\n\nAs we can retrieve only 10000 files by call, the list of all metadatas will be chunked to make multiple calls (and take more time than filtered mode)\n\n- if you use `--full-apply-filters` , manifest/package-skip-items.xml and MONITORING_BACKUP_SKIP_METADATA_TYPES filters will be applied anyway\n- if you use `--exclude-namespaces` , namespaced items will be ignored\n\n_With those both options, it's like if you are not using --full, but with chunked metadata download_\n\n## In CI/CD\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-metadata-backup/) and can output Grafana, Slack and MsTeams Notifications.\n\n## Troubleshooting\n\nIf you have unknown errors (it happens !), you can investigate using the full command with smaller chunks.\n\nExample: `sf hardis:org:monitor:backup --full --exclude-namespaces --full-apply-filters --max-by-chunk 500`\n\nIt will allow you the identify the responsible metadata and ignore it using package-skip-items.xml or MONITORING_BACKUP_SKIP_METADATA_TYPES env variable.\n\n## Documentation\n\n[Doc generation (including visual flows)](https://sfdx-hardis.cloudity.com/hardis/doc/project2markdown/) is triggered at the end of the command.\n\nIf you want to also upload HTML Documentation on your Salesforce Org as static resource, use variable **SFDX_HARDIS_DOC_DEPLOY_TO_ORG=\"true\"**\n\nIf you want to also upload HTML Documentation on Cloudflare, use variable **SFDX_HARDIS_DOC_DEPLOY_TO_CLOUDFLARE=\"true\"**\n\n- If you want to generate the documentation in multiple languages, define variable SFDX_DOC_LANGUAGES (ex: SFDX_DOC_LANGUAGES=en,fr,de)\n- You can define one Cloudflare site by language, for example with the following variables:\n - CLOUDFLARE_PROJECT_NAME_EN=cloudity-demo-english\n - CLOUDFLARE_PROJECT_NAME_FR=cloudity-demo-french\n - CLOUDFLARE_PROJECT_NAME_DE=cloudity-demo-german\n\nIf Flow history doc always display a single state, you probably need to update your workflow configuration:\n\n- on Gitlab: Env variable [`GIT_FETCH_EXTRA_FLAGS: --depth 10000`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.gitlab-ci.yml#L11)\n- on GitHub: [`fetch-depth: 0`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.github/workflows/org-monitoring.yml#L58)\n- on Azure: [`fetchDepth: \"0\"`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/azure-pipelines.yml#L39)\n- on Bitbucket: [`step: clone: depth: full`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/bitbucket-pipelines.yml#L18)\n",
7429
+ "description": "\n## Command Behavior\n\n**Detects and reports on inactive or unused Salesforce user accounts, helping to optimize license usage and enhance security.**\n\nEfficient user management is vital in Salesforce to ensure resources are optimized and costs are controlled. However, inactive or unused user accounts can often go unnoticed, leading to wasted licenses and potential security risks. This tool addresses this challenge by enabling administrators to identify users who haven't logged in within a specified period.\n\nBy analyzing user login activity and last login timestamps, this feature highlights inactive user accounts, allowing administrators to take appropriate action. Whether it's deactivating dormant accounts, freeing up licenses, or ensuring compliance with security policies, this functionality empowers administrators to maintain a lean and secure Salesforce environment.\n\nKey functionalities:\n\n- **Inactivity Detection:** Identifies users who have not logged in for a specified number of days (`--days` flag, default 180 days in CI, 365 days otherwise).\n- **License Type Filtering:** Allows filtering users by license type using `--licensetypes` (e.g., `all-crm`, `all-paying`) or specific license identifiers using `--licenseidentifiers`.\n - `all-crm`: Includes `SFDC`, `AUL`, `AUL1`, `AULL_IGHT` licenses.\n - `all-paying`: Includes `SFDC`, `AUL`, `AUL1`, `AULL_IGHT`, `PID_Customer_Community`, `PID_Customer_Community_Login`, `PID_Partner_Community`, `PID_Partner_Community_Login` licenses.\n - Note: You can see the full list of available license identifiers in [Salesforce Documentation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/sfdx_cli_reference/sforce_api_objects_userlicense.htm).\n- **Active User Retrieval:** The `--returnactiveusers` flag inverts the command, allowing you to retrieve active users who *have* logged in during the specified period.\n- **CSV Report Generation:** Generates a CSV file containing details of all identified users (inactive or active), including their last login date, profile, and license information.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of inactive or active users.\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-inactive-users/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Query (Bulk API):** It uses `bulkQuery` to efficiently retrieve user records from the Salesforce `User` object. The SOQL query dynamically constructs its WHERE clause based on the `--days`, `--licensetypes`, `--licenseidentifiers`, and `--returnactiveusers` flags.\n- **Interactive Prompts:** Uses `prompts` to interactively ask the user for the number of inactive days and license types if not provided via flags.\n- **License Mapping:** Internally maps common license type aliases (e.g., `all-crm`) to their corresponding Salesforce `LicenseDefinitionKey` values.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of users.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and metrics for monitoring dashboards.\n- **User Feedback:** Provides a summary of the findings in the console, indicating the number of inactive or active users found.\n</details>",
7520
7430
  "examples": [
7521
- "$ sf hardis:org:monitor:backup",
7522
- "$ sf hardis:org:monitor:backup --full",
7523
- "$ sf hardis:org:monitor:backup --full --exclude-namespaces",
7524
- "$ sf hardis:org:monitor:backup --full --exclude-namespaces --full-apply-filters"
7431
+ "$ sf hardis:org:diagnose:unusedusers",
7432
+ "$ sf hardis:org:diagnose:unusedusers --days 365",
7433
+ "$ sf hardis:org:diagnose:unusedusers --days 60 --licensetypes all-crm",
7434
+ "$ sf hardis:org:diagnose:unusedusers --days 60 --licenseidentifiers SFDC,AUL,AUL1",
7435
+ "$ sf hardis:org:diagnose:unusedusers --days 60 --licensetypes all-crm --returnactiveusers"
7525
7436
  ],
7526
7437
  "flags": {
7527
7438
  "json": {
@@ -7539,49 +7450,6 @@
7539
7450
  "multiple": false,
7540
7451
  "type": "option"
7541
7452
  },
7542
- "full": {
7543
- "description": "Dot not take in account filtering using package-skip-items.xml and MONITORING_BACKUP_SKIP_METADATA_TYPES. Efficient but much much slower !",
7544
- "name": "full",
7545
- "allowNo": false,
7546
- "type": "boolean"
7547
- },
7548
- "max-by-chunk": {
7549
- "char": "m",
7550
- "description": "If mode --full is activated, maximum number of metadatas in a package.xml chunk",
7551
- "name": "max-by-chunk",
7552
- "default": 3000,
7553
- "hasDynamicHelp": false,
7554
- "multiple": false,
7555
- "type": "option"
7556
- },
7557
- "exclude-namespaces": {
7558
- "char": "e",
7559
- "description": "If mode --full is activated, exclude namespaced metadatas",
7560
- "name": "exclude-namespaces",
7561
- "allowNo": false,
7562
- "type": "boolean"
7563
- },
7564
- "full-apply-filters": {
7565
- "char": "z",
7566
- "description": "If mode --full is activated, apply filters of manifest/package-skip-items.xml and MONITORING_BACKUP_SKIP_METADATA_TYPES anyway",
7567
- "name": "full-apply-filters",
7568
- "allowNo": false,
7569
- "type": "boolean"
7570
- },
7571
- "start-chunk": {
7572
- "description": "Use this parameter to troubleshoot a specific chunk. It will be used as the first chunk to retrieve",
7573
- "name": "start-chunk",
7574
- "default": 1,
7575
- "hasDynamicHelp": false,
7576
- "multiple": false,
7577
- "type": "option"
7578
- },
7579
- "skip-doc": {
7580
- "description": "Skip the generation of project documentation at the end of the command",
7581
- "name": "skip-doc",
7582
- "allowNo": false,
7583
- "type": "boolean"
7584
- },
7585
7453
  "outputfile": {
7586
7454
  "char": "f",
7587
7455
  "description": "Force the path and name of output report file. Must end with .csv",
@@ -7590,121 +7458,41 @@
7590
7458
  "multiple": false,
7591
7459
  "type": "option"
7592
7460
  },
7593
- "debug": {
7594
- "char": "d",
7595
- "description": "Activate debug mode (more logs)",
7596
- "name": "debug",
7597
- "allowNo": false,
7598
- "type": "boolean"
7599
- },
7600
- "websocket": {
7601
- "description": "Websocket host:port for VsCode SFDX Hardis UI integration",
7602
- "name": "websocket",
7461
+ "days": {
7462
+ "char": "t",
7463
+ "description": "Extracts the users that have been inactive for the amount of days specified. In CI, default is 180 days",
7464
+ "name": "days",
7603
7465
  "hasDynamicHelp": false,
7604
7466
  "multiple": false,
7605
7467
  "type": "option"
7606
7468
  },
7607
- "skipauth": {
7608
- "description": "Skip authentication check when a default username is required",
7609
- "name": "skipauth",
7610
- "allowNo": false,
7611
- "type": "boolean"
7612
- },
7613
- "target-org": {
7614
- "aliases": [
7615
- "targetusername",
7616
- "u"
7617
- ],
7618
- "char": "o",
7619
- "deprecateAliases": true,
7620
- "name": "target-org",
7621
- "noCacheDefault": true,
7622
- "required": true,
7623
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
7624
- "hasDynamicHelp": true,
7625
- "multiple": false,
7626
- "type": "option"
7627
- }
7628
- },
7629
- "hasDynamicHelp": true,
7630
- "hiddenAliases": [],
7631
- "id": "hardis:org:monitor:backup",
7632
- "pluginAlias": "sfdx-hardis",
7633
- "pluginName": "sfdx-hardis",
7634
- "pluginType": "core",
7635
- "strict": true,
7636
- "enableJsonFlag": true,
7637
- "title": "Backup DX sources",
7638
- "requiresProject": true,
7639
- "triggerNotification": true,
7640
- "isESM": true,
7641
- "relativePath": [
7642
- "lib",
7643
- "commands",
7644
- "hardis",
7645
- "org",
7646
- "monitor",
7647
- "backup.js"
7648
- ],
7649
- "aliasPermutations": [],
7650
- "permutations": [
7651
- "hardis:org:monitor:backup",
7652
- "org:hardis:monitor:backup",
7653
- "org:monitor:hardis:backup",
7654
- "org:monitor:backup:hardis",
7655
- "hardis:monitor:org:backup",
7656
- "monitor:hardis:org:backup",
7657
- "monitor:org:hardis:backup",
7658
- "monitor:org:backup:hardis",
7659
- "hardis:monitor:backup:org",
7660
- "monitor:hardis:backup:org",
7661
- "monitor:backup:hardis:org",
7662
- "monitor:backup:org:hardis",
7663
- "hardis:org:backup:monitor",
7664
- "org:hardis:backup:monitor",
7665
- "org:backup:hardis:monitor",
7666
- "org:backup:monitor:hardis",
7667
- "hardis:backup:org:monitor",
7668
- "backup:hardis:org:monitor",
7669
- "backup:org:hardis:monitor",
7670
- "backup:org:monitor:hardis",
7671
- "hardis:backup:monitor:org",
7672
- "backup:hardis:monitor:org",
7673
- "backup:monitor:hardis:org",
7674
- "backup:monitor:org:hardis"
7675
- ]
7676
- },
7677
- "hardis:org:monitor:limits": {
7678
- "aliases": [],
7679
- "args": {},
7680
- "description": "\n## Command Behavior\n\n**Checks the current usage of various Salesforce org limits and sends notifications if thresholds are exceeded.**\n\nThis command is a critical component of proactive Salesforce org management, helping administrators and developers monitor resource consumption and prevent hitting critical limits that could impact performance or functionality. It provides early warnings when limits are approaching their capacity.\n\nKey functionalities:\n\n- **Limit Retrieval:** Fetches a comprehensive list of all Salesforce org limits using the Salesforce CLI.\n- **Usage Calculation:** Calculates the percentage of each limit that is currently being used.\n- **Threshold-Based Alerting:** Assigns a severity (success, warning, or error) to each limit based on configurable thresholds:\n - **Warning:** If usage exceeds 50% (configurable via `LIMIT_THRESHOLD_WARNING` environment variable).\n - **Error:** If usage exceeds 75% (configurable via `LIMIT_THRESHOLD_ERROR` environment variable).\n- **CSV Report Generation:** Generates a CSV file containing all org limits, their current usage, maximum allowed, and calculated percentage used, along with the assigned severity.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of limits that have exceeded the warning or error thresholds.\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-org-limits/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce CLI Integration:** It executes the `sf org limits list` command to retrieve the current org limits. It parses the JSON output of this command.\n- **Data Processing:** It iterates through the retrieved limits, calculates the `used` and `percentUsed` values, and assigns a `severity` (success, warning, error) based on the configured thresholds.\n- **Environment Variable Configuration:** Reads `LIMIT_THRESHOLD_WARNING` and `LIMIT_THRESHOLD_ERROR` environment variables to set the warning and error thresholds for limit usage.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of org limits.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and detailed metrics for each limit, which can be consumed by monitoring dashboards like Grafana.\n- **Exit Code Management:** Sets the process exit code to 1 if any limit is in an 'error' state, indicating a critical issue.\n</details>\n",
7681
- "examples": [
7682
- "$ sf hardis:org:monitor:limits"
7683
- ],
7684
- "flags": {
7685
- "json": {
7686
- "description": "Format output as json.",
7687
- "helpGroup": "GLOBAL",
7688
- "name": "json",
7689
- "allowNo": false,
7690
- "type": "boolean"
7691
- },
7692
- "flags-dir": {
7693
- "helpGroup": "GLOBAL",
7694
- "name": "flags-dir",
7695
- "summary": "Import flag values from a directory.",
7469
+ "licensetypes": {
7470
+ "char": "l",
7471
+ "description": "Type of licenses to check. If set, do not use licenseidentifiers option. In CI, default is all-crm",
7472
+ "name": "licensetypes",
7696
7473
  "hasDynamicHelp": false,
7697
7474
  "multiple": false,
7475
+ "options": [
7476
+ "all",
7477
+ "all-crm",
7478
+ "all-paying"
7479
+ ],
7698
7480
  "type": "option"
7699
7481
  },
7700
- "outputfile": {
7701
- "char": "f",
7702
- "description": "Force the path and name of output report file. Must end with .csv",
7703
- "name": "outputfile",
7482
+ "licenseidentifiers": {
7483
+ "char": "i",
7484
+ "description": "Comma-separated list of license identifiers, in case licensetypes is not used.. Identifiers available at https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_userlicense.htm",
7485
+ "name": "licenseidentifiers",
7704
7486
  "hasDynamicHelp": false,
7705
7487
  "multiple": false,
7706
7488
  "type": "option"
7707
7489
  },
7490
+ "returnactiveusers": {
7491
+ "description": "Inverts the command by returning the active users",
7492
+ "name": "returnactiveusers",
7493
+ "allowNo": false,
7494
+ "type": "boolean"
7495
+ },
7708
7496
  "debug": {
7709
7497
  "char": "d",
7710
7498
  "description": "Activate debug mode (more logs)",
@@ -7743,59 +7531,57 @@
7743
7531
  },
7744
7532
  "hasDynamicHelp": true,
7745
7533
  "hiddenAliases": [],
7746
- "id": "hardis:org:monitor:limits",
7534
+ "id": "hardis:org:diagnose:unusedusers",
7747
7535
  "pluginAlias": "sfdx-hardis",
7748
7536
  "pluginName": "sfdx-hardis",
7749
7537
  "pluginType": "core",
7750
7538
  "strict": true,
7751
7539
  "enableJsonFlag": true,
7752
- "title": "Check org limits",
7753
- "requiresProject": true,
7754
- "triggerNotification": true,
7540
+ "title": "Detect unused Users in Salesforce",
7541
+ "requiresProject": false,
7755
7542
  "isESM": true,
7756
7543
  "relativePath": [
7757
7544
  "lib",
7758
7545
  "commands",
7759
7546
  "hardis",
7760
7547
  "org",
7761
- "monitor",
7762
- "limits.js"
7763
- ],
7764
- "aliasPermutations": [],
7765
- "permutations": [
7766
- "hardis:org:monitor:limits",
7767
- "org:hardis:monitor:limits",
7768
- "org:monitor:hardis:limits",
7769
- "org:monitor:limits:hardis",
7770
- "hardis:monitor:org:limits",
7771
- "monitor:hardis:org:limits",
7772
- "monitor:org:hardis:limits",
7773
- "monitor:org:limits:hardis",
7774
- "hardis:monitor:limits:org",
7775
- "monitor:hardis:limits:org",
7776
- "monitor:limits:hardis:org",
7777
- "monitor:limits:org:hardis",
7778
- "hardis:org:limits:monitor",
7779
- "org:hardis:limits:monitor",
7780
- "org:limits:hardis:monitor",
7781
- "org:limits:monitor:hardis",
7782
- "hardis:limits:org:monitor",
7783
- "limits:hardis:org:monitor",
7784
- "limits:org:hardis:monitor",
7785
- "limits:org:monitor:hardis",
7786
- "hardis:limits:monitor:org",
7787
- "limits:hardis:monitor:org",
7788
- "limits:monitor:hardis:org",
7789
- "limits:monitor:org:hardis"
7548
+ "diagnose",
7549
+ "unusedusers.js"
7550
+ ],
7551
+ "aliasPermutations": [],
7552
+ "permutations": [
7553
+ "hardis:org:diagnose:unusedusers",
7554
+ "org:hardis:diagnose:unusedusers",
7555
+ "org:diagnose:hardis:unusedusers",
7556
+ "org:diagnose:unusedusers:hardis",
7557
+ "hardis:diagnose:org:unusedusers",
7558
+ "diagnose:hardis:org:unusedusers",
7559
+ "diagnose:org:hardis:unusedusers",
7560
+ "diagnose:org:unusedusers:hardis",
7561
+ "hardis:diagnose:unusedusers:org",
7562
+ "diagnose:hardis:unusedusers:org",
7563
+ "diagnose:unusedusers:hardis:org",
7564
+ "diagnose:unusedusers:org:hardis",
7565
+ "hardis:org:unusedusers:diagnose",
7566
+ "org:hardis:unusedusers:diagnose",
7567
+ "org:unusedusers:hardis:diagnose",
7568
+ "org:unusedusers:diagnose:hardis",
7569
+ "hardis:unusedusers:org:diagnose",
7570
+ "unusedusers:hardis:org:diagnose",
7571
+ "unusedusers:org:hardis:diagnose",
7572
+ "unusedusers:org:diagnose:hardis",
7573
+ "hardis:unusedusers:diagnose:org",
7574
+ "unusedusers:hardis:diagnose:org",
7575
+ "unusedusers:diagnose:hardis:org",
7576
+ "unusedusers:diagnose:org:hardis"
7790
7577
  ]
7791
7578
  },
7792
- "hardis:org:purge:apexlog": {
7579
+ "hardis:org:monitor:all": {
7793
7580
  "aliases": [],
7794
7581
  "args": {},
7795
- "description": "\n**Purges Apex debug logs from a Salesforce org.**\n\nThis command provides a quick and efficient way to clear out accumulated Apex debug logs from your Salesforce environment. This is particularly useful for:\n\n- **Storage Management:** Freeing up valuable data storage space in your Salesforce org.\n- **Performance Optimization:** Reducing the overhead associated with large volumes of debug logs.\n- **Troubleshooting:** Ensuring that new debug logs are generated cleanly without interference from old, irrelevant logs.\n\nKey functionalities:\n\n- **Log Identification:** Queries the `ApexLog` object to identify all existing debug logs.\n- **Confirmation Prompt:** Before deletion, it prompts for user confirmation, displaying the number of Apex logs that will be deleted.\n- **Bulk Deletion:** Uses the Salesforce Bulk API to efficiently delete a large number of Apex logs.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Query:** It executes a SOQL query (`SELECT Id FROM ApexLog LIMIT 50000`) to retrieve the IDs of Apex logs to be deleted. The limit is set to 50,000 to handle large volumes of logs.\n- **CSV Export:** The retrieved log IDs are temporarily exported to a CSV file (`ApexLogsToDelete_*.csv`) in the `./tmp` directory.\n- **User Confirmation:** It uses the `prompts` library to ask for user confirmation before proceeding with the deletion, displaying the count of logs to be purged.\n- **Bulk API Deletion:** It then uses the Salesforce CLI's `sf data delete bulk` command, pointing to the generated CSV file, to perform the mass deletion of Apex logs.\n- **File System Operations:** It uses `fs-extra` to create the temporary directory and manage the CSV file.\n- **Error Handling:** Includes error handling for the query and deletion operations.\n</details>\n",
7582
+ "description": "Monitor org, generate reports and sends notifications\n\nYou can disable some commands defining either a **monitoringDisable** property in `.sfdx-hardis.yml`, or a comma separated list in env variable **MONITORING_DISABLE**\n\nExample in .sfdx-hardis.yml:\n \n```yaml\nmonitoringDisable:\n - METADATA_STATUS\n - MISSING_ATTRIBUTES\n - UNUSED_METADATAS\n```\n \nExample in env var:\n\n```sh\nMONITORING_DISABLE=METADATA_STATUS,MISSING_ATTRIBUTES,UNUSED_METADATAS\n```\n\nA [default list of monitoring commands](https://sfdx-hardis.cloudity.com/salesforce-monitoring-home/#monitoring-commands) is used, if you want to override it you can define property **monitoringCommands** in your .sfdx-hardis.yml file\n\nExample:\n\n```yaml\nmonitoringCommands:\n - title: My Custom command\n command: sf my:custom:command\n - title: My Custom command 2\n command: sf my:other:custom:command\n```\n\nYou can force the daily run of all commands by defining env var `MONITORING_IGNORE_FREQUENCY=true`\n\nThe default list of commands is the following:\n\n| Key | Description | Command | Frequency |\n| :---: | :---- | :---- | :-----: |\n| [AUDIT_TRAIL](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/audittrail) | Detect suspect setup actions in major org | [sf hardis:org:diagnose:audittrail](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/audittrail) | daily |\n| [LEGACY_API](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/legacyapi) | Detect calls to deprecated API versions | [sf hardis:org:diagnose:legacyapi](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/legacyapi) | daily |\n| [ORG_LIMITS](https://sfdx-hardis.cloudity.com/hardis/org/monitor/limits) | Detect if org limits are close to be reached | [sf hardis:org:monitor:limits](https://sfdx-hardis.cloudity.com/hardis/org/monitor/limits) | daily |\n| [UNSECURED_CONNECTED_APPS](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unsecure-connected-apps) | Detect unsecured Connected Apps in an org | [sf hardis:org:diagnose:unsecure-connected-apps](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unsecure-connected-apps) | daily |\n| [LICENSES](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/licenses) | Extract licenses information | [sf hardis:org:diagnose:licenses](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/licenses) | weekly |\n| [LINT_ACCESS](https://sfdx-hardis.cloudity.com/hardis/lint/access) | Detect custom elements with no access rights defined in permission sets | [sf hardis:lint:access](https://sfdx-hardis.cloudity.com/hardis/lint/access) | weekly |\n| [UNUSED_LICENSES](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unusedlicenses) | Detect permission set licenses that are assigned to users that do not need them | [sf hardis:org:diagnose:unusedlicenses](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unusedlicenses) | weekly |\n| [UNUSED_USERS](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unusedusers) | Detect active users without recent logins | [sf hardis:org:diagnose:unusedusers](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unusedusers) | weekly |\n| [ACTIVE_USERS](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unusedusers) | Detect active users with recent logins | [sf hardis:org:diagnose:unusedusers --returnactiveusers](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unusedusers) | weekly |\n| [ORG_INFO](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/instanceupgrade) | Get org info + SF instance info + next major upgrade date | [sf hardis:org:diagnose:instanceupgrade](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/instanceupgrade) | weekly |\n| [RELEASE_UPDATES](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/releaseupdates) | Gather warnings about incoming and overdue Release Updates | [sf hardis:org:diagnose:releaseupdates](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/releaseupdates) | weekly |\n| [UNUSED_METADATAS](https://sfdx-hardis.cloudity.com/hardis/lint/unusedmetadatas) | Detect custom labels and custom permissions that are not in use | [sf hardis:lint:unusedmetadatas](https://sfdx-hardis.cloudity.com/hardis/lint/unusedmetadatas) | weekly |\n| [UNUSED_APEX_CLASSES](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unused-apex-classes) | Detect unused Apex classes in an org | [sf hardis:org:diagnose:unused-apex-classes](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unused-apex-classes) | weekly |\n| [CONNECTED_APPS](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unused-connected-apps) | Detect unused Connected Apps in an org | [sf hardis:org:diagnose:unused-connected-apps](https://sfdx-hardis.cloudity.com/hardis/org/diagnose/unused-connected-apps) | weekly |\n| [METADATA_STATUS](https://sfdx-hardis.cloudity.com/hardis/lint/metadatastatus) | Detect inactive metadata | [sf hardis:lint:metadatastatus](https://sfdx-hardis.cloudity.com/hardis/lint/metadatastatus) | weekly |\n| [MISSING_ATTRIBUTES](https://sfdx-hardis.cloudity.com/hardis/lint/missingattributes) | Detect missing description on custom field | [sf hardis:lint:missingattributes](https://sfdx-hardis.cloudity.com/hardis/lint/missingattributes) | weekly |\n\n",
7796
7583
  "examples": [
7797
- "$ sf hardis:org:purge:apexlog",
7798
- "$ sf hardis:org:purge:apexlog --target-org nicolas.vuillamy@gmail.com"
7584
+ "$ sf hardis:org:monitor:all"
7799
7585
  ],
7800
7586
  "flags": {
7801
7587
  "json": {
@@ -7813,13 +7599,6 @@
7813
7599
  "multiple": false,
7814
7600
  "type": "option"
7815
7601
  },
7816
- "prompt": {
7817
- "char": "z",
7818
- "description": "Prompt for confirmation (true by default, use --no-prompt to skip)",
7819
- "name": "prompt",
7820
- "allowNo": true,
7821
- "type": "boolean"
7822
- },
7823
7602
  "debug": {
7824
7603
  "char": "d",
7825
7604
  "description": "Activate debug mode (more logs)",
@@ -7858,59 +7637,159 @@
7858
7637
  },
7859
7638
  "hasDynamicHelp": true,
7860
7639
  "hiddenAliases": [],
7861
- "id": "hardis:org:purge:apexlog",
7640
+ "id": "hardis:org:monitor:all",
7862
7641
  "pluginAlias": "sfdx-hardis",
7863
7642
  "pluginName": "sfdx-hardis",
7864
7643
  "pluginType": "core",
7865
7644
  "strict": true,
7866
7645
  "enableJsonFlag": true,
7867
- "title": "Purge Apex Logs",
7868
- "requiresProject": false,
7646
+ "title": "Monitor org",
7647
+ "monitoringCommandsDefault": [
7648
+ {
7649
+ "key": "AUDIT_TRAIL",
7650
+ "title": "Detect suspect setup actions in major org",
7651
+ "command": "sf hardis:org:diagnose:audittrail",
7652
+ "frequency": "daily"
7653
+ },
7654
+ {
7655
+ "key": "LEGACY_API",
7656
+ "title": "Detect calls to deprecated API versions",
7657
+ "command": "sf hardis:org:diagnose:legacyapi",
7658
+ "frequency": "daily"
7659
+ },
7660
+ {
7661
+ "key": "ORG_LIMITS",
7662
+ "title": "Detect if org limits are close to be reached",
7663
+ "command": "sf hardis:org:monitor:limits",
7664
+ "frequency": "daily"
7665
+ },
7666
+ {
7667
+ "key": "UNSECURED_CONNECTED_APPS",
7668
+ "title": "Detect unsecured Connected Apps in an org",
7669
+ "command": "sf hardis:org:diagnose:unsecure-connected-apps",
7670
+ "frequency": "daily"
7671
+ },
7672
+ {
7673
+ "key": "LICENSES",
7674
+ "title": "Extract licenses information",
7675
+ "command": "sf hardis:org:diagnose:licenses",
7676
+ "frequency": "weekly"
7677
+ },
7678
+ {
7679
+ "key": "LINT_ACCESS",
7680
+ "title": "Detect custom elements with no access rights defined in permission sets",
7681
+ "command": "sf hardis:lint:access",
7682
+ "frequency": "weekly"
7683
+ },
7684
+ {
7685
+ "key": "UNUSED_LICENSES",
7686
+ "title": "Detect permission set licenses that are assigned to users that do not need them",
7687
+ "command": "sf hardis:org:diagnose:unusedlicenses",
7688
+ "frequency": "weekly"
7689
+ },
7690
+ {
7691
+ "key": "UNUSED_USERS",
7692
+ "title": "Detect active users without recent logins",
7693
+ "command": "sf hardis:org:diagnose:unusedusers",
7694
+ "frequency": "weekly"
7695
+ },
7696
+ {
7697
+ "key": "ACTIVE_USERS",
7698
+ "title": "Detect active users with recent logins",
7699
+ "command": "sf hardis:org:diagnose:unusedusers --returnactiveusers",
7700
+ "frequency": "weekly"
7701
+ },
7702
+ {
7703
+ "key": "ORG_INFO",
7704
+ "title": "Get org info + SF instance info + next major upgrade date",
7705
+ "command": "sf hardis:org:diagnose:instanceupgrade",
7706
+ "frequency": "weekly"
7707
+ },
7708
+ {
7709
+ "key": "RELEASE_UPDATES",
7710
+ "title": "Gather warnings about incoming and overdue Release Updates",
7711
+ "command": "sf hardis:org:diagnose:releaseupdates",
7712
+ "frequency": "weekly"
7713
+ },
7714
+ {
7715
+ "key": "UNUSED_METADATAS",
7716
+ "title": "Detect custom labels and custom permissions that are not in use",
7717
+ "command": "sf hardis:lint:unusedmetadatas",
7718
+ "frequency": "weekly"
7719
+ },
7720
+ {
7721
+ "key": "UNUSED_APEX_CLASSES",
7722
+ "title": "Detect unused Apex classes in an org",
7723
+ "command": "sf hardis:org:diagnose:unused-apex-classes",
7724
+ "frequency": "weekly"
7725
+ },
7726
+ {
7727
+ "key": "CONNECTED_APPS",
7728
+ "title": "Detect unused Connected Apps in an org",
7729
+ "command": "sf hardis:org:diagnose:unused-connected-apps",
7730
+ "frequency": "weekly"
7731
+ },
7732
+ {
7733
+ "key": "METADATA_STATUS",
7734
+ "title": "Detect inactive metadata",
7735
+ "command": "sf hardis:lint:metadatastatus",
7736
+ "frequency": "weekly"
7737
+ },
7738
+ {
7739
+ "key": "MISSING_ATTRIBUTES",
7740
+ "title": "Detect missing description on custom field",
7741
+ "command": "sf hardis:lint:missingattributes",
7742
+ "frequency": "weekly"
7743
+ }
7744
+ ],
7745
+ "requiresProject": true,
7746
+ "triggerNotification": true,
7869
7747
  "isESM": true,
7870
7748
  "relativePath": [
7871
7749
  "lib",
7872
7750
  "commands",
7873
7751
  "hardis",
7874
7752
  "org",
7875
- "purge",
7876
- "apexlog.js"
7753
+ "monitor",
7754
+ "all.js"
7877
7755
  ],
7878
7756
  "aliasPermutations": [],
7879
7757
  "permutations": [
7880
- "hardis:org:purge:apexlog",
7881
- "org:hardis:purge:apexlog",
7882
- "org:purge:hardis:apexlog",
7883
- "org:purge:apexlog:hardis",
7884
- "hardis:purge:org:apexlog",
7885
- "purge:hardis:org:apexlog",
7886
- "purge:org:hardis:apexlog",
7887
- "purge:org:apexlog:hardis",
7888
- "hardis:purge:apexlog:org",
7889
- "purge:hardis:apexlog:org",
7890
- "purge:apexlog:hardis:org",
7891
- "purge:apexlog:org:hardis",
7892
- "hardis:org:apexlog:purge",
7893
- "org:hardis:apexlog:purge",
7894
- "org:apexlog:hardis:purge",
7895
- "org:apexlog:purge:hardis",
7896
- "hardis:apexlog:org:purge",
7897
- "apexlog:hardis:org:purge",
7898
- "apexlog:org:hardis:purge",
7899
- "apexlog:org:purge:hardis",
7900
- "hardis:apexlog:purge:org",
7901
- "apexlog:hardis:purge:org",
7902
- "apexlog:purge:hardis:org",
7903
- "apexlog:purge:org:hardis"
7758
+ "hardis:org:monitor:all",
7759
+ "org:hardis:monitor:all",
7760
+ "org:monitor:hardis:all",
7761
+ "org:monitor:all:hardis",
7762
+ "hardis:monitor:org:all",
7763
+ "monitor:hardis:org:all",
7764
+ "monitor:org:hardis:all",
7765
+ "monitor:org:all:hardis",
7766
+ "hardis:monitor:all:org",
7767
+ "monitor:hardis:all:org",
7768
+ "monitor:all:hardis:org",
7769
+ "monitor:all:org:hardis",
7770
+ "hardis:org:all:monitor",
7771
+ "org:hardis:all:monitor",
7772
+ "org:all:hardis:monitor",
7773
+ "org:all:monitor:hardis",
7774
+ "hardis:all:org:monitor",
7775
+ "all:hardis:org:monitor",
7776
+ "all:org:hardis:monitor",
7777
+ "all:org:monitor:hardis",
7778
+ "hardis:all:monitor:org",
7779
+ "all:hardis:monitor:org",
7780
+ "all:monitor:hardis:org",
7781
+ "all:monitor:org:hardis"
7904
7782
  ]
7905
7783
  },
7906
- "hardis:org:purge:flow": {
7784
+ "hardis:org:monitor:backup": {
7907
7785
  "aliases": [],
7908
7786
  "args": {},
7909
- "description": "\n**Purges old or unwanted Flow versions from a Salesforce org, with an option to delete related Flow Interviews.**\n\nThis command helps maintain a clean and performant Salesforce org by removing obsolete Flow versions. Over time, multiple versions of Flows can accumulate, consuming storage and potentially impacting performance. This tool provides a controlled way to clean up these versions.\n\nKey functionalities:\n\n- **Targeted Flow Selection:** Allows you to filter Flow versions to delete by name (`--name`) and status (`--status`, e.g., `Obsolete`, `Draft`, `Inactive`).\n- **Flow Interview Deletion:** If a Flow version cannot be deleted due to active Flow Interviews, the `--delete-flow-interviews` flag (or interactive prompt) allows you to delete these interviews first, then retry the Flow version deletion.\n- **Confirmation Prompt:** In interactive mode, it prompts for confirmation before proceeding with the deletion of Flow versions and Flow Interviews.\n- **Partial Success Handling:** The `--allowpurgefailure` flag (default `true`) allows the command to continue even if some deletions fail, reporting the errors.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Queries (Tooling API):** It queries the `Flow` object (using the Tooling API) to list Flow versions based on the provided filters (name, status, manageable state).\n- **Bulk Deletion (Tooling API):** It uses `bulkDeleteTooling` to perform mass deletions of Flow versions. If deletion fails due to active interviews, it extracts the interview IDs.\n- **Flow Interview Management:** If `delete-flow-interviews` is enabled, it queries `FlowInterview` objects, performs bulk deletion of the identified interviews using `bulkDelete`, and then retries the Flow version deletion.\n- **Interactive Prompts:** Uses the `prompts` library to interact with the user for selecting Flows, statuses, and confirming deletion actions.\n- **Error Reporting:** Logs detailed error messages for failed deletions, including the specific reasons.\n- **Command-Line Execution:** Uses `execSfdxJson` to execute Salesforce CLI commands for querying Flow data.\n</details>\n",
7787
+ "description": "Retrieve sfdx sources in the context of a monitoring backup\n\nThe command exists in 2 modes: filtered(default & recommended) and full.\n\n## Filtered mode (default, better performances)\n\nAutomatically skips metadatas from installed packages with namespace. \n\nYou can remove more metadata types from backup, especially in case you have too many metadatas and that provokes a crash, using:\n\n- Manual update of `manifest/package-skip-items.xml` config file (then commit & push in the same branch)\n\n - Works with full wildcard (`<members>*</members>`) , named metadata (`<members>Account.Name</members>`) or partial wildcards names (`<members>pi__*</members>` , `<members>*__dlm</members>` , or `<members>prefix*suffix</members>`)\n\n- Environment variable MONITORING_BACKUP_SKIP_METADATA_TYPES (example: `MONITORING_BACKUP_SKIP_METADATA_TYPES=CustomLabel,StaticResource,Translation`): that will be applied to all monitoring branches.\n\n## Full mode\n\nActivate it with **--full** parameter, or variable MONITORING_BACKUP_MODE_FULL=true\n\nIgnores filters (namespaces items & manifest/package-skip-items.xml) to retrieve ALL metadatas, including those you might not care about (reports, translations...)\n\nAs we can retrieve only 10000 files by call, the list of all metadatas will be chunked to make multiple calls (and take more time than filtered mode)\n\n- if you use `--full-apply-filters` , manifest/package-skip-items.xml and MONITORING_BACKUP_SKIP_METADATA_TYPES filters will be applied anyway\n- if you use `--exclude-namespaces` , namespaced items will be ignored\n\n_With those both options, it's like if you are not using --full, but with chunked metadata download_\n\n## In CI/CD\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-metadata-backup/) and can output Grafana, Slack and MsTeams Notifications.\n\n## Troubleshooting\n\nIf you have unknown errors (it happens !), you can investigate using the full command with smaller chunks.\n\nExample: `sf hardis:org:monitor:backup --full --exclude-namespaces --full-apply-filters --max-by-chunk 500`\n\nIt will allow you the identify the responsible metadata and ignore it using package-skip-items.xml or MONITORING_BACKUP_SKIP_METADATA_TYPES env variable.\n\n## Documentation\n\n[Doc generation (including visual flows)](https://sfdx-hardis.cloudity.com/hardis/doc/project2markdown/) is triggered at the end of the command.\n\nIf you want to also upload HTML Documentation on your Salesforce Org as static resource, use variable **SFDX_HARDIS_DOC_DEPLOY_TO_ORG=\"true\"**\n\nIf you want to also upload HTML Documentation on Cloudflare, use variable **SFDX_HARDIS_DOC_DEPLOY_TO_CLOUDFLARE=\"true\"**\n\n- If you want to generate the documentation in multiple languages, define variable SFDX_DOC_LANGUAGES (ex: SFDX_DOC_LANGUAGES=en,fr,de)\n- You can define one Cloudflare site by language, for example with the following variables:\n - CLOUDFLARE_PROJECT_NAME_EN=cloudity-demo-english\n - CLOUDFLARE_PROJECT_NAME_FR=cloudity-demo-french\n - CLOUDFLARE_PROJECT_NAME_DE=cloudity-demo-german\n\nIf Flow history doc always display a single state, you probably need to update your workflow configuration:\n\n- on Gitlab: Env variable [`GIT_FETCH_EXTRA_FLAGS: --depth 10000`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.gitlab-ci.yml#L11)\n- on GitHub: [`fetch-depth: 0`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.github/workflows/org-monitoring.yml#L58)\n- on Azure: [`fetchDepth: \"0\"`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/azure-pipelines.yml#L39)\n- on Bitbucket: [`step: clone: depth: full`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/bitbucket-pipelines.yml#L18)\n",
7910
7788
  "examples": [
7911
- "$ sf hardis:org:purge:flow",
7912
- "$ sf hardis:org:purge:flow --target-org nicolas.vuillamy@gmail.com --no-prompt --delete-flow-interviews",
7913
- "$ sf hardis:org:purge:flow --target-org nicolas.vuillamy@gmail.com --status \"Obsolete,Draft,InvalidDraft\" --name TestFlow"
7789
+ "$ sf hardis:org:monitor:backup",
7790
+ "$ sf hardis:org:monitor:backup --full",
7791
+ "$ sf hardis:org:monitor:backup --full --exclude-namespaces",
7792
+ "$ sf hardis:org:monitor:backup --full --exclude-namespaces --full-apply-filters"
7914
7793
  ],
7915
7794
  "flags": {
7916
7795
  "json": {
@@ -7928,48 +7807,53 @@
7928
7807
  "multiple": false,
7929
7808
  "type": "option"
7930
7809
  },
7931
- "prompt": {
7932
- "char": "z",
7933
- "description": "Prompt for confirmation (true by default, use --no-prompt to skip)",
7934
- "name": "prompt",
7935
- "allowNo": true,
7810
+ "full": {
7811
+ "description": "Dot not take in account filtering using package-skip-items.xml and MONITORING_BACKUP_SKIP_METADATA_TYPES. Efficient but much much slower !",
7812
+ "name": "full",
7813
+ "allowNo": false,
7936
7814
  "type": "boolean"
7937
7815
  },
7938
- "name": {
7939
- "char": "n",
7940
- "description": "Filter according to Name criteria",
7941
- "name": "name",
7816
+ "max-by-chunk": {
7817
+ "char": "m",
7818
+ "description": "If mode --full is activated, maximum number of metadatas in a package.xml chunk",
7819
+ "name": "max-by-chunk",
7820
+ "default": 3000,
7942
7821
  "hasDynamicHelp": false,
7943
7822
  "multiple": false,
7944
7823
  "type": "option"
7945
7824
  },
7946
- "status": {
7947
- "char": "s",
7948
- "description": "Filter according to Status criteria",
7949
- "name": "status",
7825
+ "exclude-namespaces": {
7826
+ "char": "e",
7827
+ "description": "If mode --full is activated, exclude namespaced metadatas",
7828
+ "name": "exclude-namespaces",
7829
+ "allowNo": false,
7830
+ "type": "boolean"
7831
+ },
7832
+ "full-apply-filters": {
7833
+ "char": "z",
7834
+ "description": "If mode --full is activated, apply filters of manifest/package-skip-items.xml and MONITORING_BACKUP_SKIP_METADATA_TYPES anyway",
7835
+ "name": "full-apply-filters",
7836
+ "allowNo": false,
7837
+ "type": "boolean"
7838
+ },
7839
+ "start-chunk": {
7840
+ "description": "Use this parameter to troubleshoot a specific chunk. It will be used as the first chunk to retrieve",
7841
+ "name": "start-chunk",
7842
+ "default": 1,
7950
7843
  "hasDynamicHelp": false,
7951
7844
  "multiple": false,
7952
7845
  "type": "option"
7953
- },
7954
- "delete-flow-interviews": {
7955
- "char": "w",
7956
- "description": "If the presence of Flow interviews prevent to delete flows versions, delete them before retrying to delete flow versions",
7957
- "name": "delete-flow-interviews",
7846
+ },
7847
+ "skip-doc": {
7848
+ "description": "Skip the generation of project documentation at the end of the command",
7849
+ "name": "skip-doc",
7958
7850
  "allowNo": false,
7959
7851
  "type": "boolean"
7960
7852
  },
7961
- "allowpurgefailure": {
7853
+ "outputfile": {
7962
7854
  "char": "f",
7963
- "description": "Allows purges to fail without exiting with 1. Use --no-allowpurgefailure to disable",
7964
- "name": "allowpurgefailure",
7965
- "allowNo": true,
7966
- "type": "boolean"
7967
- },
7968
- "instanceurl": {
7969
- "char": "r",
7970
- "description": "URL of org instance",
7971
- "name": "instanceurl",
7972
- "default": "https://login.salesforce.com",
7855
+ "description": "Force the path and name of output report file. Must end with .csv",
7856
+ "name": "outputfile",
7973
7857
  "hasDynamicHelp": false,
7974
7858
  "multiple": false,
7975
7859
  "type": "option"
@@ -8012,58 +7896,58 @@
8012
7896
  },
8013
7897
  "hasDynamicHelp": true,
8014
7898
  "hiddenAliases": [],
8015
- "id": "hardis:org:purge:flow",
7899
+ "id": "hardis:org:monitor:backup",
8016
7900
  "pluginAlias": "sfdx-hardis",
8017
7901
  "pluginName": "sfdx-hardis",
8018
7902
  "pluginType": "core",
8019
7903
  "strict": true,
8020
7904
  "enableJsonFlag": true,
8021
- "title": "Purge Flow versions",
8022
- "requiresProject": false,
7905
+ "title": "Backup DX sources",
7906
+ "requiresProject": true,
7907
+ "triggerNotification": true,
8023
7908
  "isESM": true,
8024
7909
  "relativePath": [
8025
7910
  "lib",
8026
7911
  "commands",
8027
7912
  "hardis",
8028
7913
  "org",
8029
- "purge",
8030
- "flow.js"
7914
+ "monitor",
7915
+ "backup.js"
8031
7916
  ],
8032
7917
  "aliasPermutations": [],
8033
7918
  "permutations": [
8034
- "hardis:org:purge:flow",
8035
- "org:hardis:purge:flow",
8036
- "org:purge:hardis:flow",
8037
- "org:purge:flow:hardis",
8038
- "hardis:purge:org:flow",
8039
- "purge:hardis:org:flow",
8040
- "purge:org:hardis:flow",
8041
- "purge:org:flow:hardis",
8042
- "hardis:purge:flow:org",
8043
- "purge:hardis:flow:org",
8044
- "purge:flow:hardis:org",
8045
- "purge:flow:org:hardis",
8046
- "hardis:org:flow:purge",
8047
- "org:hardis:flow:purge",
8048
- "org:flow:hardis:purge",
8049
- "org:flow:purge:hardis",
8050
- "hardis:flow:org:purge",
8051
- "flow:hardis:org:purge",
8052
- "flow:org:hardis:purge",
8053
- "flow:org:purge:hardis",
8054
- "hardis:flow:purge:org",
8055
- "flow:hardis:purge:org",
8056
- "flow:purge:hardis:org",
8057
- "flow:purge:org:hardis"
7919
+ "hardis:org:monitor:backup",
7920
+ "org:hardis:monitor:backup",
7921
+ "org:monitor:hardis:backup",
7922
+ "org:monitor:backup:hardis",
7923
+ "hardis:monitor:org:backup",
7924
+ "monitor:hardis:org:backup",
7925
+ "monitor:org:hardis:backup",
7926
+ "monitor:org:backup:hardis",
7927
+ "hardis:monitor:backup:org",
7928
+ "monitor:hardis:backup:org",
7929
+ "monitor:backup:hardis:org",
7930
+ "monitor:backup:org:hardis",
7931
+ "hardis:org:backup:monitor",
7932
+ "org:hardis:backup:monitor",
7933
+ "org:backup:hardis:monitor",
7934
+ "org:backup:monitor:hardis",
7935
+ "hardis:backup:org:monitor",
7936
+ "backup:hardis:org:monitor",
7937
+ "backup:org:hardis:monitor",
7938
+ "backup:org:monitor:hardis",
7939
+ "hardis:backup:monitor:org",
7940
+ "backup:hardis:monitor:org",
7941
+ "backup:monitor:hardis:org",
7942
+ "backup:monitor:org:hardis"
8058
7943
  ]
8059
7944
  },
8060
- "hardis:org:retrieve:packageconfig": {
7945
+ "hardis:org:monitor:limits": {
8061
7946
  "aliases": [],
8062
7947
  "args": {},
8063
- "description": "\n**Retrieves the installed package configuration from a Salesforce org and optionally updates the local project configuration.**\n\nThis command is useful for maintaining an accurate record of installed packages within your Salesforce project, which is crucial for managing dependencies and ensuring consistent deployments across environments.\n\nKey functionalities:\n\n- **Package Listing:** Connects to a specified Salesforce org (or prompts for one if not provided) and retrieves a list of all installed packages.\n- **Configuration Update:** Offers the option to update your local project's configuration with the retrieved list of installed packages. This can be beneficial for automating package installations during environment setup or CI/CD processes.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Org Connection:** It establishes a connection to the target Salesforce org using the provided or prompted username.\n- **Metadata Retrieval:** It utilizes `MetadataUtils.listInstalledPackages` to query the Salesforce org and obtain details about the installed packages.\n- **Interactive Prompt:** It uses the `prompts` library to ask the user whether they want to update their local project configuration with the retrieved package list.\n- **Configuration Management:** If the user confirms, it calls `managePackageConfig` to update the project's configuration file (likely `.sfdx-hardis.yml`) with the new package information.\n- **User Feedback:** Provides clear messages to the user about the success of the package retrieval and configuration update.\n</details>\n",
7948
+ "description": "\n## Command Behavior\n\n**Checks the current usage of various Salesforce org limits and sends notifications if thresholds are exceeded.**\n\nThis command is a critical component of proactive Salesforce org management, helping administrators and developers monitor resource consumption and prevent hitting critical limits that could impact performance or functionality. It provides early warnings when limits are approaching their capacity.\n\nKey functionalities:\n\n- **Limit Retrieval:** Fetches a comprehensive list of all Salesforce org limits using the Salesforce CLI.\n- **Usage Calculation:** Calculates the percentage of each limit that is currently being used.\n- **Threshold-Based Alerting:** Assigns a severity (success, warning, or error) to each limit based on configurable thresholds:\n - **Warning:** If usage exceeds 50% (configurable via `LIMIT_THRESHOLD_WARNING` environment variable).\n - **Error:** If usage exceeds 75% (configurable via `LIMIT_THRESHOLD_ERROR` environment variable).\n- **CSV Report Generation:** Generates a CSV file containing all org limits, their current usage, maximum allowed, and calculated percentage used, along with the assigned severity.\n- **Notifications:** Sends notifications to configured channels (Grafana, Slack, MS Teams) with a summary of limits that have exceeded the warning or error thresholds.\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-org-limits/) and can output Grafana, Slack and MsTeams Notifications.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce CLI Integration:** It executes the `sf org limits list` command to retrieve the current org limits. It parses the JSON output of this command.\n- **Data Processing:** It iterates through the retrieved limits, calculates the `used` and `percentUsed` values, and assigns a `severity` (success, warning, error) based on the configured thresholds.\n- **Environment Variable Configuration:** Reads `LIMIT_THRESHOLD_WARNING` and `LIMIT_THRESHOLD_ERROR` environment variables to set the warning and error thresholds for limit usage.\n- **Report Generation:** It uses `generateCsvFile` to create the CSV report of org limits.\n- **Notification Integration:** It integrates with the `NotifProvider` to send notifications, including attachments of the generated CSV report and detailed metrics for each limit, which can be consumed by monitoring dashboards like Grafana.\n- **Exit Code Management:** Sets the process exit code to 1 if any limit is in an 'error' state, indicating a critical issue.\n</details>\n",
8064
7949
  "examples": [
8065
- "$ sf hardis:org:retrieve:packageconfig",
8066
- "sf hardis:org:retrieve:packageconfig -u myOrg"
7950
+ "$ sf hardis:org:monitor:limits"
8067
7951
  ],
8068
7952
  "flags": {
8069
7953
  "json": {
@@ -8081,6 +7965,14 @@
8081
7965
  "multiple": false,
8082
7966
  "type": "option"
8083
7967
  },
7968
+ "outputfile": {
7969
+ "char": "f",
7970
+ "description": "Force the path and name of output report file. Must end with .csv",
7971
+ "name": "outputfile",
7972
+ "hasDynamicHelp": false,
7973
+ "multiple": false,
7974
+ "type": "option"
7975
+ },
8084
7976
  "debug": {
8085
7977
  "char": "d",
8086
7978
  "description": "Activate debug mode (more logs)",
@@ -8119,49 +8011,50 @@
8119
8011
  },
8120
8012
  "hasDynamicHelp": true,
8121
8013
  "hiddenAliases": [],
8122
- "id": "hardis:org:retrieve:packageconfig",
8014
+ "id": "hardis:org:monitor:limits",
8123
8015
  "pluginAlias": "sfdx-hardis",
8124
8016
  "pluginName": "sfdx-hardis",
8125
8017
  "pluginType": "core",
8126
8018
  "strict": true,
8127
8019
  "enableJsonFlag": true,
8128
- "title": "Retrieve package configuration from an org",
8129
- "requiresProject": false,
8020
+ "title": "Check org limits",
8021
+ "requiresProject": true,
8022
+ "triggerNotification": true,
8130
8023
  "isESM": true,
8131
8024
  "relativePath": [
8132
8025
  "lib",
8133
8026
  "commands",
8134
8027
  "hardis",
8135
8028
  "org",
8136
- "retrieve",
8137
- "packageconfig.js"
8029
+ "monitor",
8030
+ "limits.js"
8138
8031
  ],
8139
8032
  "aliasPermutations": [],
8140
8033
  "permutations": [
8141
- "hardis:org:retrieve:packageconfig",
8142
- "org:hardis:retrieve:packageconfig",
8143
- "org:retrieve:hardis:packageconfig",
8144
- "org:retrieve:packageconfig:hardis",
8145
- "hardis:retrieve:org:packageconfig",
8146
- "retrieve:hardis:org:packageconfig",
8147
- "retrieve:org:hardis:packageconfig",
8148
- "retrieve:org:packageconfig:hardis",
8149
- "hardis:retrieve:packageconfig:org",
8150
- "retrieve:hardis:packageconfig:org",
8151
- "retrieve:packageconfig:hardis:org",
8152
- "retrieve:packageconfig:org:hardis",
8153
- "hardis:org:packageconfig:retrieve",
8154
- "org:hardis:packageconfig:retrieve",
8155
- "org:packageconfig:hardis:retrieve",
8156
- "org:packageconfig:retrieve:hardis",
8157
- "hardis:packageconfig:org:retrieve",
8158
- "packageconfig:hardis:org:retrieve",
8159
- "packageconfig:org:hardis:retrieve",
8160
- "packageconfig:org:retrieve:hardis",
8161
- "hardis:packageconfig:retrieve:org",
8162
- "packageconfig:hardis:retrieve:org",
8163
- "packageconfig:retrieve:hardis:org",
8164
- "packageconfig:retrieve:org:hardis"
8034
+ "hardis:org:monitor:limits",
8035
+ "org:hardis:monitor:limits",
8036
+ "org:monitor:hardis:limits",
8037
+ "org:monitor:limits:hardis",
8038
+ "hardis:monitor:org:limits",
8039
+ "monitor:hardis:org:limits",
8040
+ "monitor:org:hardis:limits",
8041
+ "monitor:org:limits:hardis",
8042
+ "hardis:monitor:limits:org",
8043
+ "monitor:hardis:limits:org",
8044
+ "monitor:limits:hardis:org",
8045
+ "monitor:limits:org:hardis",
8046
+ "hardis:org:limits:monitor",
8047
+ "org:hardis:limits:monitor",
8048
+ "org:limits:hardis:monitor",
8049
+ "org:limits:monitor:hardis",
8050
+ "hardis:limits:org:monitor",
8051
+ "limits:hardis:org:monitor",
8052
+ "limits:org:hardis:monitor",
8053
+ "limits:org:monitor:hardis",
8054
+ "hardis:limits:monitor:org",
8055
+ "limits:hardis:monitor:org",
8056
+ "limits:monitor:hardis:org",
8057
+ "limits:monitor:org:hardis"
8165
8058
  ]
8166
8059
  },
8167
8060
  "hardis:org:refresh:after-refresh": {
@@ -8377,30 +8270,137 @@
8377
8270
  ],
8378
8271
  "aliasPermutations": [],
8379
8272
  "permutations": [
8380
- "hardis:org:refresh:before-refresh",
8381
- "org:hardis:refresh:before-refresh",
8382
- "org:refresh:hardis:before-refresh",
8383
- "org:refresh:before-refresh:hardis",
8384
- "hardis:refresh:org:before-refresh",
8385
- "refresh:hardis:org:before-refresh",
8386
- "refresh:org:hardis:before-refresh",
8387
- "refresh:org:before-refresh:hardis",
8388
- "hardis:refresh:before-refresh:org",
8389
- "refresh:hardis:before-refresh:org",
8390
- "refresh:before-refresh:hardis:org",
8391
- "refresh:before-refresh:org:hardis",
8392
- "hardis:org:before-refresh:refresh",
8393
- "org:hardis:before-refresh:refresh",
8394
- "org:before-refresh:hardis:refresh",
8395
- "org:before-refresh:refresh:hardis",
8396
- "hardis:before-refresh:org:refresh",
8397
- "before-refresh:hardis:org:refresh",
8398
- "before-refresh:org:hardis:refresh",
8399
- "before-refresh:org:refresh:hardis",
8400
- "hardis:before-refresh:refresh:org",
8401
- "before-refresh:hardis:refresh:org",
8402
- "before-refresh:refresh:hardis:org",
8403
- "before-refresh:refresh:org:hardis"
8273
+ "hardis:org:refresh:before-refresh",
8274
+ "org:hardis:refresh:before-refresh",
8275
+ "org:refresh:hardis:before-refresh",
8276
+ "org:refresh:before-refresh:hardis",
8277
+ "hardis:refresh:org:before-refresh",
8278
+ "refresh:hardis:org:before-refresh",
8279
+ "refresh:org:hardis:before-refresh",
8280
+ "refresh:org:before-refresh:hardis",
8281
+ "hardis:refresh:before-refresh:org",
8282
+ "refresh:hardis:before-refresh:org",
8283
+ "refresh:before-refresh:hardis:org",
8284
+ "refresh:before-refresh:org:hardis",
8285
+ "hardis:org:before-refresh:refresh",
8286
+ "org:hardis:before-refresh:refresh",
8287
+ "org:before-refresh:hardis:refresh",
8288
+ "org:before-refresh:refresh:hardis",
8289
+ "hardis:before-refresh:org:refresh",
8290
+ "before-refresh:hardis:org:refresh",
8291
+ "before-refresh:org:hardis:refresh",
8292
+ "before-refresh:org:refresh:hardis",
8293
+ "hardis:before-refresh:refresh:org",
8294
+ "before-refresh:hardis:refresh:org",
8295
+ "before-refresh:refresh:hardis:org",
8296
+ "before-refresh:refresh:org:hardis"
8297
+ ]
8298
+ },
8299
+ "hardis:org:retrieve:packageconfig": {
8300
+ "aliases": [],
8301
+ "args": {},
8302
+ "description": "\n**Retrieves the installed package configuration from a Salesforce org and optionally updates the local project configuration.**\n\nThis command is useful for maintaining an accurate record of installed packages within your Salesforce project, which is crucial for managing dependencies and ensuring consistent deployments across environments.\n\nKey functionalities:\n\n- **Package Listing:** Connects to a specified Salesforce org (or prompts for one if not provided) and retrieves a list of all installed packages.\n- **Configuration Update:** Offers the option to update your local project's configuration with the retrieved list of installed packages. This can be beneficial for automating package installations during environment setup or CI/CD processes.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Org Connection:** It establishes a connection to the target Salesforce org using the provided or prompted username.\n- **Metadata Retrieval:** It utilizes `MetadataUtils.listInstalledPackages` to query the Salesforce org and obtain details about the installed packages.\n- **Interactive Prompt:** It uses the `prompts` library to ask the user whether they want to update their local project configuration with the retrieved package list.\n- **Configuration Management:** If the user confirms, it calls `managePackageConfig` to update the project's configuration file (likely `.sfdx-hardis.yml`) with the new package information.\n- **User Feedback:** Provides clear messages to the user about the success of the package retrieval and configuration update.\n</details>\n",
8303
+ "examples": [
8304
+ "$ sf hardis:org:retrieve:packageconfig",
8305
+ "sf hardis:org:retrieve:packageconfig -u myOrg"
8306
+ ],
8307
+ "flags": {
8308
+ "json": {
8309
+ "description": "Format output as json.",
8310
+ "helpGroup": "GLOBAL",
8311
+ "name": "json",
8312
+ "allowNo": false,
8313
+ "type": "boolean"
8314
+ },
8315
+ "flags-dir": {
8316
+ "helpGroup": "GLOBAL",
8317
+ "name": "flags-dir",
8318
+ "summary": "Import flag values from a directory.",
8319
+ "hasDynamicHelp": false,
8320
+ "multiple": false,
8321
+ "type": "option"
8322
+ },
8323
+ "debug": {
8324
+ "char": "d",
8325
+ "description": "Activate debug mode (more logs)",
8326
+ "name": "debug",
8327
+ "allowNo": false,
8328
+ "type": "boolean"
8329
+ },
8330
+ "websocket": {
8331
+ "description": "Websocket host:port for VsCode SFDX Hardis UI integration",
8332
+ "name": "websocket",
8333
+ "hasDynamicHelp": false,
8334
+ "multiple": false,
8335
+ "type": "option"
8336
+ },
8337
+ "skipauth": {
8338
+ "description": "Skip authentication check when a default username is required",
8339
+ "name": "skipauth",
8340
+ "allowNo": false,
8341
+ "type": "boolean"
8342
+ },
8343
+ "target-org": {
8344
+ "aliases": [
8345
+ "targetusername",
8346
+ "u"
8347
+ ],
8348
+ "char": "o",
8349
+ "deprecateAliases": true,
8350
+ "name": "target-org",
8351
+ "noCacheDefault": true,
8352
+ "required": true,
8353
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
8354
+ "hasDynamicHelp": true,
8355
+ "multiple": false,
8356
+ "type": "option"
8357
+ }
8358
+ },
8359
+ "hasDynamicHelp": true,
8360
+ "hiddenAliases": [],
8361
+ "id": "hardis:org:retrieve:packageconfig",
8362
+ "pluginAlias": "sfdx-hardis",
8363
+ "pluginName": "sfdx-hardis",
8364
+ "pluginType": "core",
8365
+ "strict": true,
8366
+ "enableJsonFlag": true,
8367
+ "title": "Retrieve package configuration from an org",
8368
+ "requiresProject": false,
8369
+ "isESM": true,
8370
+ "relativePath": [
8371
+ "lib",
8372
+ "commands",
8373
+ "hardis",
8374
+ "org",
8375
+ "retrieve",
8376
+ "packageconfig.js"
8377
+ ],
8378
+ "aliasPermutations": [],
8379
+ "permutations": [
8380
+ "hardis:org:retrieve:packageconfig",
8381
+ "org:hardis:retrieve:packageconfig",
8382
+ "org:retrieve:hardis:packageconfig",
8383
+ "org:retrieve:packageconfig:hardis",
8384
+ "hardis:retrieve:org:packageconfig",
8385
+ "retrieve:hardis:org:packageconfig",
8386
+ "retrieve:org:hardis:packageconfig",
8387
+ "retrieve:org:packageconfig:hardis",
8388
+ "hardis:retrieve:packageconfig:org",
8389
+ "retrieve:hardis:packageconfig:org",
8390
+ "retrieve:packageconfig:hardis:org",
8391
+ "retrieve:packageconfig:org:hardis",
8392
+ "hardis:org:packageconfig:retrieve",
8393
+ "org:hardis:packageconfig:retrieve",
8394
+ "org:packageconfig:hardis:retrieve",
8395
+ "org:packageconfig:retrieve:hardis",
8396
+ "hardis:packageconfig:org:retrieve",
8397
+ "packageconfig:hardis:org:retrieve",
8398
+ "packageconfig:org:hardis:retrieve",
8399
+ "packageconfig:org:retrieve:hardis",
8400
+ "hardis:packageconfig:retrieve:org",
8401
+ "packageconfig:hardis:retrieve:org",
8402
+ "packageconfig:retrieve:hardis:org",
8403
+ "packageconfig:retrieve:org:hardis"
8404
8404
  ]
8405
8405
  },
8406
8406
  "hardis:org:test:apex": {
@@ -9819,109 +9819,6 @@
9819
9819
  "auth:configure:project:hardis"
9820
9820
  ]
9821
9821
  },
9822
- "hardis:project:convert:profilestopermsets": {
9823
- "aliases": [],
9824
- "args": {},
9825
- "description": "\n## Command Behavior\n\n**Converts existing Salesforce Profiles into Permission Sets, facilitating a more granular and recommended security model.**\n\nThis command helps in migrating permissions from Profiles to Permission Sets, which is a best practice for managing user access in Salesforce. It creates a new Permission Set for each specified Profile, adopting a naming convention of `PS_PROFILENAME`.\n\nKey functionalities:\n\n- **Profile to Permission Set Conversion:** Automatically extracts permissions from a Profile and creates a corresponding Permission Set.\n- **Naming Convention:** New Permission Sets are named with a `PS_` prefix followed by the Profile name (e.g., `PS_Standard_User`).\n- **Exclusion Filter:** Allows you to exclude specific Profiles from the conversion process using the `--except` flag.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **External Plugin Integration:** It relies on the `shane-sfdx-plugins` (specifically the `sf shane:profile:convert` command) to perform the actual conversion.\n- **File System Scan:** It reads the contents of the `force-app/main/default/profiles` directory to identify all available Profile metadata files.\n- **Command Execution:** For each identified Profile (that is not excluded), it constructs and executes the `sf shane:profile:convert` command with the appropriate Profile name and desired Permission Set name.\n- **Error Handling:** Includes basic error handling for the external command execution.\n</details>\n",
9826
- "examples": [
9827
- "$ sf hardis:project:convert:profilestopermsets"
9828
- ],
9829
- "flags": {
9830
- "json": {
9831
- "description": "Format output as json.",
9832
- "helpGroup": "GLOBAL",
9833
- "name": "json",
9834
- "allowNo": false,
9835
- "type": "boolean"
9836
- },
9837
- "flags-dir": {
9838
- "helpGroup": "GLOBAL",
9839
- "name": "flags-dir",
9840
- "summary": "Import flag values from a directory.",
9841
- "hasDynamicHelp": false,
9842
- "multiple": false,
9843
- "type": "option"
9844
- },
9845
- "except": {
9846
- "char": "e",
9847
- "description": "List of filters",
9848
- "name": "except",
9849
- "default": [],
9850
- "hasDynamicHelp": false,
9851
- "multiple": true,
9852
- "type": "option"
9853
- },
9854
- "debug": {
9855
- "char": "d",
9856
- "description": "Activate debug mode (more logs)",
9857
- "name": "debug",
9858
- "allowNo": false,
9859
- "type": "boolean"
9860
- },
9861
- "websocket": {
9862
- "description": "Websocket host:port for VsCode SFDX Hardis UI integration",
9863
- "name": "websocket",
9864
- "hasDynamicHelp": false,
9865
- "multiple": false,
9866
- "type": "option"
9867
- },
9868
- "skipauth": {
9869
- "description": "Skip authentication check when a default username is required",
9870
- "name": "skipauth",
9871
- "allowNo": false,
9872
- "type": "boolean"
9873
- }
9874
- },
9875
- "hasDynamicHelp": false,
9876
- "hiddenAliases": [],
9877
- "id": "hardis:project:convert:profilestopermsets",
9878
- "pluginAlias": "sfdx-hardis",
9879
- "pluginName": "sfdx-hardis",
9880
- "pluginType": "core",
9881
- "strict": true,
9882
- "enableJsonFlag": true,
9883
- "title": "Convert Profiles into Permission Sets",
9884
- "requiresProject": true,
9885
- "requiresSfdxPlugins": [
9886
- "shane-sfdx-plugins"
9887
- ],
9888
- "isESM": true,
9889
- "relativePath": [
9890
- "lib",
9891
- "commands",
9892
- "hardis",
9893
- "project",
9894
- "convert",
9895
- "profilestopermsets.js"
9896
- ],
9897
- "aliasPermutations": [],
9898
- "permutations": [
9899
- "hardis:project:convert:profilestopermsets",
9900
- "project:hardis:convert:profilestopermsets",
9901
- "project:convert:hardis:profilestopermsets",
9902
- "project:convert:profilestopermsets:hardis",
9903
- "hardis:convert:project:profilestopermsets",
9904
- "convert:hardis:project:profilestopermsets",
9905
- "convert:project:hardis:profilestopermsets",
9906
- "convert:project:profilestopermsets:hardis",
9907
- "hardis:convert:profilestopermsets:project",
9908
- "convert:hardis:profilestopermsets:project",
9909
- "convert:profilestopermsets:hardis:project",
9910
- "convert:profilestopermsets:project:hardis",
9911
- "hardis:project:profilestopermsets:convert",
9912
- "project:hardis:profilestopermsets:convert",
9913
- "project:profilestopermsets:hardis:convert",
9914
- "project:profilestopermsets:convert:hardis",
9915
- "hardis:profilestopermsets:project:convert",
9916
- "profilestopermsets:hardis:project:convert",
9917
- "profilestopermsets:project:hardis:convert",
9918
- "profilestopermsets:project:convert:hardis",
9919
- "hardis:profilestopermsets:convert:project",
9920
- "profilestopermsets:hardis:convert:project",
9921
- "profilestopermsets:convert:hardis:project",
9922
- "profilestopermsets:convert:project:hardis"
9923
- ]
9924
- },
9925
9822
  "hardis:project:clean:emptyitems": {
9926
9823
  "aliases": [],
9927
9824
  "args": {},
@@ -11407,6 +11304,109 @@
11407
11304
  "xml:clean:project:hardis"
11408
11305
  ]
11409
11306
  },
11307
+ "hardis:project:convert:profilestopermsets": {
11308
+ "aliases": [],
11309
+ "args": {},
11310
+ "description": "\n## Command Behavior\n\n**Converts existing Salesforce Profiles into Permission Sets, facilitating a more granular and recommended security model.**\n\nThis command helps in migrating permissions from Profiles to Permission Sets, which is a best practice for managing user access in Salesforce. It creates a new Permission Set for each specified Profile, adopting a naming convention of `PS_PROFILENAME`.\n\nKey functionalities:\n\n- **Profile to Permission Set Conversion:** Automatically extracts permissions from a Profile and creates a corresponding Permission Set.\n- **Naming Convention:** New Permission Sets are named with a `PS_` prefix followed by the Profile name (e.g., `PS_Standard_User`).\n- **Exclusion Filter:** Allows you to exclude specific Profiles from the conversion process using the `--except` flag.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **External Plugin Integration:** It relies on the `shane-sfdx-plugins` (specifically the `sf shane:profile:convert` command) to perform the actual conversion.\n- **File System Scan:** It reads the contents of the `force-app/main/default/profiles` directory to identify all available Profile metadata files.\n- **Command Execution:** For each identified Profile (that is not excluded), it constructs and executes the `sf shane:profile:convert` command with the appropriate Profile name and desired Permission Set name.\n- **Error Handling:** Includes basic error handling for the external command execution.\n</details>\n",
11311
+ "examples": [
11312
+ "$ sf hardis:project:convert:profilestopermsets"
11313
+ ],
11314
+ "flags": {
11315
+ "json": {
11316
+ "description": "Format output as json.",
11317
+ "helpGroup": "GLOBAL",
11318
+ "name": "json",
11319
+ "allowNo": false,
11320
+ "type": "boolean"
11321
+ },
11322
+ "flags-dir": {
11323
+ "helpGroup": "GLOBAL",
11324
+ "name": "flags-dir",
11325
+ "summary": "Import flag values from a directory.",
11326
+ "hasDynamicHelp": false,
11327
+ "multiple": false,
11328
+ "type": "option"
11329
+ },
11330
+ "except": {
11331
+ "char": "e",
11332
+ "description": "List of filters",
11333
+ "name": "except",
11334
+ "default": [],
11335
+ "hasDynamicHelp": false,
11336
+ "multiple": true,
11337
+ "type": "option"
11338
+ },
11339
+ "debug": {
11340
+ "char": "d",
11341
+ "description": "Activate debug mode (more logs)",
11342
+ "name": "debug",
11343
+ "allowNo": false,
11344
+ "type": "boolean"
11345
+ },
11346
+ "websocket": {
11347
+ "description": "Websocket host:port for VsCode SFDX Hardis UI integration",
11348
+ "name": "websocket",
11349
+ "hasDynamicHelp": false,
11350
+ "multiple": false,
11351
+ "type": "option"
11352
+ },
11353
+ "skipauth": {
11354
+ "description": "Skip authentication check when a default username is required",
11355
+ "name": "skipauth",
11356
+ "allowNo": false,
11357
+ "type": "boolean"
11358
+ }
11359
+ },
11360
+ "hasDynamicHelp": false,
11361
+ "hiddenAliases": [],
11362
+ "id": "hardis:project:convert:profilestopermsets",
11363
+ "pluginAlias": "sfdx-hardis",
11364
+ "pluginName": "sfdx-hardis",
11365
+ "pluginType": "core",
11366
+ "strict": true,
11367
+ "enableJsonFlag": true,
11368
+ "title": "Convert Profiles into Permission Sets",
11369
+ "requiresProject": true,
11370
+ "requiresSfdxPlugins": [
11371
+ "shane-sfdx-plugins"
11372
+ ],
11373
+ "isESM": true,
11374
+ "relativePath": [
11375
+ "lib",
11376
+ "commands",
11377
+ "hardis",
11378
+ "project",
11379
+ "convert",
11380
+ "profilestopermsets.js"
11381
+ ],
11382
+ "aliasPermutations": [],
11383
+ "permutations": [
11384
+ "hardis:project:convert:profilestopermsets",
11385
+ "project:hardis:convert:profilestopermsets",
11386
+ "project:convert:hardis:profilestopermsets",
11387
+ "project:convert:profilestopermsets:hardis",
11388
+ "hardis:convert:project:profilestopermsets",
11389
+ "convert:hardis:project:profilestopermsets",
11390
+ "convert:project:hardis:profilestopermsets",
11391
+ "convert:project:profilestopermsets:hardis",
11392
+ "hardis:convert:profilestopermsets:project",
11393
+ "convert:hardis:profilestopermsets:project",
11394
+ "convert:profilestopermsets:hardis:project",
11395
+ "convert:profilestopermsets:project:hardis",
11396
+ "hardis:project:profilestopermsets:convert",
11397
+ "project:hardis:profilestopermsets:convert",
11398
+ "project:profilestopermsets:hardis:convert",
11399
+ "project:profilestopermsets:convert:hardis",
11400
+ "hardis:profilestopermsets:project:convert",
11401
+ "profilestopermsets:hardis:project:convert",
11402
+ "profilestopermsets:project:hardis:convert",
11403
+ "profilestopermsets:project:convert:hardis",
11404
+ "hardis:profilestopermsets:convert:project",
11405
+ "profilestopermsets:hardis:convert:project",
11406
+ "profilestopermsets:convert:hardis:project",
11407
+ "profilestopermsets:convert:project:hardis"
11408
+ ]
11409
+ },
11410
11410
  "hardis:project:deploy:notify": {
11411
11411
  "aliases": [],
11412
11412
  "args": {},
@@ -15370,5 +15370,5 @@
15370
15370
  ]
15371
15371
  }
15372
15372
  },
15373
- "version": "6.9.1-alpha202510262222.0"
15373
+ "version": "6.9.1-alpha202510262255.0"
15374
15374
  }