cfg_insight_text_1000x132

Face your project with confidence.

Configuration Reports for Salesforce

It is essential to have a good understanding of configuration from various high-level functional points of view.

Configuration reports for Salesforce are documented below. We welcome suggestions for additional reports that you may find useful.

Snapshot Summary

The report gives an overview of the contents of the captured snapshot. It lists the following information by item type:

  • the number of items;
  • the total number of dependencies (successfully resolved references) to other configuration items; and
  • the total number of unresolved references. Unresolved references are errors in configuration as they involve dependency on a non-existent configuration item.
The number of items, dependencies and unresolved references by type in the snapshot

General Purpose Reports

The reports in this category are entirely product-agnostic, and document structural features of the configuration that have nothing to do with the specific software product, in this case Salesforce. The features in question are:

  • references between configuration items, including dependencies, dependents and unresolved references;
  • other configuration faults identified while Configo Insight was processing the configuration.

References

The report lists all items in the configuration, and for each item lists the following:

  • Aliases: alternative identities that the item adopts in different circumstances. For example, a Background Optimization in Click is also a general purpose Setting in a broader context.
  • Dependents: These are the items that reference the item in question. These are also the items that will potentially be affected if we make a change to the current item.
  • Dependencies: These are the items upon which the current item itself depends. In other words, these items are referenced from the current item’s definition.
References report filtered for items starting with "Background"

Unresolved References

The reports lists all unresolved references in the configuration. Unresolved references are configuration errors as they are a dependency on a non-existent configuration item. For each unresolved reference, the report lists:
  • The item in which it originates.
  • The reference itself, which includes the information about the field values that describe the dependency. For example, TaskStatus[Key=124147] means that the dependency is on a task status with key 124147 which doesn’t exist in the database.
  • The location (XPath) of the unresolved reference within the item.
Unresolved references report

Unreferenced Items

The reports lists all items in the configuration that are not referenced by anything. This indicates that those items are potentially unused.

An item being unreferenced is not necessarily an error. There are a number of situations where an item is expected to be unreferenced, for example:

  • Product configuration items with built-in roles, e.g. Agents Manager in Click.
  • The items that are triggered through custom code or through integration.

Still, it is useful to know which items are unreferenced in situations such as configuration clean-up or migration.

Unreferenced items report

Faults

This is a somewhat technical report that lists all faults encountered during the processing of the configuration.

While the report will not be very useful in most circumstances, it is indispensable in troubleshooting. We won’t document the information that it contains in detail as it is quite technical and requires some understanding of the way Configo processes configuration information.

A snippet from a Faults report

Objects

The report documents both the Salesforce data model (including built-in and custom objects) and the parts of the data model that are manageable via metadata API. While the latter is largely accessible through Salesforce Object Manager, the former is not as easily accessible.

Object List

At the top of the report is a sortable and filterable list of SObjects, listing their names, labels, key prefixes and whether they have metadata API’s CustomObject counterpart. 

The list of objects with their name, label, key prefix and whether they have a metadata CustomObject counterpart.
The list of objects with their name, label, key prefix and whether they have a metadata CustomObject counterpart.

Object Details

When you click on the name of any object, its detailed definition is displayed. This includes flags, URLs and field definitions.

Field definitions include each field’s detailed type definition, including hyperlinks to referenced objects for reference fields and all valid picklist values for picklists.

Insight-SFDC-10.SObjectDetails

Users

The report documents the Salesforce users and their properties including flags, their profile and assigned permission sets, as well as the permissions that they get as a result of those profiles’ and permission sets’ configurations.

User Details

At the top of the report is a sortable and filterable list of Salesforce users, including their username, name, email, user type, profile, permission sets and flags.

Insight-SFDC-21.UserList

User List

When you click on a username, the detailed information about the user is displayed. This includes everything that was listed above, but also all the permissions that the user has as the result of their profile and permission sets, as well as the origins (profiles and permission sets) of that permission.

Detailed user information including their permissions with their sources. For example, in this case we see that FieldServiceAccess permission is granted to the user through their profile and seven different permission sets.
Detailed user information including their permissions with their sources. For example, in this case we see that FieldServiceAccess permission is granted to the user through their profile and seven different permission sets.