PeopleSoft Student Administration Integration Pack PeopleBook

Setting Up SAIP

This chapter provides an overview of SAIP setup and discusses how to:

Set default installation settings.
Set default SAIP scoping and association values.
Set the integration offsets.
Set up Integration Broker for SAIP.
Set up enrollment batch processing.

Understanding SAIP Setup

Before you install SAIP, you must consider and determine the default settings for your institution to use. These decisions include how to map name and contact information, whether to implement event-based triggers, whether to enable grade import, and whether to point the external system to information in a file path or on a file server.

You must also determine which academic organizations whose academic elements (courses, sections, combined sections, and so on) your institution wants to include within the scope of the initial transfer and subsequent snapshot updates. For course elements, you can override scoping decisions at the element levels, but the institutions, academic organizations, and terms to which they belong must be in scope for the element to be available. For example, if the Biology organization is not included in scope, then none of the Biology courses, sections, or persons data are available for transfer. If, however, the Biology organization is included in scope, and the Spring 2008 term is in scope, then all of the Biology courses, sections, and persons data for the Spring 2008 term are available for inclusion in scope, and can be set as in scope at the organization level. You can override scope inclusion or exclusion at the element level on the pages where you create or view the specific element.

Warning! Changes to the installation settings after initialization affect only data from the date of the change forward. This may introduce different data and formatting, causing the systems to become out of synchronization. You can change the settings and initialize the system at any time to resynchronize the systems, but doing so will overwrite all manual changes including the changes made to include or exclude elements at the specific course, section, and person level. Unless otherwise noted, Oracle recommends that you do not change the default settings after initialization.

You must set service operations, routings, and routing URLs in your PeopleTools Integration Broker specifically for SAIP.

You must also set Integration Broker and PeopleSoft Process Scheduler to use COBOL-based processes for SAIP.

Setting Default Installation Values

To define default installation settings, use the SAIP Installation component (SAE_SETUP).

This section discusses how to set default installation settings.

Page Used to Set Default Installation Values

Page Name	Definition Name	Navigation	Usage
SAIP Installation	SAE_SETUP	Set Up SACR, Install, SAIP Installation	Enable or disable event triggers and grade import, and identify the default usages file to use for integration initialization, and updates.

Setting Default Installation Values

Access the SAIP Installation page (Set Up SACR, Install, SAIP Installation).

Enter or select the items to use as default settings for your institution's initial and subsequent transfers of data to the external system.

Enable Grade Import

Select to provide the ability to import final grades from the external system into Campus Solutions Student Records 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).

You must click the Import Grades button on the Grade Roster page to run the import.

You can select or clear this check box at any time after initialization without consequence.

IMS Source

Specify the source of the IMS attributes to use. The integration process uses this value as the high-level key to identify the source that is sending data to the external system, and to identify which source the external system must query for updates.

The default value is CS (Campus Solutions). This value can be changed to any value meaningful to your institution, but should not be changed once integration with the external systems is initialized.

Setting Default SAIP Scoping and Association Values

To set default SAIP scoping and association values, use the SAIP Scoping and Association component (SAE_SCOPE_SETUP).

This section discusses how to:

Set default SAIP scoping and association settings.
View section association errors.

Pages Used to Set Default SAIP Scoping and Association Values

Page Name	Definition Name	Navigation	Usage
SAIP Scoping and Association	SAE_SCOPE_SETUP	Set Up SACR, Product Related, SA Integration Pack, Scoping/Association Defaults	Identify default settings for including academic organizations and their elements during system initialization and for all subsequent snapshot and event-based data transfers.
Section Association Error Log	SAE_ERR_LOG	Set Up SACR, Product Related, SA Integration Pack, Scoping/Association Defaults, Section Association Error Log	View association conflict errors.

Setting Default SAIP Scoping and Association Values

Access the SAIP Scoping and Association page (Set Up SACR, Product Related, SA Integration Pack, Scoping/Association Defaults).

Use this page to identify items that you want to automatically include within the scope of your institution's initial and subsequent integration processes.

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 level generates an error log and a time stamp.

Institution Defaults

