PeopleSoft Student Administration Integration Pack PeopleBook

Managing Multitarget Integration

This chapter provides an overview of multitarget integration and discusses how to:

Add a target.
Set up person mapping.
Set default targets at the academic institution level.
Set default targets at the academic organization level.
Set targets at the section level.
Synchronize SAIP extension tables.

Understanding Multitarget Integration

Multitarget integration functionality is intended to support campuses that need to provision course roster information into more than one system. For example, they may have a secondary LMS that is used by one or more departments, or an individual faculty member may wish to provision her class into a Web 2.0 tool in addition to the LMS. While previous versions of the SAIP allowed more than one target to receive data, all targets would receive the same data on the same schedule. It was designed to support only one target. Multitarget integration provides a number of enhancements over the previous design:

It is now possible to use both the web service and LDAP bindings simultaneously.
Different course sections may be assigned to different targets.
Each target can have its own settings, for example, frequency and method of update (batch or event-driven), defined end points, etc.
Cascading preferences for targets may be set at the academic institution and academic organization levels.
Sections can be published to more than one target.
Grade return and event-driven updates are now supported on a per-target basis for the web service binding.
If a section is published to more than one target that supports grade return, then a preferred grade return target can be chosen.

Note. While SAIP does support publishing the same section to more than one target, it is advisable for performance reasons to limit the number of targets per section to two or three as a general rule. If sections are going to be provisioned to 4 or more targets on a routine basis, it may be advisable to consider using SAIP to provision into an Identity Management System.

Targeting

In earlier versions of SAIP, the process of selecting course sections for inclusion in the integration is called "scoping." Scoping is still present in SAIP, but there is also a second process called "targeting". Targeting is when one or more external systems (for example, an LMS, Facebook, a portal) are designated as the integration end points. The process within SAIP works as follows:

First sections are "set in scope," meaning that they are designated as ready to be sent to some external systems via SAIP.
Once they are set in scope, sections are then "targeted," meaning that they are assigned to specific external systems for integration.

Note. Course section records will not be sent until a course section has both been set in scope and targeted.

Targets may optionally support grade return. If a section has more than one target that supports grade return, then SAIP provides a functional interface to choose the preferred source of grade import data.

Target Versioning and Legacy Targets

The earliest version of SAIP web services only supported integration with a single target. The introduction of support for multiple targets necessitated some architectural changes and the way in which the SAIP interacted with targets; similarly, the introduction of new capabilities such as producer initiated snapshots and grade push integration also change the way in which you might need to think about the SAIP.

In defining targets, you will now see three versions of the web services: 1.0, 1.5, and 2.0. In targets designed to work with the 1.0 service versions, no target identifier is included as part of the request/response interchange. If the target does not provide this request parameter, and if SAIP has a web service target set up to use the 1.0 version of the binding, then the system will assume that the requesting target is the one that has been identified as using the 1.0 binding. This is why SAIP can only support one target using the 1.0 web service binding. SAIP web services version 1.5 was modified to support multitarget integration, though it only supported a consumer-requested snapshot model. Because of this, target systems must provide target ID as a request parameter, to provide SAIP with a way to know which data set to prepare for the target.

SAIP services version 2.0 support a producer-initiated snapshot model, which obviates the need for the target system to define and send a target ID as a request parameter. Instead, the targeting is specified using a set of IMS LIS attributes modeled after the WS-Addressing elements.

To assist you in properly integrating with targets supporting different levels of capability, SAIP includes a per-target binding version.

Note. In version 1.5 and 2.0, SAIP does not distinguish between Create or Update messages. In version 1.5, any message other than a Delete is sent as a Create; in version 2.0 any message other than a Delete is sent as a Replace, in compliance with the final IMS LIS specification.

Cascading Defaults

As with scoping, the targeting mechanism in SAIP has cascading defaults. For example, LMS A can be added as a default target to the PeopleSoft University academic institution and have it cascade down to the biology academic organization and the Biology 101 Fall 2010 class section. However, there are some important differences in the details of how the cascading defaults work:

Because multitarget allows one section (or academic organization) to have more than one target, it is possible to add targets at the academic organization or class section level in addition to the defaults provided at the academic institution level.
Combined sections inherit targets from all of their constituent sections.

