LearningItemDetails
A learning item is a unit of learning that you can track in the Learning Management System (LMS). You can think of this as a university course catalog: each course, like Introduction to Wave Physics is a learning item. Those learning items can be tracked to see who has completed Introduction to Wave Physics. And Introduction to Wave Physics can be offered at multiple times to fit different student schedules. Each of those instances is a scheduled offering. In most cases, a learning item is a course, either online or in a classroom, but you can also use learning items to track books that employees are required to read or Standard Operating Procedures (SOPs) that they are required to sign-off on and understand.
Table-Specific Information
Select
The connector uses the SAPSuccessFactorsLMS API to process WHERE clause conditions that are built with the following columns and operators:- ItemID supports the = comparison operator.
- ItemTypeID supports the = comparison operator.
- RevisionDate supports the = comparison operator.
- IncludeDeeplink supports the =, !=, IS, and IS NOT comparison operators.
- OnlyShowInSystemLevelLocaleCurrency supports the =, !=, IS, and IS NOT comparison operators.
- IncludeInstructorDetails supports the =, !=, IS, and IS NOT comparison operators.
The connector processes other filters client-side within the connector.
For example, the following queries are processed server-side:
SELECT [User].[LearningPlan_Service].[LearningItemDetails].* FROM [User].[LearningPlan_Service].[LearningItemDetails] WHERE (([itemid] = 'HR_300') AND ([itemTypeId] = 'COURSE')) AND ([RevisionDate] = '2017-05-11 13:28:00')
Columns
| Name | Type | References | Required for Select | Description |
| PkID [KEY] | String | The learning item's key. A learning item key is a concatenation of the learning item's unique ID, the learning item's type ID, and the learning item's revision date, separated by dashes. The key helps you uniquely identify one specific type and revision of a learning item. | ||
| ApprovalRequired | Bool | If the value of this is true, then the users require approval to enroll into the course. If the value is false, then approval is not required. | ||
| ApprovalTimestamp | Datetime | The time that the person in charge of the approval granted the approval for the entity. | ||
| Approved | Bool | If the user is approved to enroll into the learning item, the value is true. If the user is not approved, the value is false. | ||
| ApprovedBy | String | The name of the user who approved the learning item. | ||
| AutoCompetency | Bool | If the value is true, then users are automatically evaluated in their competency at when they complete the course. | ||
| AutoFillEnrollment | Bool | If the value is true, then when a slot opens in the enrollment list, it is filled automatically from the waitlist. | ||
| CatalogSKU | String | A Stock Keeping Unit (SKU) is a unique ID of an object in learning, used for commercial tracking, inventory, and account balancing. | ||
| ChargebackMethod | String | This is unique ID of a chargeback method. Chargeback is a way to reconcile costs between organizations. One organization charges the cost of training back to another organization. This allows companies to balance the cost of training by putting the cost to organizations. | ||
| ChargeBackMethodLabelID | String | This is unique ID of a chargeback method LABEL. Because you can offer courses in many languages, you can describe the chargeback in many languages. The system uses this label ID to look up the correct string to describe the chargeback method in the users' language. Chargeback is a way to reconcile costs between organizations. One organization charges the cost of training back to another organization. This allows companies to balance the cost of training by putting the cost to organizations. | ||
| ChargebackMethodLabelValue | String | The description of the chargeback method in this user's language. Chargeback is a way to reconcile costs between organizations. One organization charges the cost of training back to another organization. This allows companies to balance the cost of training by putting the cost to organizations. | ||
| CheckAuthorizedInstructor | Bool | If the value is true, then the primary instructor of the segments must be authorized to teach the learning item. You set the learning items that an instructor is authorized to teach on the instructors' records. If it is false, then the primary instructor is not required to be authorized to teach the learning item. It is often false if you are not using instructor records or you are not keeping track of authorization to teach in the LMS. | ||
| ChecklistCompletionStatusID | String | The task checklist completion status ID. It is the completion status that the user is assigned if they pass the task checklist. | ||
| ChecklistEnabled | Bool | If the value of this is true, then task checklists are enabled for the learning item. Task checklists ask an observer to make sure that a user can complete a task in a series of steps. | ||
| ChecklistFailureStatusID | String | The task checklist failure status ID. It is the completion status that the user is assigned if they fail the task checklist. | ||
| ChecklistObserverTypeID | String | Observer types define the task checklist observer. | ||
| Classification | String | The unique ID of the classification for a learning item. It can be: It can be one of the following values: BLENDED, CONTINUOUS ONLINE ACCESS, EXTERNAL-COURSE, PHYSICAL GOOD, or TIME-BASED. A learning item classification is a category of a course, one that explains - in general terms - how the course is offered. It used by the LMS for business rules. For example, users do not enroll into a physical good, but do enroll into a an instructor led course. You cannot change the set of values for classification (they are set by the LMS). It can be one of the following values: BLENDED: Blended items are partly led by an instructor and partly online computer based training. Often the online portion is self-paced. CONTINUOUS ONLINE ACCESS: Online courses are always available to users. EXTERNAL-COURSE: External Courses are courses that have come in through the Open Content Network (OCN). PHYSICAL GOOD: Other courses that are most often a physical material like a book or CD. TIME-BASED: Instructor-led courses are classroom based courses, but the classroom can be physical or virtual (a conference call). | ||
| ClassificationLabelValue | String | The translated name of the classification of this learning item. The LMS uses the label ID to look up the correct translation (string) of the classification for this user's language. For example, TIME-BASED is usually represented to English speakers as Instructor Led. The system uses a label ID to look up the string | ||
| Comments | String | Comments from the instructor. | ||
| ComponentClassificationLabelID | String | The unique ID of the label for the classification of this learning item. The LMS uses the label ID to look up the correct translation (string) of the classification for this user's language. For example, TIME-BASED is usually represented to English speakers as Instructor Led. The system uses an label ID to look up the string | ||
| ComponentGoals | String | These are the goals that are associated with this learning item. | ||
| ComponentID | String | The unique ID of a learning item. | ||
| ComponentKey | Long | The unique key for the item. It is used in some parts of application such as bookmarking where we need to save multiple entities' primary keys. It must be a long number. | ||
| ComponentTypeDesc | String | The descriptions of item types can help you determine how the item type assigns credit. | ||
| ComponentTypeID | String | Item type IDs are a critical categorization in because they determine how users are marked complete for a learning item. One item type can have completion statuses of pass and fail while another might have completion statuses of pass, fail and incomplete. | ||
| ContactHours | Double | Contact hours are the total number of hours that you expect a user to have contact with an instructor. For example, if you set up a blended learning item that has 8 total hours and, for 6 of those hours, you expect the user to be in an instructor-led segment, then the contact hours equals 6. The hours can be inherited from the learning event (the course) or they can be specified when a user, supervisor, or administrator records completion with the Record Learning wizard. | ||
| ContactName | String | The contact name is someone who can answer questions about the learning item. | ||
| CourseDeeplink | String | If you requested a deep link in your search for learning items, and if this learning item contains online content, then this is populated with the link to the online content. Users click the link to go to the online content for this learning item. If they are not already authenticated to the system, they must authenticate before they can see the page. | ||
| CpeHours | Double | CPE is an abbreviation for | ||
| CreateTimestamp | Datetime | The time stamp, in Unix Epoch, that the learning item was created | ||
| CreditHours | Double | Credit hours are the number of hours that a user earns for completing a learning event. For example, in many U.S. colleges, students attend a single class for 15 weeks, 3 days each week, and 1 hour each day. In this case, the total hours equals 45; however, the college grants 3 CREDIT HOURS for this class. The hours can be inherited from the learning event (the course) or they can be specified when a user, supervisor, or administrator records completion with the Record Learning wizard. | ||
| DefaultInitialBasisTypeID | String | The basis type can be calendar or event. In a calendar basis type, the user must retrain on a learning item on a time-interval based on the calendar (like every month). In an event, the period is based on an event, like completing the first round of training. | ||
| DefaultInitialNumber | Long | The initial number is the number of days, weeks, months, quarters, or years that the user has in their initial retraining period for this learning item. Retraining periods apply when the learning item is a member of a curriculum. It is the grace period when users are first assigned a learning item. Although they might be required to retrain on the learning item every year, they might be assigned the curriculum (and learning item) in the last month of the year. The initial period gives them a grace period to complete the first training. | ||
| DefaultInitialPeriodTypeID | String | The unit for the initial period (days, weeks months, quarters, or years). | ||
| DefaultRetrainingBasisTypeID | String | The retraining period type can be either calendar or event. If it is calendar, then the user must retrain based on a time-based interval (such as annually, regardless of when the user completed the last training). If it is event, then the user must retrain based on an event (such as a year after completing the training). | ||
| DefaultRetrainingNumber | Long | After the initial period, users must retrain. This is the number of days, weeks, months, quarters, or years that the users have to complete the retraining on the learning item. | ||
| DefaultRetrainingPeriodTypeID | String | The period that a user must retrain after the initial period. This can be days, weeks, months, quarters, or years. | ||
| DeliveryMethodDescription | String | The description of a delivery method. A delivery method describes how a learning item will be delivered (for example, a book, PDF file, or online course). You can create or modify method IDs in the administration environment, in References: Learning: Delivery Methods | ||
| DeliveryMethodID | String | The unique ID of a delivery method. A delivery method describes how a learning item will be delivered (for example, a book, PDF file, or online course). You can create or modify method IDs in the administration environment, in References: Learning: Delivery Methods | ||
| Description | String | The description of the learning item in the language of the current user (the user calling the web service). A description is intended to provide details to users so that they can decide if they are interested in the course. Descriptions can be translated using a key/value pair, where the key uniquely identifies a particular learning item's description and the values are each language's translation of the description. If you need the key that matches this value, look in DescriptionLabelKey. | ||
| DomainDescription | String | The description of the security domain of the entity. You can associate a record with an access domain to control the administrators who can access the record. What an administrator can access and do for a record depends on how you configured the entity, function, and workflow domain restrictions of the role ID that is associated with the administrator. | ||
| DomainID | String | The security domain ID of the entity. You can associate a record with an access domain to control the administrators who can access the record. What an administrator can access and do for a record depends on how you configured the entity, function, and workflow domain restrictions of the role ID that is associated with the administrator. | ||
| EnableOrder | Bool | If the value of this is true, then orders can be created for the entity (users can order it). If it is false, then orders cannot be created. | ||
| EnableRating | Bool | If the value of this is true, then users can rate the learning item. If it is false, then users cannot rate the learning item. | ||
| EnrollmentThresDays | Long | The amount of days before the course that the enrollment is closed for the course. | ||
| ESigEnabled | Bool | If the value is true, then e-signatures are required for actions with this learning item. If false, then e-signatures are not required. E-signatures are a secondary identity verification for things like recording the completion of a learning item. They are typically used by companies that are audited by an oversight organization for learning compliance. | ||
| ForumID | Long | Forums are deprecated. Instead, use SAP Jam. If your learning item is associated with a deprecated forum, the ID appears here. | ||
| GradingOption | Long | The grading option of the learning item. You can see the grading options in the administration environment on the learning item record in the Grading Options view. | ||
| HtmlDescription | String | The description of the learning item, in the users' language, with HTML tags to format the description. Customers often use simple inline tags to bold and italicize words (for example). | ||
| IncludePreviousRevisionRating | Bool | If the value of this is true, then the overall rating includes ratings given to previous revisions of the learning item. If it is false, then the ratings are calculated from the current revision only. | ||
| InitialBasisLabelID | String | The label ID for the initial basis, so that you can look up the exact language. | ||
| InitialPeriodLabelID | String | The label ID for the initial period, so that you can look up the language. | ||
| InstructorMaterials | String | This is materials that the instructor should have for the learning item. | ||
| IsAuthorizedObserver | Bool | If the value of this is true, then this user is an authorized observer for the task checklist attached to this learning item. | ||
| IsBlendedLearningRegisterRequired | Bool | If this value is true, then if the classification ID is BLENDED, then users must enroll for the learning item, even to see the online portions of the course. If it is false, then users can see the online portions without enrolling. | ||
| IsUserRequestsEnabled | Bool | If the value is true, then users can request a scheduled offering of a learning item. If false, they cannot request a new offering. Users request scheduled offerings when the current list of times that the learning item is offered does NOT include a time that they can attend the course. A learning item is a unit of learning that you can track in the Learning Management System (LMS). You can think of this as a university course catalog: each course, like Introduction to Wave Physics is a learning item. Those learning items can be tracked to see who has completed Introduction to Wave Physics. And Introduction to Wave Physics can be offered at multiple times to fit different student schedules. Each of those instances is a scheduled offering. | ||
| ItemDetailsDeeplink | String | If you requested a deep link in your search for learning items, this is populated with the link to the learning item details page. Users click the link to see the details for this learning item. If they are not already authenticated to the system, they must authenticate before they can see the page. | ||
| LastUpdateUser | String | The user who most recently updated the entity. | ||
| LessionPlanFilename | String | The lesson plan that goes with the learning item. For example, it can be a valid URL to an online lesson plan or a name of a training document. Administrators or trainers can consult the lesson plan to help them prepare for the learning item. | ||
| ItemID | String | True | The unique ID of the learning item. | |
| ItemTypeID | String | True | The type ID of the learning item. | |
| MaxEnrollment | Long | The maximum amount of users who can enroll into the course. | ||
| MinEnrollment | Long | The minimum amount of users who must enroll into the course for the course to take place. | ||
| NotActive | Bool | If the value is false then the user is active. If the value is true, then the user is inactive. | ||
| PrepLength | Double | The total length of time that it takes an instructor to prepare to teach the course. Typically, this is used for planning purposes. | ||
| ProcessDefinitionID | String | The unique ID of the approval process definition (as opposed to the ID of the instance of the approval). | ||
| ProcessDescription | String | A description of the approval process. For example Approval to Withdraw from Training. | ||
| ProductionReady | Bool | If this value is true, then the learning item is ready to be assigned to users. If the value is false, then the learning item is under development and not yet ready for users. | ||
| Rating | Double | The rating that users have given the learning item. | ||
| RequirementTypeDescription | String | The description of a requirement type. A requirement type is a way for companies to describe how a user can meet the requirement. For example, a user can finish a set amount of hours from within a pool of learning items. | ||
| RequirementTypeID | String | The unique ID of a requirement type. A requirement type is a way for companies to describe how a user can meet the requirement. For example, a user can finish a set amount of hours from within a pool of learning items. | ||
| RetrainingBasisLabelID | String | The label ID for the training basis, so that you can look up the language. | ||
| RetrainingPeriodLabelID | String | The label ID for the retraining period, so that you can look up the language. | ||
| ReviserName | String | The name of the user who revised the learning item. | ||
| RevisionDate | Datetime | True | The revision date of this entity. Learning items often have revision dates that correspond to a regulator's revision of compliance measures. Each later revision date is a later iteration of a learning item. | |
| RevisionNo | String | The revision number of this entity. Each revision date has a revision number. Users sometimes know the revision number of training instead of the revision date. For example, they might know that they want revision 2 of a training, regardless of the date that it was revised. | ||
| SafetyRelated | Bool | If a learning item is safety related (if safetyRelated is true) then the learning item is flagged as safety-related in searches and reports. This information is for administrative purposes. It is not in the end-user interface by default. | ||
| ScheduleCanOverridePrice | Bool | If this value is true, then each instance of a course (scheduled offering) can override the price that is set in master copy of the course (learning item). If the value is false, then every course created from the master copy (learning item) inherits the price from the master copy. | ||
| SelfEnrollment | Bool | If this value is true, then users can enroll themselves into this entity. If false, then they cannot enroll themselves. Enrollment is not necessarily automatic when this value is true. There could be an approval process attached to enrollment. | ||
| ShippingRequired | Bool | If this value is true, then the learning item has some component that must be shipped. This is often the case if the learning item is a physical good, like a book. If it is false, then there is nothing to ship. For example, if this learning item is an online course, there is nothing to ship. | ||
| SourceDescription | String | A field on learning items that typically describes the developer of the course. For example, if you use third parties to create course material for you, then the third party that developed THIS learning item can be recorded in source. | ||
| SourceID | String | The source is the developer of the learning item or the organization or regulatory body that requires it. You can create or modify source IDs in the administration environment, in References: Learning: Item Sources. | ||
| StudentCanRecordLearningEvents | Bool | If the value of this is true, then the user can record learning events for this learning item. If the value is false, then only supervisors or administrators can record learning on the learning item. In SuccessFactors Learning, when someone records a learning event, they are posting a users' completion or inability to complete a course back to the LMS. For example, you can record the fact that a user attended the course and completed it. Or, you can record the fact that a user did NOT complete the event. Completion is a highly configurable part of the LMS, so your completion statuses (the thing you are posting/recording) will be your own and match your business process. | ||
| StudentMaterials | String | This is materials that the student (learner) should have for the learning item. | ||
| SupervisorCanRecordLearningEvents | Bool | If the value of this is true, then the supervisor can record learning events for this learning item. If the value is false, then only administrators can record learning on the learning item. In most cases, when a supervisor cannot record learning, a user cannot record learning either. In SuccessFactors Learning, when someone records a learning event, they are posting a users' completion or inability to complete a course back to the LMS. For example, you can record the fact that a user attended the course and completed it. Or, you can record the fact that a user did NOT complete the event. Completion is a highly configurable part of the LMS, so your completion statuses (the thing you are posting/recording) will be your own and match your business process. | ||
| TargetAudience | String | A description of the intended target audience that the you can display in the user interface. It helps users understand who the course is planned to address. | ||
| ThumbnailURI | String | The URI that leads to the thumbnail image for this entity. Thumbnails are images that act like icons: they help users understand something about the entity from a glance. | ||
| Title | String | The title of the learning item in the language of the current user (the user calling the web service). Titles can be translated using a key/value pair, where the key uniquely identifies a particular learning item's title and the values are each language's translation of the title. If you need the key that matches this value, and if the web service supports it, look in TitleLabelKey. | ||
| TotalLength | Double | The total length of time that the course takes. Typically, this is used for planning purposes. | ||
| UserCanWaitlist | Bool | If this value is true, then the user can get on the wait list for the course. If someone withdraws from the course, the system picks users in the order that they went onto the wait list. In a literal sense, this user can move himself/herself to the registration status of Waitlisted. | ||
| WaitlistRemainderSentTimestamp | Datetime | The time that the remainder of users on the waitlist was sent as a reminder. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| IncludeDeeplink | Bool | If this value is true, then the search returns a deep link to the entities it returns. | |
| OnlyShowInSystemLevelLocaleCurrency | Bool | If true, only display prices in the system-level locale currency. | |
| IncludeInstructorDetails | Bool | If set to true, then the search returns details about the instructor. This can be useful, for example, if you want to advertise the instructor in order to get learners excited about attending training under that instructor. If you aren't using instructors, set to false. |