Default All Academic Organizations in Scope	Select to include all newly created academic organizations and all newly created elements (courses and sections) of previously existing academic organizations. If this check box is not selected, then by default, no newly created entities (academic organizations or elements) will be included unless you specifically and manually set them to be included. To include a specific organization when the check box is not selected, you must manually add it to the Academic Organization Defaults group box. To include a specific element when the check box is not selected, the organization must be in scope and then you must manually set element in scope where you define the specific element. For example, assume that the Biology department, an existing academic organization, is within scope. Because it is within scope, its elements are also available for scope. Perhaps your institution creates several new Biology courses or sections since the last snapshot transfer. When the check box is selected, all of the newly created Biology courses and sections are set to transfer automatically in the next and all subsequent snapshot transfers and if you have enabled event-based integration, set to participate in future event-based integrations. You can, however, manually exclude any of the elements from scope at any time at the element level. The element will continue to be excluded until manually set back into scope. If the check box is not selected, then none of the newly created Biology courses or sections will transfer in the integration processes. To include the newly created elements, you must manually set each of them in scope at the element level. The element will continue to be included until manually removed from scope. Warning! If you reinitialize the system at any time, all manual settings are lost including all scoping settings made at the element level.
Set All in Scope	Click to include all of the academic organizations and their elements that are in the system for the institution as of the date you click the button. When you click the button, the system displays values for the institution in the Academic Organization Defaults group box.
Default Association for Combined Sections	Select to automatically include all new associations for combined class sections. Note. An association is the name of a set of combined sections that you want SAIP to present as the same section in the external system. All sections in the combination must be in scope for the association to be included. If this check box is selected, you can, from the element level, manually exclude an association from scope at any time. If this check box is not selected, then section associations are ignored and their combined sections are presented as separate sections in the external system. To include an association when the check box is not selected, you must manually include it in scope where you defined the combined section. See Defining Class Associations. See Creating Combined Sections.
Last Combined	Date and time that combined sections were associated.
Error Log	Click this link to access the Section Association Error Log page and review association conflict errors.
Default IMS Association from Class Association	Click to use the associations for newly created class sections on the Class Association page in PeopleSoft Student Records to create the course sites in the external system. You can override class association at the course level on the Class Scoping and Association page (SAE_CLASS_CONFIG) within SAIP.
Integration Start Date Offset	Enter the default value for the number of days, either before or after the start date of a term, that integration should start for associated elements. Valid values are numbers with a minus symbol (-) representing a value prior to the term start date or numbers with a plus (+) symbol or no symbol representing a value after the start of the term. This default value applies to the terms associated with the institution, cascades to the sessions associated with each term and, unless it is changed at the session level, the value cascades down to class sections. Ultimately at the class section level, a calculation is done based on the term start date plus or minus the offset to give an actual integration start date. The calculated integration start date at the class section level can be overridden at the element level. For example: A term with a start date of September 10 and an institution set integration offset of -10 will have an integration start date of September 1.
Integration End Date Offset	Enter the default value for the number of days, either before or after the end date of a term, that integration should end for associated elements. Valid values are numbers with a minus symbol (-) representing a value prior to the term end date, numbers with a plus (+) symbol or no symbol representing a value after the end date of the term. This default value applies to the terms associated with the institution, cascades to the sessions associated with each term and, unless it is changed at the session level, the value cascades down to class sections. Ultimately at the class section level, a calculation is done based on the term end date plus or minus the offset to give an actual integration end date. The calculated integration end date at the class section level can be overridden at the element level. For example: A term with an end date of May 20 and an integration offset of 5 would have an integration end date of May 25.
Apply Offset to Term & Session	The values that you enter in the Integration Start and End Date fields represent the default to be applied to any new terms going forward. Click this button to apply a change in default offset values to all current terms and associated sessions.

See Setting the Integration Offsets.

See Mapping and Associating Class Sections.

Academic Organization Defaults

Use this group box to add or remove academic organizations to or from scope.

When the integration process runs, only the academic organizations listed in this group box will be included within the integration.

Warning! For the integration process to include an academic organization's associated elements, that academic organization must be listed in this group box. If the element is marked as in scope at the element level, but the academic organization is not listed in scope here, the associated element will not be included.

If you clicked the Set All In Scope button, the system displays all of the academic organizations in the system for the institution on the date that you clicked the button and selects the check boxes in the Default In Scope and Default Class Association. columns.