If a target has been set for one of the combined sections, then it will apply to all of them.
For performance reasons, defaults set at the academic institution or academic organization level cannot be deleted at the section level.

Instead, they are inactivated.

Adding a Target

This section discusses how to add SAIP targets.

Page Used to Add Targets

Page Name	Definition Name	Navigation	Usage
SAIP Target Setup	SAE_TARGET_GENERAL	Set Up SACR, Product Related, SA Integration Pack, Set Up Targets, Web Service Targets	Set up web service targets.

Adding a Target

Access the SAIP Target Setup page (Set Up SACR, Product Related, SA Integration Pack, Set Up Targets, Web Service Targets).

SAIP will autogenerate the routings in Integration Broker for each target.

Target ID	Set the target ID.
Description	Set the target description.
Directory Path	If you want SAIP to place the snapshot XML file in file, you must specify that path here. If no directory path is specified, the XML file is placed in the application server's TEMP folder.
Grade Import Source	Select to define the target as the source for the import of final grades into the grade roster. When this check box is selected, the Grade Import group box and the Import Grades button appear on the Grade Roster page (GRADE_ROSTER_TYPE) in the Student Records Grade Roster component (GRADE_ROSTER) and on the grade roster page in faculty self-service (SS_GRADE_ROSTER), provided that grade import has also been enabled on the SAIP Installation page (SAE_SETUP). You must click the Import Grades button on the Grade Roster page to run the import. When the check box is not selected, grade import is not available. You can select or clear this check box at any time after initialization without consequence.
Enable Event Triggers	Select to enable all of the event-based triggers that are delivered preset within the SAIP system.

Note. The Target ID must be globally unique across both LDAP and web service bindings.

File Upload Settings: Upload to FTP

When you select the Upload to FTP option, the FTP Settings group box becomes available:

Embed Credentials

Select to embed FTP credentials in the response URL.

When an external system requests either a full or incremental snapshot, the SAIP generates the snapshot, places the snapshot in the specified destination, and returns a response to the requesting system that includes a URL to the snapshot's location. If that location is an FTP server, you may determine the authorization mechanism for access to the snapshot.

When selected, the user name and password defined for the FTP URL are included in the response URL, enabling the requesting system to directly access the snapshot using just the URL.

If not selected, you must configure your environment to otherwise allow the requesting system to log in to the FTP server to access the snapshot.

FTP URL, User Name, and Password

If you want SAIP to place the snapshot on an FTP server, you must identify the server and settings here.

If you select Upload to FTP, and a directory path is provided, the process looks for the XML file in the specified directory path, and uploads it from there.

If you select Upload to FTP, but do not provide the directory path, the process looks for the XML file in the application server's TEMP folder, and uploads it from there.

File Upload Settings: Upload to URL

With PeopleTools 8.51.07 and later, SAIP can use protocols such as FTPS, SFTP, HTTP and HTTPS to upload snapshot files.

The HTTP and HTTPS protocols allow you to use a web server for file transfer (for example, using a Java file upload servlet). The secure protocols such as FTPS provide a method for file transfer that is compliant with many university security policies. In the case where the target system is hosted by a third party, these secure file transfer protocols are typically required.

When you select the Upload to URL option, the URL Settings group box becomes available:

URL Identifier	Enter or search for the URL Identifier for your SAIP file uploads. This URL is configured through PeopleTools URL Administration. (See PeopleTools documentation for adding a new URL.) If you are using a secure protocol such as HTTPS or SFTP, ensure the appropriate digital certificates have been imported (See PeopleTools documentation for Digital Certificates).
View URLID and Add URLID	After you enter your URL identifier, you can click the View URLID link to see the properties and make modifications. You can also click the Add URLID link which takes you directly to URL Maintenance where you can add a new URL Identifier.

For further information about configuring URLs and secure URLs:

See PeopleTools: System and Server Administration, Using PeopleTools Utilities, Using Administration Utilities, URL Maintenance

Integration Metadata Settings

These settings provide information for the Integration Broker routings.

Node Name

