Salesforce Docs Portal

ProductGuidance

Represents information about key product messages, product objectives, or other information that can assist or guide users when working with the product. This object is available in API version 65.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

ContentText

  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The product guidance message or objective.

EffectiveEndDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date after which the guidance is no longer available.

EffectiveStartDate

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The date when the product guidance takes effect.

GroupName

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The group name used to categorize messages.

GroupSequence

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The sequence in which group are displayed.

IsActive

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether the product guidance is active (true) or not (false).
  • Default value: false

IsReactionSelectionHidden

  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: Indicates whether reaction capture is hidden (true) or not (false).
  • Default value: false

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDateis not null, the user accessed this record or list view indirectly.

Name

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the product guidance.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: ID of the owner of this object.

    This field is a polymorphic relationship field.

  • Relationship Name: Owner
  • Refers To: Group, User

Priority

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The default priority order of product guidance messages and objectives.

ProductReferenceRecordId

  • Type: reference
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The product that's associated with the product guidance.

    This field is a polymorphic relationship field.

  • Relationship Name: ProductReferenceRecord
  • Refers To: LifeSciMarketableProduct, Product2

Reactions

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: A semicolon-delimited list of custom reactions captured by the user.

SourceSystemIdentifier

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Description: The identifier of the record in the source system.

SourceSystemName

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the system from which data is loaded into the object.

Type

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Specifies the type of the product guidance.
  • Default value: Message
  • Possible values:
    • Message
    • Objective
    • Other

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ProductGuidanceChangeEvent
Change events are available for the object.
ProductGuidanceFeed
Feed tracking is available for the object.
ProductGuidanceHistory
History is available for tracked fields of the object.
ProductGuidanceShare
Sharing is available for the object.