Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

OrgMetricScanSummary

Represents the results summary for a specific feature in a Salesforce Optimizer evaluation. This object is available in API version 47.0 and later.

Supported Calls

create(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), upsert()

Special Access Rules

This object is only available in orgs where Salesforce Optimizer is enabled. Requires the Modify All Data and Customize Application user permissions.

Fields

Field	Details
ErrorMessage	Type picklist Properties Create, Filter, Group, Nillable, Sort Description The message returned if an error occurred during the most recent Optimizer evaluation.
FeatureLimit	Type int Properties Create, Filter, Group, Nillable, Sort Description The numerical limit of a feature. Example For the Custom Field Limits feature, FeatureLimit is `500` for Developer Edition orgs.
ImplementationEffort	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description The estimated time needed to complete the recommended actions for the feature. Possible values are: `1 - 2 hours` `30 - 60 minutes` `< 30 minutes` `> 2 hours` The default value is `30 minutes`.
ItemCount	Type int Properties Create, Filter, Group, Nillable, Sort Description The number of issues found for the feature. Corresponds to the number of OrgMetricScanResult objects generated for the feature in an Optimizer evaluation.
Name	Type string Properties Filter, Group, idLookup, Sort Description A number that identifies the feature’s results summary.
OrgMetricId	Type reference Properties Create, Filter, Group, Sort Description The OrgMetric ID that represents the feature analyzed in the Optimizer evaluation. This field is a relationship field. Relationship Name OrgMetric Relationship Type Master-detail Refers To OrgMetric (the master object)
PercentUsage	Type percent Properties Create, Filter, Nillable, Sort Description A percentage associated with a feature. Example For the Incomplete Chatter Profiles feature, the PercentUsage value is `100` if 100% of users have complete Chatter profiles.
ScanDate	Type dateTime Properties Create, Filter, Nillable, Sort Description The time that the report for the Optimizer evaluation was generated.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort Description The recommended action for the feature. Possible values are: `Action Required` `Immediate Action Required` `No Action Required` `Not Currently Enabled` `Review Required` `Unable to Analyze` The default value is `No Action Required`.
Unit	Type string Properties Create, Filter, Group, Nillable, Sort Description The unit of measurement used in the feature’s results summary. Example For the Data Storage feature, the Unit is `MB`.

Object Reference for the Salesforce Platform

OrgMetricScanSummary

Supported Calls

Special Access Rules

Fields

See Also