Select the Integration Broker node to be used for this target. Because each node represents an end point, you will need one node per target. SAIP can share a node with other integration processes for the same target, however. At a minimum, SAIP needs to have the Description and Valid Default User ID fields populated, and the Node Type set to PIA.

Enter the target's endpoint URL for each of the services required by SAIP.

The required services differ between Version 1.5 and Version 2.0.

Version 1.5 target setup required services are:

BULKDATAEXCHANGEMGMTSERVICE
COURSEMGMTSERVICE
GROUPMANAGEMENTSERVICE
MEMBERSHIPMANAGEMENTSERVICE
PERSONMANAGEMENTSERVCE
OUTCOMESERVICE

Version 2.0 target setup required services are:

BULKDATAEXCHANGEMGMTSERVICE
GROUPMANAGEMENTSERVICE
MEMBERSHIPMANAGEMENTSERVICE
PERSONMANAGEMENTSERVCE
OUTCOMESERVICE
COURSETEMPLATESERVICE
COURSEOFFERINGSERVICE
COURSESECTIONSERVICE
SECTIONASSOCIATIONSERVICE

Once the URLs have been entered, press Generate Routings to finish the target setup.

Setting Up Person Mapping

This section provides an overview of person mapping and discusses how to:

Define pre-version 2 mapping.
Define version 2 mapping.

Understanding Person Mapping

Person Mapping allows you to define how core Person names and contact information in Campus Solutions is mapped to the outgoing Person payload data model and thus how that information is provided to the external system. Two distinct Person Mappings exist, depending on the services version of the target that has been chosen. These are designated as the pre-v2 Person Mapping and v2 Person Mappings.

Pre-v2 Person Mapping provides for a single value to be mapped and passed for each Person information element. For example, to map a value to the IMS Address element, one Campus Solutions address can be selected to be sent to the target system. In order to provide the greatest flexibility and to account for variability of available data based on data types in Campus Solutions, pre-v2 Person Mapping makes use of delivered Campus Solutions Usages functionality, which allows you to define a hierarchical set of types which the system will loop through until it finds a value. All targets that are defined as version 1.0 or version 1.5 will make use of the mappings provided under pre-v2 Person Mapping, there is no distinction by target.

V2 Person Mapping allows for an increased flexibility both around attribute level mapping as well as mapping by target. Rather than defining a single value to be mapped, institutions can create a correspondence between defined IMS LIS specification types and data types within their Campus Solutions implementation. This means that more than one value for each attribute can be sent to the target system, such as multiple addresses, emails, etc. It also means that the mapping for one target can be different than the mapping for another target, if you have multiple targets in your ecosystem. Only targets defined as 2.0 will be available in the v2 Person Mapping component.

Pages Used to Set Up Person Mapping

Page Name	Definition Name	Navigation	Usage
Pre-v2 Person Mapping	SAE_V1_PRSN_MAP	Set Up SACR, Product Related, SA Integration Pack, Set Up Targets, Pre-v2 Person Mapping	Define person mapping for pre-version 2 targets.
Person Mapping	SAE_PERSON_MAPPING	Set Up SACR, Product Related, SA Integration Pack, Set Up Targets, v2 Person Mapping	Define person mapping for version 2 targets.

Defining Pre-Version 2 Mapping

Access the Pre-v2 Person Mapping page (Set Up SACR, Product Related, SA Integration Pack, Set Up Targets, Pre-v2 Person Mapping).

Enter the name, contact, and email usages to use. The name, phone, email and address usages available for selection are the usages defined in your PeopleSoft Campus Solutions system.

See Designing Campus Community.

Note. All targets not defined as v2 targets during the SAIP Target Setup process will use the mapping defined here.

Name Usage

IMS Form Name	Enter the usage to use to identify an individual's formatted name at the top of the IMS form
IMS Name	Enter the usage to use for an individual's name as it should appear elsewhere on the IMS form.

Contact Info Usage

IMS Address	Enter the usage to use for an individual's address information.
IMS Phone	Enter the usage to use for an individual's telephone information.
IMS SMS	Enter the usage to use for an individual's text messaging address.
IMS Web	Enter the usage to use for an individual's URL address.

Email Usage

