PeopleSoft Student Records 9.0 PeopleBook

Managing Interoperability for LMSs

This chapter provides overviews of the learning management system (LMS) interoperability batch extract, the integration with LMS self-service authentication, and LMS setup and discusses how to:

Set up LMS values and default options.
Run the LMS Batch Extract process.
Using self-service pages and LMS authentication.

Understanding the LMS Interoperability Batch Extract

The goal of an LMS is to use a common set of interoperability standards that enable the sharing of instructional content and data between learning and administrative environments. Based on instructional management systems (IMS) enterprise system specifications, currently PeopleSoft LMS interoperability batch extract supports one-way file transfer between PeopleSoft Campus Solutions and an external learning management system.

PeopleSoft LMS extract enables institutions to provide a third-party LMS (such as Blackboard CourseInfo) with personal profile data for learners and instructors, enrollment data and maintenance, and limited course scheduling data and maintenance. The LMS batch extract also provides basic integration with PeopleSoft Student Portal. Depending on your extract target, you can format LMS data with a unique file type of XML V1.1, Blackboard CourseInfo 4, or API Input (a WebCT format currently being phased out). WebCT Campus Edition Institutional (version 4.1) and WebCT Vista 2.1 both support XML V1.1

Currently, the feature does not support passing data or information back to PeopleSoft Campus Solutions from another LMS environment; nor does it include a real-time transactional messaging interface based on event processing.

PeopleSoft LMS batch extract supports IMS Enterprise Specification V1.1 XML data binding specifications. It also supports a simple, common, delimited option for API Input format.

File selection criteria are available at runtime for you to specify which type of files to pass. In addition, you can use packaging options to indicate how you want the system to organize the extract files.

The PeopleSoft LMS interoperability extract includes the following extract functions:

Administrative (properties object) data that describes the contents of an extract file.
Personal (person object) data about students and instructors that are associated with the LMS classes included in the extract.
High-level class (group object) data describing each LMS class that is included in the extract.

This includes group term information and group course information.
Student enrollment and instructor (group membership object) data for each LMS class.

The group is the LMS class and the membership includes the students and instructors that are associated with the LMS class.

High-level definitions for each of these data are provided in the following sections.

Properties Object Data

The properties object data serves as a file header and contains descriptive data about the contents of the file.

Person Object Data

Person object data includes:

The person source ID wherein 1) the source is the academic institution with which the student or instructor is associated, and 2) the ID is either the individual's employee ID or user ID, depending on which is specified on the Academic Institution 3 page.
The user ID, which is either the employee ID or user ID, depending on which is specified on the Academic Institution 3 page, of the student or instructor.
Personal data for all students enrolled or previously enrolled in the selected LMS classes and the instructors teaching the classes.

Group Object Data - Term Information

Group object data - term information includes:

The source ID wherein 1) the source is the description of the academic institution in which the classes are scheduled, and 2) the ID is the term code.
The term description information and the term start and end dates.

Group Object Data - Course Information

Group object data - course information includes the source ID, wherein 1) the source is the description of the academic institution in which the class is scheduled, and 2) the ID is a unique identifier for the group. The group identifies the LMS class, which, by default, is TERM-INSTITUTION-SUBJECT-CATALOG NBR-SEC#-CLASS NBR

The ID includes the term code and class number added to the autogenerated LMS extract group ID from the LMS Data page in the schedule of classes.

Group Membership Object Data - Group

Group membership object data - group includes the source ID, which is the same as the source ID for group object data - course information.

Group Membership Object Data - Member

Group membership object data - member includes:

The source ID, which is the same as the person source ID for person object data.
The ID type for person or group.
The role and, for instructors, the subrole, if any.
The user ID (same as the person user ID for person object data).
The class start and end dates.
The enrollment status reason.
For students only, a mode (grading basis) and result final grade.
The student's preferred email address, or campus or home email address.
The datasource, which is set on the run control page.

Understanding Integration with LMS Self-Service User Authentication

PeopleSoft LMS interoperability also provides single sign on authentication within PeopleSoft Campus Self Service, enabling students and instructors to access their learning management system home page and academic content for their LMS classes without having to sign on to the LMS website.

