Newer Version Available

This content describes an older version of this product. View Latest

EnblProgramTaskDefinition

Represents an outcome, a milestone, or an exercise in an Enablement program. A program task is also known as a program item. This object is available in API version 60.0 and later.

Supported Calls

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

Special Access Rules

  • For Enablement admins to create, update, and delete Enablement programs, the Design and Deliver Enablement Programs permission is required. This permission is enabled by default as part of the Manage Enablement Essentials permission set, which comes with the Enablement add-on license.
  • For users who take Enablement programs, the Take Enablement Programs permission is required. This permission is enabled by default as part of the Use Enablement Programs permission set, which comes with the Enablement add-on license.
  • For partner users who take Partner Enablement programs, the Take Partner Enablement Programs permission is required. This permission is enabled by default as part of the Use Partner Enablement Programs permission set, which comes with the Enablement add-on license. Partner Enablement also requires a supported Partner Relationship Management (PRM) add-on license.

Fields

Field Details
Day
Type
int
Properties
Filter, Group, Sort
Description
The day of the program when the item is due, relative to the program's start date. For example, if a user is expected to complete an exercise where they watch a product demo by day 2, this field’s value is 2. For an outcome, this field specifies the number of days the full program takes. For example, if your program lasts 60 days, the value of this field is 60 for the outcome. This field’s value contributes to the program’s due date that users see when they take the program.
Description
Type
textarea
Properties
Create
Description
The description for the outcome, milestone, or exercise.
EnablementProgramId
Type
reference
Properties
Filter, Group, Sort
Description
ID of an Enablement program that contains the outcome, milestone, or exercise. This field is a relationship field.
Relationship Name
EnablementProgram
Relationship Type
Lookup
Refers To
EnablementProgram
EnblProgramSectionId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of an optional program section that contains the milestone or exercise. This field is a relationship field.
Relationship Name
EnblProgramSection
Relationship Type
Lookup
Refers To
EnblProgramSection
IsMilestoneAnOutcome
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Whether the program item is an outcome (true) or not (false). The default value is false.
LearningItemId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the learning item that the task is associated with. This field is a relationship field.
Relationship Name
LearningItem
Relationship Type
Lookup
Refers To
LearningItem
MilestoneTarget
Type
double
Properties
Filter, Nillable, Sort
Description
The outcome or milestone target for the user to achieve to get credit for completing the outcome or milestone. The unit depends on the specific measure that’s associated with the outcome or milestone. For example, if the measure is the dollar amount of all closed opportunities, then the field value is measured in dollars.
MinimumSampleSize
Type
int
Properties
Filter, Group, Nillable, Sort
Description
Represents the number of records that you want to evaluate for calculating an outcome or milestone that uses an average-based measure. Use this field in combination with MilestoneTarget. For example, if you want users to achieve an average deal size of $50,000 after closing 4 deals, then this field’s value is 4 and MilestoneTarget has a value of 50000.
Name
Type
string
Properties
Filter, Group, idLookup, Sort
Description
The name of the outcome, milestone, or exercise.
SequenceNumber
Type
int
Properties
Filter, Group, Sort
Description
A number for program items that have the same due date, starting at 0. The sequence number determines the order of items that users see for that day in the program.
TaskCategory
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The type of program item. Possible values are:
  • Exercise
  • Milestone
TaskSubCategory
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
The type of exercise, if the program item is an exercise. This value determines the content associated with the exercise. For example, if the field value is Video, the exercise must reference video content from the Enablement workspace in the Digital Experiences app. The LearningItemId field specifies the reference to that video content. Possible values are:
  • ActionItem
  • AudioRecording
  • Document
  • FeedbackRequest
  • Other
  • OtherExercise
  • ScheduledEvent
  • TextLesson
  • Trailhead
  • Video