generateComparisonReport
- Karl Henselin
The operation generates the Comparison report as PDF and adds it to the execution reports tab. Compares the package version artifact against the Salesforce Org and generates a report with all the differences. This operation can be used in Build, PreDeploy, Deploy, or Utility workflow.
The typical use case would be generating a report as part of preDeploy to generate the report for the Salesforce Org that the package getting deployed to. So that users can review and approve the change to complete the deployment. You can use it after building the package version artifact in the build workflow by specifying the input of Salesforce Org accounts. So that it will generate a report for each Salesforce Org selected.
The report generates the following Pages:
Summary page with package details and summary of counts indicated total, new, and modified objects.
Count of New and Modified objects for each Object Type that is part of the packaged artifact.
List of New Objects (if new objects are part of packaged artifact)
List of Modified Objects (if modified objects are part of packaged artifact)
Changes for each modified object (if modified objects are part of packaged artifact)
Please note that if you have sub-components in the package, it will compare to the full object file in this version. When you read the report consider only your sub-component section in the Changes (#5 above) section.
Target Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Salesforce Account Code |
| Yes | Salesforce Account with all the required properties like User, Password, Client Id, etc. |
Cloud Account Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Salesforce User Email |
| Yes | Authentication User Email. |
Salesforce Password |
| No | The Salesforce password for Salesforce User. If you are using a security token, paste the 25-digit token value to the end of your password. If you don't know the security token, see Where is Reset Security Token option in salesforce |
JWT Key File |
| No | Path to a file containing the private key |
Client Id |
| No | OAuth client ID (sometimes called the consumer key) |
Development Org Type |
| No | Enter Org type for Development Environment. Eg: Sandbox or DevHub or Developer |
Salesforce URL |
| No | The login URL of the instance the org lives on |
Sandbox Name |
| No | The name of a Sandbox to access |
Inputs
Input Name | Input Code | Required | Description |
|---|---|---|---|
Salesforce Account Code |
| No | Multi-Select input to generate a report for specified accounts instead of environment’s Salesforce Org. If not provided, it gets the Salesforce Org from the environment’s property. |
Outputs
Output Name | Required | Description |
|---|---|---|
| No | Count for each Object type. It contains new and modified count for each object type that is in the package. It returns in the list format: [[ObjectType1, NewCount, ModifiedCount],[ObjectType2, NewCount, ModifiedCount],[ObjectType3, NewCount, ModifiedCount]] eg: [[ApexClass, 1, 0]] |
| No | List of new objects |
| No | List of Modified objects |
| No | Total new objects count. |
| No | Total modified objects count. |
Artifacts
This operation consumes artifacts from the artifacts repository.
Endpoint Selection
This operation will select all available endpoints associated with the Target.
Endpoint Execution
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
- style