PeopleSoft LMS authentication uses the IMS enterprise system specifications to create a batch XML V1.1 extract file that is imported into the external LMS database. The XML V1.1 LMS extract file type is designated within the schedule of classes and autogenerates an LMS extract group ID that the system supplements with a term code and the class number to create a unique class identifier.

The LMS authentication passes user ID information and, as required, the unique class identifier to the LMS website. The user is authenticated and taken to the designated page within the LMS website, either the user's home page or the academic content for a specific class.

Note. Currently, WebCT Vista 2.1 and WebCT Campus Edition Institutional (version 4.1) are the only external learning management systems using the LMS authentication feature. Prior versions of WebCT are not supported. To determine whether support for other LMS applications has been added since this publication, please contact your PeopleSoft GSC representative.

See Also

Configuring Self-Service User Authentication for Your Learning Management System Website, which is posted to My Oracel Support.

Understanding LMS Setup

As you prepare to set up the LMS batch extract feature, consider the following questions:

What type of batch extract file does your LMS vendor use: XML V1.1 (required for PeopleSoft LMS authentication), Blackboard CourseInfo 4.0, or the API Input format (a WebCT format currently being phased out)?
If personal data is something that you need to extract, what phone type and address usage do you want to extract for the person objects?

Note. If you use the Blackboard CourseInfo extract file type, all persons whom you extract must have electronic addresses in the system.
Will all of your classes need to be available for extract to an LMS system?

Each LMS extract file type presents slightly different extract processing requirements. Before you use the LMS Batch Extract component, familiarize yourself with the requirements of the file type that you plan to use.

All of the extract file types use Update and Snapshot extract modes.

Blackboard CourseInfo 4 creates delimited files that are uploaded through a batch utility in the Blackboard system. Students must have email addresses (preferred, home, or campus) for your PeopleSoft Campus Solutions system to extract and include the student in the people object.

The API Input format creates delimited files that are uploaded in the WebCT system through the use of an API.

Note. The API Input format is currently being phased out. However, the WebCT Campus Edition and Vista formats both support the XML V1.1 LMS extract file type that is required for the PeopleSoft system.

The following table further describes the requirements:

Item	Enterprise XML V1.1	Blackboard CourseInfo 4	API Input
Extract File Creation Methods	Individually. In combination with other files. Combined in a single file.	Individually. In combination with other files.	Individually. In combination with other files. Note. You cannot select global files to run individually. They are run automatically every time the student file is selected. This is necessary because the global API has two formats: FileAdd and FileUpdate.
Object Output Files	People Update: All students and instructors who are members of the classes that meet the runtime criteria. Snapshot: All students and instructors who are members of the classes that meet the runtime criteria.	User Update: All active students in classes that meet the runtime criteria. Snapshot: All active students in classes that meet the runtime criteria.	Student (the files are loaded through an API in which the course ID is specified on the command line; therefore, one file is created per class.) Update: Only active students in classes that meet the runtime criteria who have a STATUS_DT that is greater than or equal to the class enrollment extract datetime new students. Snapshot: All active students in classes that meet the runtime criteria.
	Group Update: Only classes with no extract datetime that meet the runtime criteria and all classes that are designated as combined sections. Snapshot: All classes that meet the runtime criteria.	Course Update: Only classes with no extract datetime that meet the runtime criteria. Snapshot: All classes the meet the runtime criteria.	Class (The PeopleSoft system provides this file as informational because WebCT does not use an API to load classes.) Update: Only classes with no extract datetime that meet the runtime criteria. Snapshot: All classes that meet the runtime criteria.
	Membership Update: All instructors of the classes that meet the runtime criteria. All students that meet the runtime criteria who have a STATUS_DT, ENROL_ADD_DT, GRADING_BASIS_DT, ENROL_DROP_DT, or GRADE_DT that is greater than or equal to the class enrollment extract datetime (for example, newly enrolled students or currently enrolled students with a meaningful change). Snapshot: All students and instructors of classes that meet the runtime criteria.	Populate Course Update: All instructors of the classes that meet the runtime criteria. Only active students in classes that meet the runtime criteria who have a STATUS_DT that is greater than or equal to the class enrollment extract datetime (for example, new students). Snapshot: All instructors and active students of the classes that meet the runtime criteria.	Global Update: FileAdd format: Only active students in classes that meet the runtime criteria who have a STATUS_DT that is greater than or equal to the class enrollment extract datetime for all their classes. FileUpdate format: Students who have already passed through the extract process at least once before, but have at least one new class in the run. Active students are not included if their status date is less than the class enrollment extract datetime for all of their classes (for example, no new course list information is available to pass). Active students who are in more than one class, and who have a STATUS_DT that is greater than or equal to the class enrollment extract datetime for a class (for example, at least one new course is available to add to a student's list). Snapshot FileAdd format only: All active students in classes that meet the runtime criteria.

Note. Students who have dropped the reported class prior to the drop or retain date are not included in any update of the LMS extract. If you run a snapshot, then run an update prior to the drop or retain date. Any students dropped since the snapshot are not updated or deleted from the LMS because their enrollments have been deleted from PeopleSoft Campus Solutions. Plan your production refresh schedule with this in mind.

Setting Up LMS Values and Default Options

Now that you have considered the extract file type that you plan to use, you can set up values and options for PeopleSoft interoperability LMS batch extract and LMS authentication.

To set up LMS values and options:

If you plan to use the XML V1.1 extract file type, you must set up LMS datasource codes and descriptions, LMS target codes and descriptions, and LMS type codes and descriptions.

You must create a data source code and a description for every possible extract source (for example, Undergraduate School of Business Administration, or PeopleSoft University). You must consider how you want to name your extract source information, and whether you typically extract from one small department or school at a time or extract a large group of data for a term at a time.

You must create target codes and descriptions for all of your targets (for example, the PSUNV/LMS shared server, or the School of Law server). Also, you need to create codes and descriptions for all of the different types of extract processes that you may run. These naming conventions are used as part of each XML V1.1 extract and are useful tracking tools.
If you plan to use PeopleSoft LMS self-service user authentication, you must set up LMS authentication profiles.

Currently, WebCT is the only LMS that uses LMS authentication. If you plan to use the LMS single sign on authentication, you must assign the LMS extract file type of XML for the LMS classes on the Schedule of Classes - LMS Data page.

See Configuring Your Learning Management System Third-Party Vendors for PeopleSoft Campus Solutions, which is posted to My Oracle Support.
If you plan to use PeopleSoft LMS self-service user authentication, you must set up LMS providers.

LMS providers are assigned to classes on the Schedule of Classes - LMS Data page and the Schedule New Course - LMS Data page in the Providers for Authentication field. LMS providers can also be assigned as default values on the Academic Institution 3 page and the Course Catalog - Components page.
(Optional) If you want to automatically include all newly scheduled classes in a particular LMS extract file type, you can specify the desired LMS extract file type on the Academic Institution 3 page.

If you are using LMS authentication, you can also assign a default LMS provider for authentication on the Academic Institution 3 page.

Every time that you schedule a new class, the system uses the values on the Academic Institution 3 page as default values on the Schedule of Classes - LMS Data page.
(Optional) If you want to automatically include only some of your newly scheduled classes in the LMS extract file type, you can specify the desired LMS extract file type, and if required, the LMS provider for authentication, on each course's respective Course Catalog - Components pages.

When you schedule classes, the system uses the values that you specify on the Course Catalog - Components page as default values on the Schedule of Classes - LMS Data page instead of using the values from the Academic Institution 3 page.

Note. You can set up default values at the institution level or at the catalog level to populate the schedule of classes. However, the extract uses only the values that are set at the class level.
You can add or modify LMS options on the Schedule of Classes - LMS Data page or on the Schedule New Course - LMS Data page.

The LMS extract file type that is specified on the LMS Data page autogenerates an LMS extract group ID. The batch extract uses these LMS values, as does the self-service authentication process, when linking a student or instructor from a self-service page to the academic content for the class on the LMS website.

For each class that does not require authentication to use an LMS or other website, enter the target URL on the Schedule of Classes - LMS Data page. The URL address must be complete (for example, include "http://").

Note. Do not enter URLs for classes that require authentication. The system autogenerates the required URLs from the Student Center, My Class Schedule, Faculty Center - My Teaching Schedule, and Learning Management Systems self-service pages.

Pages Used to Set Up LMS Values and Default Options

Page Name	Definition Name	Navigation	Usage
LMS Datasource	LMS_DATASOURCE	Curriculum Management, Learning Management Systems, LMS System Setup, LMS Datasource	Set up codes and descriptions for potential XML batch extract sources.
LMS Target	LMS_TARGET	Curriculum Management, Learning Management Systems, LMS System Setup, LMS Target	Set up codes and descriptions for potential XML batch extract targets.
LMS Type	LMS_TYPE	Curriculum Management, Learning Management Systems, LMS System Setup, LMS Type	Set up codes and descriptions for potential XML batch extract types.
Learning Management System Authentication Profile	ESA_PROFILE_PG	Curriculum Management, Learning Management Systems, LMS Authentication Profile, Learning Management System Profile	Set up authentication profiles to communicate with your external LMS websites and to synchronize keys between your PeopleSoft site and the LMS site.
LMS Provider	LMS_INT_SETUP	Curriculum Management, Learning Management Systems, LMS Provider Setup, LMS Provider	Set up codes, descriptions, and LMS authentication profiles to enable authentication for students and instructors to access their LMS home page and LMS academic content pages. Using this page, define all LMS providers to be used with LMS authentication at your institution.
Academic Institution 3	INSTITUTION_TABLE3	Set Up SACR, Foundation Tables, Academic Structure, Academic Institution Table, Academic Institution 3	Define a default provider for authentication and the LMS extract file type to use when scheduling new classes. Define remaining LMS options for the LMS batch extract to use.
Components	CRSE_CATALOG_CMPNT	Curriculum Management, Course Catalog, Course Catalog, Components	Enter default provider for authentication and LMS extract file type values on a course-by-course basis to use when scheduling new classes.
LMS Data	CLASS_LMS_SETUP	Curriculum Management, Schedule of Classes, Schedule New Course, LMS Data Curriculum Management, Schedule of Classes, Maintain Schedule of Classes, LMS Data	Enter or modify LMS values to use when generating the LMS batch extract and when clicking a class's LMS link on the self-service pages.

Setting Up LMS Datasource Values

Access the LMS Datasource page (Curriculum Management, Learning Management Systems, LMS System Setup, LMS Datasource).

LMS datasource codes and descriptions are required on the LMS Batch Extract page as part of your run control parameters if you run the batch extract process with an LMS batch extract file type of XML V1.1. If you run the batch extract process with an LMS extract file type of Blackboard CourseInfo 4 or API Input format, this setup is not required.

LMS Datasource Code and LMS Datasource Description

Enter an LMS datasource code and corresponding LMS datasource description for all valid data sources. The data source is an identifier for the site generating the XML file and is used in the properties object (header record).

For XML file types, the LMS datasource code must be entered at runtime on the LMS Batch Extract - Setup page.

Setting Up LMS Target Values

Access the LMS Target page (Curriculum Management, Learning Management Systems, LMS System Setup, LMS Target).

LMS target code and description information is required on the LMS Batch Extract - Setup page as part of your run control parameters if you run the batch extract process with an LMS type of XML V1.1. If you run the batch extract process with an LMS extract file type of Blackboard CourseInfo 4 or API Input format, this setup is not required.

LMS Target Code and LMS Target Description

Enter an LMS target code and corresponding LMS target description for all valid recipients of the XML files. The target code is an identifier for the site receiving the XML file and is used in the properties object (header record).

For XML file types, the LMS target code is entered at runtime on the LMS Batch Extract - Setup page.

Setting Up LMS Type Values

Access the LMS Type page (Curriculum Management, Learning Management Systems, LMS System Setup, LMS Type).

LMS type and description information is required on the LMS Batch Extract - Setup page as part of your run control parameters if you run the batch extract process with an LMS type of XML V1.1. If you run the batch extract process with an LMS extract file type of Blackboard CourseInfo 4 or API Input format, this setup is not required.

LMS Type Code and LMS Type Description

Enter an LMS type code and a corresponding LMS type description to specify the nature of any extract that you may perform with this type. The type code is used in the properties object (header record).

For XML types, the LMS type code is entered at runtime on the LMS Extract - Setup page.

Setting Up LMS Authentication Profiles

If you plan to use PeopleSoft LMS authentication, you must configure your system to communicate with external LMS sites by creating an LMS authentication profile and synchronizing the keys between your PeopleSoft site and the external LMS site. Keys enable the two sites to recognize the requests that are passed between them and to authenticate your self-service users to the LMS site.

Using LMS authentication, end-users sign on one time to enter the PeopleSoft Campus Self Service.

When using the self-service Learning Management Systems page, users can click an LMS provider link, which will take them to their home page within the LMS system such as WebCT. For classes, you can assign LMS providers for authentication at the Academic Institution and Course Catalog Component level. The system then uses the provider as a default value when adding a class to the schedule of classes. You can also assign or update providers at the class level.

If an LMS provider is assigned to a class, the system displays an LMS button next to the class within the self-service Student Center, My Class Schedule page, and Faculty Center - My Teaching Schedule page. When students or instructors click the button, the system quickly performs the authentication and moves the user to the academic class content on the LMS website. The authentication happens without users explicitly signing on to the other site, without their having any sense of moving out of the PeopleSoft application, and without having to add another user ID or password to their ever-growing list of IDs and passwords.

You can also assign LMS providers without using LMS authentication for use on the Learning Management Systems self-service page. In this case, you assign a target URL, such as an institution or division website that has links to instructor web pages.

You can also use the LMS provider as a run control parameter within the LMS batch extract process.

See Also

Using LMS Authentication

Configuring Your Learning Management System Third-Party Vendors for PeopleSoft Campus Solutions, which is posted to My Oracle Support.

Defining LMS Providers

Access the LMS Provider page (Curriculum Management, Learning Management Systems, LMS Provider Setup, LMS Provider).

Effective Date

Enter the date when the status of this LMS provider becomes effective. Use a new effective date each time that you make a change to a provider. Insert new rows as needed, and modify the record.

Description

Enter the description to display to students and instructors from the self-service Learning Management System page.

LMS Authentication Profile

If the provider uses the LMS authentication feature, select the LMS authentication profile to use for that provider.

Default URL

The system hides and clears the Default URL field when you enter an LMS authentication profile. If you do not enter an LMS authentication profile, the Default URL field is available so that you can specify the default URL to use for a provider who does not use LMS authentication. You might want to use the URL that takes the user to an institution or division website from the Learning Management Systems page. Be sure to enter the complete URL (including http://).

Display as LMS Link

Select this check box to display the LMS provider as a link on the self-service Learning Management System page. The link enables users to access their LMS site homepage by way of PeopleSoft LMS authentication.

Comments

Enter comments to further describe or identify the LMS provider.

Defining LMS Default and Extract Options for Your Institution

Use the LMS Options group box on the Academic Institution Table 3 page to specify the LMS extract file type default values if all your classes need to be available to extract to a learning management system. If you plan to use PeopleSoft LMS authentication, you must also specify the provider for authentication.

The system uses the values that are defined on the Academic Institution Table 3 page as default values when adding a class to the schedule of classes.

The LMS batch extract uses the personal data extract parameters of phone type and address usage. The user ID extract option identifies whether the extract should use the student or instructor's employee ID or user ID. User IDs are created on the User Profile page.

Note. The user ID value is of particular importance for LMS authentication. For the user's authentication to work properly, the selected user ID extract option must be the same as the LMS authentication profile - authentication user ID value. If you set the user ID extract option to user ID on the Academic Institution Table 3 page, then authentication user ID must also be set to user ID on the LMS Authentication Profile page.

Configuring Your Learning Management System Third-Party Vendors for PeopleSoft Campus Solutions, which is posted to My Oracle Support.

Defining LMS Default Options for Course Components

Use the Course Catalog - Components page to enter LMS values on a course-by-course basis if you have not specified a default LMS extract file type and a default provider for authentication (if you plan to use PeopleSoft LMS authentication) on the Academic Institution 3 page. When you enter LMS values on the Course Catalog - Components page, the system overrides the values that are set on the Academic Institution 3 page and uses the Course Catalog - Components page values as defaults.

See Also

Defining Course Components

Defining LMS Options for Classes

If you have not specified, on either the Academic Institution 3 page or the Course Catalog - Components page, a default LMS extract file type and a default provider for authentication (if you plan to use PeopleSoft LMS authentication), you must enter your LMS values on the Schedule of Classes - LMS Data page.

All LMS classes must have an LMS extract file type and an LMS extract group ID defined on the Schedule of Classes - LMS data page. You can also modify the LMS that comes in from the Academic Institution 3 page or the Course Catalog - Components page.

Note. You must assign an extract file type to use. To use PeopleSoft LMS authentication, you must use the XML LMS extract file type and you must identify a provider for authentication.

The LMS authentication is designed to work with the IMS enterprise system specifications that are used to create the batch XML V1.1 extract file. When the XML V1.1 LMS extract file type is designated within the Schedule of Classes, the system autogenerates the LMS extract group ID. During the extract process and LMS authentication from self-service pages, the system creates a unique class identifier by supplementing the LMS group ID with a term code and the class number.

If you do not want to use LMS authentication, but want to link students who are enrolled in a class to a designated URL such as an instructor's website, you can specify the website in the LMS URL field. The website URL must be preceded by the http:// designation.

Note. Do not specify URLs for classes that require authentication to the LMS site. When using PeopleSoft LMS authentication, the system autogenerates the required URLs from the Student Center, My Class Schedule, and Faculty Center - My Teaching Schedule self-service pages.

See Also

Defining LMS Options for Classes

Running the LMS Batch Extract Process

Use the PeopleSoft LMS Batch Extract process to create extract files of object properties data in the appropriate format for your target LMS. If you use PeopleSoft LMS authentication, you must use the XML LMS extract file type and select the appropriate provider for authentication.

You can specify all of your runtime parameters on the LMS Batch Extract - Setup and LMS Extract - Criteria pages, and designate the appropriate file path for your extract files on the LMS Batch Extract - Output page. After the process finishes, you can locate your extract files in the file directory that you specify. You can run the extract process in either snapshot or update mode.

Prerequisites

Before you can perform an extract for XML V1.1, you must create LMS datasource, LMS target, and LMS type values in the LMS Setup component.

Pages Used to Extract LMS Data

Page Name	Definition Name	Navigation	Usage
LMS Batch Extract Process - Setup	RUNCTL_SRLMSEX1	Curriculum Management, Learning Management Systems, LMS Batch Extract Process, Setup	Specify properties and parameters for the extract process and header properties object.
LMS Batch Extract Process - Criteria	RUNCTL_SRLMSEX2	Curriculum Management, Learning Management Systems, LMS Batch Extract Process, Criteria	Further narrow your specifications for the extract process.
LMS Batch Extract Process - Output	RUNCTL_SRLMSEX3	Curriculum Management, Learning Management Systems, LMS Batch Extract Process, Output	Specify the extract file path and storage conventions for the extract process.

Defining LMS Run Control Parameters

Access the LMS Batch Extract Process - Setup page (Curriculum Management, Learning Management Systems, LMS Batch Extract Process, Setup).

Institution

Enter the institution that specifies the source of the extract data.

Term

Enter the term that specifies the source of the extract data.

Provider for Authentication

Specify the authentication provider to use within the extract. Single signon providers are defined on the LMS Provider Setup page and are assigned to classes on the Schedule of Classes - LMS Data page.

LMS Extract File Type

Specify the file type, or extract format, to use within the extract. Values are: XML V1.1 (required for PeopleSoft LMS authentication), Blackboard CourseInfo 4, and API Input (the WebCT format that is currently being phased out; however, WebCT Campus Edition and Vista both support XML V1.1).

Values for this field are delivered with your system as translate values. Do not modify these values in any way. Any modifications to these values require a substantial programming effort.

The LMS extract file type that you specify here must be the same as the LMS extract file type that is assigned to the LMS classes on the Schedule of Classes - LMS Data page.

Note. If you select a file type of Blackboard CourseInfo4 or API Input, the Datasource, Target and Type fields will be unavailable.

Datasource and Target

Enter the datasource and target that will serve as identifiers for the site generating the XML file. For example, you might have a datasource of College of Liberal Arts and a target of Liberal Arts LMS Server.

Type

Enter the extract type that describes the classes that you want to extract. For example, keeping with the datasource and target examples, you might enter Liberal Arts Classes.

Extract Mode

Specify an extract mode. Values for this field are delivered with your system as translate values. Do not modify these values in any way. Any modifications to these values require a substantial programming effort. The current set of values include:

Snapshot: Full set of data for purposes of initial group creation or reloads.

Update: Partial set of changes that applies to enrollment, group, and group membership.

The effectiveness of the LMS extract mode of Update on the run control page depends on the LMS extract file type on the Schedule of Classes - LMS Data page. This is because Blackboard CourseInfo 4.0 standard edition and API Input (the WebCT format that is currently being phased out) both have limiting specifications on what data they can currently accept in update form. When you run Blackboard CourseInfo 4 in Update mode, only new user and new course data since the last time the process ran is accepted. When you run API Input in Update mode, only new user and new course data, since the last time the process ran, and new enrollment and new course list information, is accepted.

In addition, students who dropped prior to the drop or retain date are not included in any update of the LMS extract. In other words, if you run a snapshot, then run an update prior to the drop or retain date, any students dropped since the snapshot are not updated or deleted from the LMS because their enrollments have been deleted from the PeopleSoft system. Plan your refresh schedule with this in mind.

Language

Enter a two-character language value that will serve as an attribute of the properties object, for example, <PROPERTIES lang="en">,ISO 639 format. This field is optional.

After you enter all necessary data on the LMS Batch Extract - Setup, LMS Batch Extract - Criteria, and LMS Batch Extract - Output pages, click Run to run this request. PeopleSoft Process Scheduler runs the LMS Batch Extract process at user-defined intervals.

Defining LMS Run Control Criteria

Access the LMS Batch Extract Process - Criteria page (Curriculum Management, Learning Management Systems, LMS Batch Extract Process, Criteria).

The fields on this page prompt against the institution and term that you specify on the LMS Batch Extract - Setup page. If you do not enter any narrowing parameter information on the LMS Batch Extract Process - Criteria page, the process runs for the institution and term that are specified on the LMS Batch Extract Process - Setup page.

Selection Criteria

Select an option to indicate the level of filtering to apply in addition to the parameters on the LMS Batch Extract Process - Setup page.

None	Select to disable all fields.
Filter	Select to enable the field filters.
Class Number	Select to disable the field filters and enable the Class Nbr (class number) field.

Additional Elements

Career	Enter a career if you want to isolate only those courses that are offered under a particular academic career.
Session	Enter a session to isolate classes within the term that are specified on the LMS Batch Extract Process - Setup page and within a particular session.
Campus	Enter a campus to filter those classes that are offered by a particular campus.
Academic Group	Enter an academic group to filter classes that are associated with a particular group.
Subject Area	Enter a subject area to filter those classes with a particular subject.
Catalog Nbr (catalog number)	Enter a catalog number to isolate a particular course.
Class Nbr (class number)	Enter a class number to specify a particular class offering. This field is available when the Class Number option is selected.

After you enter all necessary data on the LMS Batch Extract Process - Setup, LMS Batch Extract Process - Criteria, and LMS Batch Extract Process - Output pages, click Run to run this request. PeopleSoft Process Scheduler runs the LMS Batch Extract process at user-defined intervals.

Note. The system treats cleared fields as wild cards and returns all values.

Defining LMS Output Parameters

Access the LMS Batch Extract Process - Output page (Curriculum Management, Learning Management Systems, LMS Batch Extract Process, Output).

Note. The LMS Batch Extract Process - Output page appears differently depending on the file type (XML, Blackboard, or API) that you select.

File Path	Enter a file path to indicate the extract file location. This is where your extracted people, classes, and enrollment files are located. In addition to sending report output for this process to a file (through setting preferences in the PeopleSoft Process Monitor), you can also send any additional output files that are created by this process to a file directory. To send the extract output to a file directory, enter a valid directory path that maps to a folder with appropriate read/write permission. If you cannot locate such a folder, consult your system administrator.
Combine Output	This check box is available if you select a file type of XML V1.1 on the LMS Batch Extract Process - Setup page. Select this check box to combine person, group, and membership objects into one file. When this check box is cleared, you can further specify the level and location of objects to extract. In doing so, you must also create individual file names for each object. Note. You must always include the file type (such as XML) in the output name.
People	Select this check box to include person object data in the extract for all students and instructors who are associated with the selected LMS classes. Enter a corresponding file name for this data. This check box is unavailable if you select a file type of API Input (the WebCT format that is currently being phased out) on the LMS Batch Extract Process - Setup page.
Group	Select this check box to include group object data in the extract for all selected LMS classes. Enter a corresponding file name for this data.
Membership	Select this check box to include membership object data in the extract, which identifies each LMS class and the students and instructors who are associated with the class. Enter a corresponding file name for this data.

Collects and stores the appropriate data in an extract file (or files) with the name and file path that you specify.
Creates an SQR .log file that provides detail about the process itself.
Creates a detailed LMS Batch Extract report (SRLMSEX.<file extension>) that highlights the parameters, messages, and total record count for the process.

PeopleSoft Process Scheduler runs the LMS Batch Extract Report process at user-defined intervals.

Click the Process Monitor link to access the Process Detail page, where you can view the status of submitted process requests. From the Process Detail page, click the View Log/Trace link to access the SQR .log and LMS Batch Extract report (SRLMSEX.<file extension>).

Using Self-Service Pages and LMS Authentication

If your institution has licensed PeopleSoft Campus Self Service, students and instructors can access LMS websites from your system.

See Also

Using LMS Authentication

Effective Date	Enter the date when the status of this LMS provider becomes effective. Use a new effective date each time that you make a change to a provider. Insert new rows as needed, and modify the record.
Description	Enter the description to display to students and instructors from the self-service Learning Management System page.
LMS Authentication Profile	If the provider uses the LMS authentication feature, select the LMS authentication profile to use for that provider.
Default URL	The system hides and clears the Default URL field when you enter an LMS authentication profile. If you do not enter an LMS authentication profile, the Default URL field is available so that you can specify the default URL to use for a provider who does not use LMS authentication. You might want to use the URL that takes the user to an institution or division website from the Learning Management Systems page. Be sure to enter the complete URL (including http://).
Display as LMS Link	Select this check box to display the LMS provider as a link on the self-service Learning Management System page. The link enables users to access their LMS site homepage by way of PeopleSoft LMS authentication.
Comments	Enter comments to further describe or identify the LMS provider.

Institution	Enter the institution that specifies the source of the extract data.
Term	Enter the term that specifies the source of the extract data.
Provider for Authentication	Specify the authentication provider to use within the extract. Single signon providers are defined on the LMS Provider Setup page and are assigned to classes on the Schedule of Classes - LMS Data page.
LMS Extract File Type	Specify the file type, or extract format, to use within the extract. Values are: XML V1.1 (required for PeopleSoft LMS authentication), Blackboard CourseInfo 4, and API Input (the WebCT format that is currently being phased out; however, WebCT Campus Edition and Vista both support XML V1.1). Values for this field are delivered with your system as translate values. Do not modify these values in any way. Any modifications to these values require a substantial programming effort. The LMS extract file type that you specify here must be the same as the LMS extract file type that is assigned to the LMS classes on the Schedule of Classes - LMS Data page. Note. If you select a file type of Blackboard CourseInfo4 or API Input, the Datasource, Target and Type fields will be unavailable.
Datasource and Target	Enter the datasource and target that will serve as identifiers for the site generating the XML file. For example, you might have a datasource of College of Liberal Arts and a target of Liberal Arts LMS Server.
Type	Enter the extract type that describes the classes that you want to extract. For example, keeping with the datasource and target examples, you might enter Liberal Arts Classes.
Extract Mode	Specify an extract mode. Values for this field are delivered with your system as translate values. Do not modify these values in any way. Any modifications to these values require a substantial programming effort. The current set of values include: Snapshot: Full set of data for purposes of initial group creation or reloads. Update: Partial set of changes that applies to enrollment, group, and group membership. The effectiveness of the LMS extract mode of Update on the run control page depends on the LMS extract file type on the Schedule of Classes - LMS Data page. This is because Blackboard CourseInfo 4.0 standard edition and API Input (the WebCT format that is currently being phased out) both have limiting specifications on what data they can currently accept in update form. When you run Blackboard CourseInfo 4 in Update mode, only new user and new course data since the last time the process ran is accepted. When you run API Input in Update mode, only new user and new course data, since the last time the process ran, and new enrollment and new course list information, is accepted. In addition, students who dropped prior to the drop or retain date are not included in any update of the LMS extract. In other words, if you run a snapshot, then run an update prior to the drop or retain date, any students dropped since the snapshot are not updated or deleted from the LMS because their enrollments have been deleted from the PeopleSoft system. Plan your refresh schedule with this in mind.