Preferred Email or Address Usage

Select either the Preferred Email option for SAIP to always use the preferred email address for individuals, or select the Address Usage option and specify the email type to use.

Defining Version 2 Mapping

Access the Person Mapping page (Set Up SACR, Product Related, SA Integration Pack, Set Up Targets, v2 Person Mapping).

Note. Only targets defined as v2 during the SAIP Target Setup process will be available in the search results for the component search page.

Name Type Mapping

LIS Name Type	Enter the IMS LIS Name Type that you want to populate with a corresponding Campus Solutions name value.
Name Type	Enter the Campus Solutions name type value that you would like to map to the corresponding LIS Name Type's attribute value.

Note. The LIS Name Type Full is delivered as mapped to the Campus Solutions Primary type and is not available for editing. Changing this delivered mapping could create unexpected errors in your SAIP integration.

Formatted Name Type Mapping

LIS Name Type	Enter the IMS LIS Name Type that you want to populate with a corresponding Campus Solutions name value.
Name Type	Enter the Campus Solutions name type value that you want to map to the corresponding LIS Name Type's attribute value.

Note. The LIS Name Type Full is delivered as mapped to the Campus Solutions Full type and is not available for editing. Changing this delivered mapping could create unexpected errors in your SAIP integration.

Address Type Mapping

LIS Address Type	Enter the IMS LIS Address Type that you would like to populate with a corresponding Campus Solutions address value.
Address Type	Enter the Campus Solutions address type value that you want to map to the corresponding LIS Address Type's attribute value.

Contact Info Type Mapping

Phone

LIS Contact Info Type	Enter the IMS LIS Contact Info Type that you want to populate with a corresponding Campus Solutions Phone value.
Phone Type	Enter the Campus Solutions Phone type value that you want to map to the corresponding Phone LIS Contact Info Type's attribute value.

Note. The Phone LIS Contact Info Type "Telephone" is delivered as mapped to the Campus Solutions Preferred Phone type and is not available for editing. Changing this delivered mapping could create unexpected errors in your SAIP integration.

LIS Contact Info Type	Enter the IMS LIS Contact Info Type that you want to populate with a corresponding Campus Solutions Email value.
Email Type	Enter the Campus Solutions Email type value that you want to map to the corresponding Email LIS Contact Info Type's attribute value.

Note. The Email LIS Telephone Type "EmailPrimary" is delivered as mapped to the Campus Solutions Preferred Email type and is not available for editing. Changing this delivered mapping could create unexpected errors in your SAIP integration.

Web Address

LIS Contact Info Type	Enter the IMS LIS Contact Info Type that you want to populate with a corresponding Campus Solutions Email value that your implementation is using to designate a Web address.
Email Type	Enter the Campus Solutions Email type that your implementation is using to designate a Web address, and the value that you want to map to the corresponding WebAddress LIS Contact Info Type's attribute value.

Setting Default Targets at the Academic Institution Level

This section discusses how to define targets at the academic institution level.

Pages Used to Set Default Targets at the Academic Institution Level

Page Name	Definition Name	Navigation	Usage
SAIP Targeting - Academic Institution Level	SAE_INST_TARGET	Set Up SACR, Product Related, SA Integration Pack, Default Targets, Academic Institutions	Set default targets at the academic institution level. These targets may be effective dated.
Institution SAIP Target - History	SAE_INST_TRGT_HIST	Click the Edit/View SAIP Target Details link on the SAIP Targeting – Academic Institution Level page.	View institution target history.

Setting Default Targets at the Academic Institution Level

Access the SAIP Targeting – Academic Institution Level page (Set Up SACR, Product Related, SA Integration Pack, Default Targets, Academic Institutions).

Note. SAIP does not allow sections to participate in more than one association simultaneously. If a section being added to an associated group of class sections or combined sections already participates in an Ad Hoc association, then an error message will be displayed and the component will not save.

The action of associating combined sections at the Academic Institution target level generates an error log and a time stamp on the Class Associations tab.

Targets may be added from the list of targets that have been enabled on the SAIP Target Setup Page (SAE_TARGET_GENERAL) and the LDAP Targets page (SAE_LDAP_TARGETS).

