PeopleSoft Enterprise 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 IMS integration start date.
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 which name and address usages to use, 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 an FTP 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 intitialization, 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 Event Triggers

Select to enable all of the event-based triggers that are delivered preset within the SAIP 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.

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.

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.

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 Enterprise Campus Solutions system.

See Designing Campus Community.

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.
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.
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.

File Directory Settings

When snapshot integration runs (either incremental or full snapshot), SAIP creates an XML file of the captured data. You must specify where in the source system the process is to place the XML file. You must also identify the same destination on the target external system side for it to query the appropriate place for data updates.

The naming convention for the XML file is serviceoperationname+datetimestamp. You can make manual changes to the XML file to apply to the target external system, but those changes will not also exist in your Campus Solutions system unless you manually make them there also.

If you provide both a directory path and FTP settings, SAIP places the XML file in both places.

See Designing Campus Community.

Directory Path

If you want SAIP to place the snapshot XML file in file, you must specify that path here.

Upload to FTP, 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.

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.

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.

Page 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.

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.

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.
Default IMS Association from Class Association	Click to use the associations for newly created class sections on the Class Association page in PeopleSoft Enterprise Student Records to create the course sites in the external system. You can override class association at the course level on the IMS Scoping and Association page (SAE_CLASS_CONFIG) within SAIP.

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 Enterprise 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.

Setting the IMS Integration Start Date

To set the IMS integration start date, use the Term/Session Table component (TERM_TABLE).

This section discusses how to set the IMS integration start date.

Page Used to Set IMS Integration Start Date

Page Name	Definition Name	Navigation	Usage
IMS Integration	DESIGN_ACADEMIC_STRUCTURE	Set Up SACR, Foundation Tables, Term Setup, Term/Session Table, IMS Integration	Identify the date on which the system should begin to integrate for a specific term with the IMS attributes and make that data available for transfer.

Setting the Integration Start Date

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

Integration Start Date

Enter the date on which you want SAIP to begin integrating data from this term with the IMS attributes and make the term and its related elements available in the next and all subsequent snapshot and event-based transfers. The term remains included in scope unless the integration start date is cleared, reset, or the term has ended.

Note. The integration start date cannot be later than the term end date.

Warning! Not entering an integration start date for a desired term results in no data publication from the event-driven services for that term and no extraction of any data from that term by the full or incremental snapshot processes.

The term start date and integration start date are unrelated. You can set a term for integration and inclusion as much in advance of the term start date as desired. Allowing the term and related course information to be published to your external system in advance enables faculty to create their course sites in preparation for when enrollments begin.

Including terms gradually as they and their related courses, classes, and sections become finalized minimizes the manual changes that may be required to present data as desired and keep data synchronized between your Campus Solution and external systems.

To include all terms regardless of term start date, you could enter an integration start date of 01/01/1900 for each term.

If you remove a term after integration or clear the integration start date after integration, all integration and snapshot transfers for that term will stop.

To include the term and its elements in the upcoming snapshot transfer, consider entering the current system date.

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.
Routing Definitions Page	IB_ROUTINGDEFN	PeopleTools, Integration Broker, Integration Setup, Routings, Routing Definitions	Activate an SAIP service operation routing.
Connector Properties	IB_ROUTINGDEFNCON	PeopleTools, Integration Broker, Integration Setup, Routings, Connector Properties	Specify the destination URL for routing each SAIP service operation.

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 Enterprise PeopleTools PeopleBook: PeopleSoft Integration Broker, "Managing Service Operation Queues"

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.

Specifying an SAIP Routing URL

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

You must specify the primary URL to use if the target node for the routing is not the local node.

In the Value field of the PRIMARYURL row, enter the destination URL for the routing.

See Enterprise PeopleTools PeopleBook: PeopleSoft Integration Broker, "Managing Integration Gateways"

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 Enterprise PeopleTools PeopleBook: 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 Enterprise PeopleTools PeopleBook: 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.