To add an academic organization to scope, add a row for that organization.

To remove an academic organization from scope, delete the row for that academic organization.

You can add and remove as many academic organizations from scope as you want. However, deleting an organization from scope after initialization causes the data transfer related to that organization to stop as of the next snapshot transfer and going forward. Carefully consider the impact of deleting an organization from scope.

Academic Organization	Enter the name of an academic organization that you want to include in scope.
Default Class Association	Select to use the associations for newly created class sections on the Class Association page in PeopleSoft Student Records to create course sites in the external system. If the Default IMS Association from Class Association check box is selected at the Institution Defaults level, that value appears here. You can override the default value at the academic organization level by clearing this check box You can also override the default value the element level. When the check box is cleared, newly created class sections for this academic organization will not derive the IMS association from the class association.
Default in Scope	Select to include all new elements related to this academic organization. When this check box is selected, all related elements created since the last snapshot transfer are included and updated in snapshot transfers, and if event-based integration is enabled, in event-based transfers, until manually excluded. Clear this check box to exclude from scope all new elements related to this academic organization. You can override this setting at any time either here or at the element level. You can clear the check box here to exclude all new elements, or you can exclude specific elements at the element level.
Set All in Scope	Click to include in the integration processes all existing elements related to this organization.
Last Set	Displays the date and time when items were last set for inclusion by clicking the Set All in Scope button in this row.

Viewing Section Association Errors

Access the Section Association Error Log page (Set Up SACR, Product Related, SA Integration Pack, Scoping/Association Defaults, Section Association Error Log).

Setting the Integration Offsets

To set the integration offsets, use the Term/Session Table component (TERM_TABLE).

This section discuss how to set the Integration Dating and Offset values.

Page Used to Set Integration Offsets

Page Name	Definition Name	Navigation	Usage
Integration Dating	SAE_TERM_SETUP	Set Up SACR, Foundation Tables, Term Setup, Term/Session Table, Integration Dating	Set integration dating and offset values.

Setting the Integration Dating and Offset Values

Access the Integration Dating page (Set Up SACR, Foundation Tables, Term Setup, Term/Session Table, Integration Dating).

Integration Dating

To determine if a specific term is in scope, SAIP evaluates several variables:

The first variable is the In Scope check box here on the Integration Dating page.

This check box is selected by default when a Term is created.
The second variable is the date range (start date to end date) of a term.

The date range for a term is defined in the Term Table and evaluated by SAIP to determine whether a term falls into scope with its date range.
The third variable is the offset value.

The offset value provides flexibility for when integration begins to flow between SAIP and the target system.

Offset is defined as a number of days plus/minus the start or end of a term. Here on the Integration Dating page, you can set a default number of offset days that will cascade to all sessions within a term.

Integration Start and End Date Offset

The Integration Start and End Date Offset values allow flexibility when an institution begins to transmit data from SAIP to the target system. For example, to facilitate faculty staff to log into a course in an LMS to prepare for a new term, an administrator can turn on the integration of term class sections to the campus learning management system 10 days (as an example) before a term begins.

By default, the offset values for integration start and end dates are zero which indicates that integration will begin on the date set as the start of the term and end on the date set as the end of the term.

These Integration Start and End Date Offset values cascade from a parent Term into the child Sessions to facilitate setting default values that cascade into all sessions and then subsequent class sections. However, the offset values can be overridden at the Session Level.

At the most granular level of the class section, the Integration Start and End Date are calculated based on the class section dates plus/minus the offsets. As seen in the Class Section Scoping and Association page, you can override the actual integration start and end date that has been populated based on defaults.

See Setting Default SAIP Scoping and Association Values.

See Mapping and Associating Class Sections.

Setting Up Integration Broker for SAIP

To set up Integration Broker for SAIP, you must activate each SAIP service operation. You must also activate each SAIP service operation routing and specify the destination URL for routing each service operation.

Set up the broker in PeopleTools as you would for any third-party system. Then use the PeopleTools Service Operations component (IB_SERVICE) to set up SAIP service operations and the PeopleTools Routings component (IB_ROUTINGDEFN) to set up the SAIP routings.

This section discusses how to:

Activate an SAIP service operation.
Activate an SAIP routing.
Specify an SAIP routing URL.

