Reconciling Profiles

Attribute
Type
Description
Package Types Applicable

reconcileProfiles

boolean

Reconcile profiles to only apply permissions to objects, fields and features that are present in the target org.

  • source

  • diff

In order to prevent deployment errors to target Salesforce Orgs, enabling reconcileProfiles totrue ensures and extra steps are taken to ensure the profile metadata is cleansed of any missing attributes prior to deployment.

During the reconcilement process, you can provide the follow flags to the command:

  • Folder - path to the folder which contains the profiles to be reconciled, if project contain multiple package directories, please provide a comma separated list, if

  • Profile List - list of profiles to be reconciled. If omitted, all the profiles components will be reconciled.

  • Source Only - set this flag to reconcile profiles only against component available in the project only. Configure ignored permissions in sfdx-project.json file in the array

  • Destination Folder - the destination folder for reconciled profiles, if omitted existing profiles will be reconciled and will be rewritten in the current location

For more details on thesfp profile reconcile command, click here.

// Sample package 

{
  "packageDirectories": [
      {    
      "path": "packages/access-mgmt",
      "package": "access-mgmt",
      "default": false,
      "versionName": "access-mgmt",
      "versionNumber": "1.0.0.0",
      "reconcileProfiles": "true"
    }

For more a more detailed understanding of the ProfileReconcile library, visit the GitHub repository "sfprofiles" for details of on the source.

Last updated

Was this helpful?