OrgMetricScanSummary

Represents the results summary for a specific feature in a Salesforce Optimizer evaluation.

Introduced in API version 47.0.

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

  • This object is only available in orgs where Salesforce Optimizer is enabled. Requires the Modify All Data and Customize Application user permissions.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The message returned if an error occurred during the most recent Optimizer evaluation.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The numerical limit of a feature.
  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    The estimated time needed to complete the recommended actions for the feature.

    The default value is 30 minutes.

  • Possible values:

    • 1 - 2 hours — 1 - 2 hours — 2 hours`
    • 30 - 60 minutes — 30 - 60 minutes — 60 minutes`
    • < 30 minutes — < 30 minutes
    • > 2 hours — > 2 hours
  • Default value: 30 minutes

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The number of issues found for the feature. Corresponds to the number of OrgMetricScanResult objects generated for the feature in an Optimizer evaluation.
  • Type: string
  • Properties: Filter, Group, idLookup, Sort
  • Description: A number that identifies the feature’s results summary.
  • 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: masterdetail

  • Refers to: OrgMetric

  • Type: percent
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: A percentage associated with a feature.
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The time that the report for the Optimizer evaluation was generated.
  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    The recommended action for the feature.

    The default value is No Action Required.

  • Possible values:

    • Action Required — Action Required
    • Immediate Action Required — Immediate Action Required
    • No Action Required — No Action Required (default)
    • Not Currently Enabled — Not Currently Enabled
    • Review Required — Review Required
    • Unable to Analyze — Unable to Analyze
  • Default value: No Action Required

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The unit of measurement used in the feature’s results summary.