Reset Academic Org. Setup	Remove any targets at the Academic Organization level that have not cascaded down from the Academic Institution level.
Edit/View SAIP Target Details	Add an effective date for activating or deactivating a target default. While a target is inactivated, integration information will no longer be sent to the target.
Associate Class Sections	Individual targets will only pick up section associations that are created after the target has been set. Click this button to ensure that preexisting IMS Associations are sent to the target. (In large databases, this process can take some time.)
Last Associated Time	Displays the date and time that combined sections were associated.
Error Log	Click this link to access the Section Association Error Log page showing association conflict errors.

Setting Default Targets at the Academic Organization Level

This section discusses how to define targets at the academic organization level.

Pages Used to Set Default Targets at the Academic Organization Level

Page Name	Definition Name	Navigation	Usage
SAIP Targeting - Academic Organization Level	SAE_ACAD_TARGET	Set Up SACR, Product Related, SA Integration Pack, Default Targets, SAIP Targeting – Academic Organizations	Set default targets at the academic institution level. These targets may be effective dated.
Acad Org SAIP Target - History	SAE_ACAD_TRGT_HIST	Click the Edit/View SAIP Target Details link on the SAIP Targeting – Academic Organization Level page.	View academic organization target history.

Setting Default Targets at the Academic Organization Level

Access the SAIP Targeting – Academic Organization Level page (Set Up SACR, Product Related, SA Integration Pack, Default Targets, Academic Organizations).

Targets may be added from the list of targets that have been enabled on the SAIP Target Setup Page (SAE_TARGET_GENERAL) and the LDAP Targets page (SAE_LDAP_TARGETS). Targets that have already been added to the parent Academic Institution will appear automatically. They may be removed at the Academic Organization level.

Edit/View SAIP Target Details	Add an effective date for activating or deactivating a target default. While a target is inactivated, integration information will no longer be sent to the target.
Associate Class Sections	Individual targets will only pick up section associations that are created after the target has been set. Click this button to ensure that preexisting IMS Associations are sent to the target. (In large databases, this process can take some time.)
Grade Source ID	Add a source for final grade imports from the list of default and additional targets for the section that been enabled for grade import on the SAIP Target Setup Page (SAE_TARGET_GENERAL).

Setting Targets at the Section Level

This section discusses how to set class targets.

Page Used to Set Targets at the Section Level

Page Name	Definition Name	Navigation	Usage
Class Section Targeting	SAE_CLS_TARGET	Curriculum Management, Schedule of Classes, SA Integration Pack, Class Targets	Add or edit targets for a class.

Setting Targets at the Section Level

Access the Class Section Targeting page (Curriculum Management, Schedule of Classes, SA Integration Pack, Class Targets).

Default Targets

Set targets defaulted from the academic institution or academic organization level to active or inactive. For performance reasons, targets set at the Academic Institution or Academic Organization level may not be deleted at the Class Section level. However, setting those targets to Inactive will prevent data from being sent to them.

Additional Targets

Add section-specific targets from a list of available targets.

Grade Source ID

Add a source for final grade imports from the list of default and additional targets for the section that been enabled for grade import on the SAIP Target Setup Page (SAE_TARGET_GENERAL).

Synchronizing SAIP Extension Tables

SAIP maintains extension tables to keep track of events that must be shared with one or more targets. However, these extension tables can occasionally lose synchronization with the parent tables. The most common cause is customizations to Student Administration that creates events that are not trapped by SAIP. For this reason, SAIP now includes a utility for re-synchronizing the extension tables.

To use this utility, go to the System Process Requests component (PeopleTools, System Schedule, System Process Requests) and run the SAE_EXT_SYNC Application Engine process.

Default Targets	Set targets defaulted from the academic institution or academic organization level to active or inactive. For performance reasons, targets set at the Academic Institution or Academic Organization level may not be deleted at the Class Section level. However, setting those targets to Inactive will prevent data from being sent to them.
Additional Targets	Add section-specific targets from a list of available targets.
Grade Source ID	Add a source for final grade imports from the list of default and additional targets for the section that been enabled for grade import on the SAIP Target Setup Page (SAE_TARGET_GENERAL).