Program

ActionPlanTemplateId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The action plan template that's associated with the program.

  This field is a relationship field.

  This field is available from API version 65.0 and later.

• Relationship Name: ActionPlanTemplate
• Refers To: ActionPlanTemplate

ActiveEnrolleeCount

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The count of program enrollees with IsActive on ProgramEnrollment selected. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

AdditionalContext

• Type: textarea
• Properties: Create, Nillable, Update
• Description: The additional context about the program.

CurrentMonthDisbCount

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The count of benefits disbursed in the current month. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

CurrentYearDisbCount

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The count of benefits disbursed in the current year. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

EndDate

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The date when the program ends.

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 LastReferenceDate is not null, the user accessed this record or list view.

Name

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

OwnerId

• Type: reference
• Properties: Create, Defaulted on create, Filter, Group, Sort, Update
• Description: The user who owns the object.

  This field is a polymorphic relationship field.

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

ParentProgramId

• Type: reference
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The associated parent program.

  This field is available from API version 59.0 and later.

  This field is a relationship field.

• Relationship Name: ParentProgram
• Relationship Type: Lookup
• Refers To: Program

PreviousMonthDisbCount

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The count of benefits disbursed in the previous month. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

PreviousYearDisbCount

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The count of benefits disbursed in the previous year. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

StartDate

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The date when the program begins.

Status

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The status of the program.

  This field is accessible if you enabled Data Protection and Privacy in Setup.

• Possible values:
  • Active
  • Cancelled
  • Completed
  • Planned

Summary

• Type: string
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The summary of the program.

TotalEnrolleeCount

• Type: double
• Properties: Create, Filter, Nillable, Sort, Update
• Description: The total count of enrollees in the program. Data Processing Engine calculates this field if you activate the Program Management Data Processing Engine Definition templates in Setup. You can schedule this calculation to run on a regular basis.

UsageType

• Type: picklist
• Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
• Description: Specifies the usage type of the program.

  Possible value is ProgramManagement.

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.

ProgramChangeEvent

Change events are available for the object.

ProgramFeed

Feed tracking is available for the object.

ProgramHistory

History is available for tracked fields of the object.

ProgramOwnerSharingRule

Sharing rules are available for the object.

ProgramShare

Sharing is available for the object.