Pages Used to Set Up Integration Broker for SAIP

Page Name	Definition Name	Navigation	Usage
General	IB_SERVICE	PeopleTools, Integration Broker, Integration Setup, Service Operations, General	Activate an SAIP service operation.
Handlers	IB_SERVICEHDLR	PeopleTools, Integration Broker, Integration Setup, Service Operations, Handler Definitions	Activate an SAIP service operation handler.
Routing Definitions Page	IB_ROUTINGDEFN	PeopleTools, Integration Broker, Integration Setup, Routings, Routing Definitions	Activate an SAIP service operation routing.

Activating an SAIP Service Operation

Access the General page (PeopleTools, Integration Broker, Integration Setup, Service Operations, General).

Default Service Operation Version

Active

Select to activate the service operation for the SAIP service.

Note. SAIP service operations are delivered inactive. You must activate each service operation that your institution wants to use. Consult the installation documentation for a list of service operations to consider.

Note. In addition to activating SAIP service operations, ensure that the PERSON_BASIC_SYNC message service operation is set to Active and that the PERSON_DATA queue is running. SAIP person-based services depend on the PERSON_BASIC_SYNC message service operation for transforming and routing the SAIP payload.

See PeopleTools: Integration Broker, "Managing Service Operation Queues"

Activating an SAIP Handler

Access the Handlers definitions page for the web service handler (PeopleTools, Integration Broker, Integration Setup, Service Operations, Handler Definitions).

Status

Select Active to activate the handler for the SAIP service operation.

Note. SAIP service operation handlers are delivered inactive. You must activate each service operation handler that your institution wants to use.

Activating an SAIP Routing

Access the Routing Definitions page for the web service routing (PeopleTools, Integration Broker, Integration Setup, Routings, Routing Definitions).

Active

Select to activate the routing for the SAIP service operation.

Note. SAIP service operation routings are delivered inactive. You must activate each service operation routing that your institution wants to use.

Setting Up Enrollment and Course Batch Processing

COBOL-based enrollment processes must be set to operate with SAIP.

When the Enrollment Cobol program adds and processes enrollment data, the data is captured by a batch event table. The data in the table is then processed by a daemon that invokes the same logic that the online enrollment components use.

Similarly, the Copy Prior Term's Schedule process, which creates classes automatically for a new term based on previously defined classes, also uses a Cobol program that must be processed by a daemon.

You must set the frequency with which you want the daemon process to run. Prior to setting the frequency, carefully consider the amount of time between updates and your hardware and processing capacity.

These business processes use the batch event table:

Quick Enroll.
Repeat Checking.
Grade Posting.
Copy Prior Term's Schedule.

Use the PeopleTools Recurrences (PRCSRECURDEFN) and Schedule JobSet Definition (SCHDLDEFN) components, and the Event Register (SCC_INTEG_EVT_PUB) component to set up Cobol-based enrollment processing for SAIP.

This section discusses how to:

Set the recurrence frequency.
Set the event register.
Set the jobset definition.

Pages Used to Set Up Enrollment and Course Batch Processing

Page Name	Definition Name	Navigation	Usage
Recurrence Definition	PRCSRECURDEFN	PeopleTools, Process Scheduler, Recurrences, Recurrence Definition	Define the SAIP enrollment batch process start date and recurrence frequency.
Event Register	SCC_INT_EVT_PUB	Set Up SACR, System Administration, Integrations, Event Register	Identify the process recurrence frequency for the service operation.
Schedule JobSet Definition	SCHDLDEFN	PeopleTools, Process Scheduler, Schedule Jobset Definitions, Schedule Jobset Definition	Run the Event Replay Schedule load job to set the process recurrence.

Setting the Recurrence Frequency

Access the Recurrence Definition page (PeopleTools, Process Scheduler, Recurrences, Recurrence Definition).

Use the Recurrence Definition page to set the time and frequency for running the SAIP process. For example, if you want the process to run every night at 11:00 PM beginning today and repeating indefinitely or until you intervene, select the following:

Daily.
Everyday.
Start Request: Date = Today's date; Time = Current time.
End Request: (leave blank).
Repeat: Every = 24 hours; For (leave blank).

If you want to run the process four times a day for the next three months, perhaps to process enrollment data more often, select:

Daily.
Everyday.
Start Request: Date = Today's date; Time = Current time.
End Request: (leave blank).
Repeat: Every = 6 hours; For: = 3 months.

Schedule Next Recurrence when

Select the Prior occurrence has completed option.

Recurrence Pattern

Select the recurrence frequency that is appropriate for your business needs. Different days of the week are available based on the interval option (daily, weekly, monthly, and so on) that you select.

Start Request

Enter the date and time for the enrollment batch processing to begin.

Repeat

Specify the repetition frequency that is appropriate for your business needs and your hardware and processing capacity.

Setting the Event Register

Access the Event Registry page (Set Up SACR, System Administration, Integrations, Event Register).

Service Operation

Enter the service operation that you want to register.

For SAIP, you must register these service operations:

NotifyMembership.

NotifyClassSection.

Description and Long Description

Enter descriptions of the service operation. Consider describing its purpose and intended usage.

Object Owner ID

Displays the PeopleTools object owner ID that was set when the service operation was defined.

Batch Replay Chunk Size

(Not used by SAIP integrations.) Enter the maximum number of rows to send when performing real-time replay of batch updates.

Event Replay Support

Select only if the service operation stores event details in a database table for later replay according to a replay schedule.

When selected, the Event Replay Mode group box appears.

Note. You must select the Event Replay Support check box for each SAIP service operation that you register. Clear the check box if the service operation sends event information immediately.

Clear the check box if the service operation sends event information immediately.

Event Replay Mode

This group box appears only when the Event Replay Support check box is selected.

Integration Mode	Enter the mode in which the events should be replayed. For SAIP event replay, select only the Incremental integration mode.
Recurrence Name	Enter the Process Scheduler recurrence definition that defines the frequency with which you want the events to replay.
Chunk Size	Enter the maximum number of rows of outgoing event message data to send at a time.
Run Now	Click to schedule and run a real-time event replay.

Application Class

Package Name, Path, and Class ID	Enter the name of the application class root package that contains the PeopleCode class for this service operation.
Page	Enter the path to specified application class root package.
Class ID	Enter the ID for the application class PeopleCode that provides the service operation implementation.

Setting the Jobset Definition

Access the Schedule JobSet Definition page (PeopleTools, Process Scheduler, Schedule Jobset Definitions, Schedule Jobset Definition).

If the Event Replay Support check box is selected on the Event Registry page, then the Campus Integration framework Event Replay Schedule Load job (SCCEVTLD) with the desired recurrence name is required.

Note. This job must run at installation and at any time that the recurrence name on the Event Registry page changes.

SCCEVTLD evaluates the event registry for integration points that support event replay. For each potential event replay integration point, SCCEVTLD loads a new Process Scheduler recurring job with the recurrence schedule that is specified on the corresponding service operation's Event Registry page. At the specified time, the loaded job runs and subsequently replays event data stored for that integration point.

Create a schedule name, and schedule the Event Replay Schedule Load job, SCCEVTLD. Enter the recurrence name for the frequency at which the events should replay.

See PeopleTools: PeopleSoft Process Scheduler, "Defining Jobs and JobSets," Creating Scheduled JobSet Definitions

Time Information

Recurrence Name

Enter the name of the recurrence pattern that is set on the Recurrences Definition page for this service operation.

Run the process as you would any Process Scheduler job.

See PeopleTools: PeopleSoft Process Scheduler, "Defining Jobs and JobSets," Monitoring Jobs and JobSets

Service Operation	Enter the service operation that you want to register. For SAIP, you must register these service operations: NotifyMembership. NotifyClassSection.
Description and Long Description	Enter descriptions of the service operation. Consider describing its purpose and intended usage.
Object Owner ID	Displays the PeopleTools object owner ID that was set when the service operation was defined.
Batch Replay Chunk Size	(Not used by SAIP integrations.) Enter the maximum number of rows to send when performing real-time replay of batch updates.
Event Replay Support	Select only if the service operation stores event details in a database table for later replay according to a replay schedule. When selected, the Event Replay Mode group box appears. Note. You must select the Event Replay Support check box for each SAIP service operation that you register. Clear the check box if the service operation sends event information immediately. Clear the check box if the service operation sends event information immediately.