Defining and Setting Up Event Notifications for Campus Mobile

This section provides overviews of setup for notifications and events as well as batch notifications, and it discusses how to:

  • Perform general event setup.

  • Perform general notification setup.

  • Set up checklist events with notifications.

  • Set up service indicator (SI) add events with notifications.

  • Set up SI removed events with notifications.

  • Set up enrollment appointment events with notifications.

  • Create a job definition.

  • Schedule jobs.

  • Set up an events archive

  • Set up push notifications.

Campus Solutions provides a notifications framework to trigger various streams of communication, called channels, based on underlying conditions (such as the posting of a final grade). Within the Campus Solutions Notification Framework, specific underlying conditions are defined as events. A single event, such as a final grade posting, can trigger multiple notification actions – for example, it may cause an email, an SMS message, and also a push notification to be sent to a user.

Campus Mobile delivers configurable artifacts that work with the Campus Solutions Notification Framework to capture events and publish messages through the email, SMS and push channels. An activity stream showing recent events appears to the Campus Mobile user on a tab in the Landing Page. This tab, titled Notifications, has a badge reflecting the number of unread events in the list. Tapping the Notifications tab displays the events listing where the user can navigate to specific features in the context of the event. Tapping the back button returns the user to the list of events in the Notifications tab of the Landing Page.

Defining and Setting Up Events for Campus Mobile

As described above and in the “Using Campus Mobile” set of topics, starting with Campus Mobile Version 4, events are presented to the student through the Notifications tab in the Campus Mobile Landing Page. Follow this setup guide to present the student with an event feed in Campus Mobile, and to trigger subsequent notifications to students (as referenced in “Using Campus Mobile”) using SMS, Email, or Push.

The Enrollment Appointment notification and notification of new or changed Holds or To Do List items requires you to set up a new batch notification job. To facilitate regular checking of these business process events, define new batch notification jobs using the Campus Solutions Notification Framework. In addition, you must associate each batch notification definition with a job definition and schedule it using the JobSet Definitions page in PeopleTools Process Scheduler.

The steps in this section outline the required setup needed for the following batch notification definitions:

  • CheckListBatchSMS

  • CheckListBatchEmail

  • CheckListBatchPush

  • SI_AddOrChangeBatchSMS

  • SI_AddOrChangeBatchEmail

  • SI_AddOrChangeBatchPush

  • SI_DeleteBatchSMS

  • SI_DeleteBatchEmail

  • SI_DeleteBatchPush

  • EnrollmentApptStatusBatchSMS

  • EnrollmentApptStatusBatchEmail

  • EnrollmentApptStatusBatchPush

Page Name

Definition Name

Navigation

Usage

Event Setup

SCC_NTFEVT_CFG

Set Up SACR > System Administration > Utilities > Notifications > Event Setup

Configure the event and specify the notification consumers to track events and notifications.

Batch Notifications

SCC_BAT_NTF_RC

Set Up SACR > System Administration > Utilities > Notifications > Batch Notifications

Define parameters such as selection criteria (using Population Selection) for recipients to be included in batch notification.

Push Notification Setup

SCC_NTF_PUSH_SETUP

Set Up SACR > System Administration > Utilities > Notifications > Push Notification Setup

Configure the push notification setup for APNS and GCM.

Notification Setup

SCC_NTF_SETUP

Set Up SACR > System Administration > Utilities > Notifications > Notification Setup

Activate notifications for Campus Mobile.

Notification Consumer Setup

SCC_NTF_CON_CFG

Set Up SACR > System Administration > Utilities > Notifications > Notification Consumer Setup

Activate notification consumers.

SMS Notification

SCC_NTF_SMS

Set Up SACR > System Administration > Utilities > Notifications > SMS Notification Setup

Define connection details used for sending SMS messages.

The following service operations, handlers, and routings must be activated to enable Campus Mobile’s use of events. These services populate the Notifications tab in the Landing Page. See the section “Activating Campus Mobile Service Operations, Handlers and Routing” for details on how to activate these service operations.

Service Operation

Handler

Routing

SCC_NTF_PUBLISH_STDNT_ENRL

ONNOTIFY

SCC_NTF_PUBLISH_STDNT_ENRL

SCC_NTF_GET_EVENTS_R_POST

REQUESTHDLR

SCC_NTF_GET_EVENTS_R_POST

SCC_NTF_UPDATE_EVENTS_R_POST

REQUESTHDLR

SCC_NTF_UPDATE_EVENTS_R_POST

Activating Campus Mobile Events

Events are delivered as inactive and must be activated. To activate events:

  1. Log into the PeopleSoft application in a browser.

  2. Select Set Up SACR, System Administration, Utilities, Notifications, Event Setup.

  3. Select each of the Event from the following list.

  4. Select Active from the Status field drop-down list.

  5. Save the page.

Event names:

  • FINAL_GRADE_POSTED

  • ENROLLED_FROM_WAITLIST

  • CHECKLIST_UPDATED_BATCH

  • SI_ASSIGNED_BATCH

  • SI_REMOVED_BATCH

  • ENROLLMENT_APPT_OPEN_BATCH

Note: Over time, the Events table can grow and need to be archived. Campus Mobile only shows events from the past 7 days so it would be reasonable to run a weekly Event Archive job that would clean up any events prior to that 7-day mark. See the section “Events Archive Setup” to configure events archiving.

Notifications, delivered in parallel with Campus Mobile, are described in the “Using Campus Mobile” documentation. As noted, notifications can be delivered to a student through three channels: SMS, email, or push notifications. This section describes the steps you must take to activate notifications for each channel.

Notification Service Operation Table

The following service operations, handlers, and routings must be activated to enable Campus Mobile’s use of the Notification Framework features. See the section “Activating Campus Mobile Service Operations, Handlers and Routing” for details on how to activate these service operations.

Service Operation

Handler

Routing

SCC_PUSH_NOTIFICATIONS

NOTIFYHNDLR

SCC_PUSH_NOTIFICATIONS

SCC_DEVICE_REGISTER_POST

REQUESTHDLR

SCC_DEVICE_REGISTER_POST

SCC_NTF_PUBLISH_STDNT_ENRL

ONNOTIFY

SCC_NTF_PUBLISH_STDNT_ENRL

SCC_NTF_GET_EVENTS_R_POST

REQUESTHDLR

SCC_NTF_GET_EVENTS_R_POST

SCC_NTF_UPDATE_EVENTS_R_POST

REQUESTHDLR

SCC_NTF_UPDATE_EVENTS_R_POST

SCC_GCM_SEND_POST

--

SCC_GCM_SEND_POST

SCC_APNS_FEEDBACK

--

SCC_APNS_FEEDBACK

SCC_APNS_SEND

--

SCC_APNS_SEND

SCC_NTF_SMS_SRV

--

SCC_NTF_SMS_SRV

Activating Campus Mobile Notification Templates

Notification templates for email, SMS, and push are delivered with a status of Inactive. To make use of Notifications functionality at the time of implementation, you need to set each of them to a status of Active. Note that the template names indicate their usage for SMS, email, or push so you can decide which ones to activate.

To activate Notification templates:

  1. Log into the PeopleSoft application in a browser.

  2. Select Set Up SACR > System Administration > Utilities > Notifications > Notification Setup.

  3. Select each of the Notification templates from the following list.

  4. Select Active from the Status field drop-down list.

  5. Save the page.

Notification Template Name:

  • GRADE_ADDED_EMAIL

  • GRADE_ADDED_PUSH

  • GRADE_ADDED_SMS

  • GRADE_CHANGED_EMAIL

  • GRADE_CHANGED_PUSH

  • GRADE_CHANGED_SMS

  • GRADE_REMOVED_EMAIL

  • GRADE_REMOVED_PUSH

  • GRADE_REMOVED_SMS

  • WAITLIST_ENROLLED_EMAIL

  • WAITLIST_ENROLLED_PUSH

  • WAITLIST_ENROLLED_SMS

  • CHECKLIST_UPDATED_EMAIL

  • CHECKLIST_UPDATED_PUSH

  • CHECKLIST_UPDATED_SMS

  • SI_ADDED_OR_CHANGED_EMAIL

  • SI_ADDED_OR_CHANGED_PUSH

  • SI_ADDED_OR_CHANGED_SMS

  • SI_REMOVED_EMAIL

  • SI_REMOVED_PUSH

  • SI_REMOVED_SMS

  • ENROLLMENT_APPT_OPEN_EMAIL

  • ENROLLMENT_APPT_OPEN_PUSH

  • ENROLLMENT_APPT_OPEN_SMS

Activating Campus Mobile Notification Consumers

Notification consumers for email, SMS, and push are delivered with a status of Inactive. In order to make use of Notifications functionality at the time of implementation, you need to set each of them to a status of Active. Similar to the templates, if you only intend to activate certain channels you do not need to activate every consumer. However, note that the single consumer "Campus Mobile" is required for all three channels (email, SMS, and push) to activate the checklist notifications, service indicator notifications, and enrollment appointment notifications.

To activate Notification consumers:

  • Log into the PeopleSoft application in a browser.

  • Select Set Up SACR > System Administration > Utilities > Notifications > Notification Consumer Setup.

  • Select each of the Notification consumers from the following list.

  • Select Active from the Status field drop-down list.

  • Save the page.

Notification Consumer Name:

  • FINAL_GRADE_POSTED

  • ENROLLED_FROM_WAITLIST

  • CHECKLIST_UPDATED_BATCH

  • SI_ASSIGNED_BATCH

  • SI_REMOVED_BATCH

  • ENROLLMENT_APPT_OPEN_BATCH

Note: The Waitlist Notification requires a Wait List process: PSJob process SRWAITJB. Please see Student Records for more information on implementing this process.

To set up checklist events with notifications:

  1. Navigate to Set Up SACR > System Administration > Utilities > Notifications > Batch Notifications

  2. Add new Run Control ID (CHECKLIST_UPDATED_BATCH).

  3. Configure the Checklist batch notification as follows:

Population Selection

  1. Enable Population Selection.

  2. Select PS Query as Selection Tool.

  3. Select SCC_CHECKLIST as Query Name.

Event Setup

Configure event setup so that Checklist Events appear on the Notifications tab in the Campus Mobile Landing Page.

  1. Select Enable Event Tracking.

  2. Select CHECKLIST_UPDATED as the Event ID.

  3. Fill the Event Parameters Grid as follows:

    1. Map the User (%1) Bind variable to Checklist Descr.

    2. Enter CHECKLIST_UPDATED as the value for EVENT_TYPE.

    3. Enter Checklist as the value for GOTO.

Notification Consumers and Templates Setup

Configure notification consumers and templates to enable SMS, email, and Push notifications:

  1. Select CHECKLIST_UPDATED as Notification Consumer ID.

  2. Select the Enable for Batch check box.

  3. Configure the SMS notification template:

    1. Select CHECKLIST_UPDATED_SMS as Template Name.

    2. Select the Enable for Batch check box.

    3. Enter an optional Item Tag such as CHECKLIST.

    4. Select an optional Notification Importance value.

    5. Fill in the notification parameters grid as follows: i) Map the User (%1) Bind variable to Name; ii) Map the Checklist Name (%2) Bind Variable to CheckList Descr.

  4. Configure the email notification template:

    1. Select CHECKLIST_UPDATED_EMAIL as Template Name.

    2. Select the Enable for Batch check box.

    3. Enter an optional Item Tag such as CHECKLIST.

    4. Select an optional Notification Importance value.

    5. Fill in the notification parameters grid as follows: i) Map the User (%1) Bind variable to Name; ii) Map the Checklist Name (%2) Bind Variable to CheckList Descr.

  5. Configure the push notification template:

    1. Select CHECKLIST_UPDATED_PUSH as Template Name.

    2. Select the Enable for Batch check box.

    3. Enter an optional Item Tag such as CHECKLIST.

    4. Select an optional Notification Importance value.

    5. Fill in the notification parameters grid as follows: i) Map the User (%1) Bind variable to Name; ii) Map the Checklist Name (%2) Bind Variable to CheckList Descr; iii) Provide GOTO Key value as Checklist.

To set up SI Add events with notifications:

  1. Navigate to Set Up SACR > System Administration > Utilities > Notifications > Batch Notifications

  2. Add new Run Control ID (SI_ASSIGNED_BATCH).

  3. Set up the configuration as follows:

Population Selection

  1. Enable Population Selection.

  2. Select PS Query as Selection Tool.

  3. Select SCC_SI_ADD_OR_CHANGE as Query Name.

Event Setup

Configure Event Setup so that SI add events appear on the Notifications tab in the Campus Mobile Landing Page.

  1. Select Enable Event Tracking.

  2. Select SERVICE_INDICATOR_ASSIGNED as the Event ID.

  3. Fill the Event Parameters Grid as follows:

    1. Enter SERVICE_INDICATOR_ASSIGNED as the value for EVENT_TYPE.

    2. Enter Holds as the value for GOTO.

Notification Consumers and Templates Setup

Configure notification consumers and templates to enable SMS, email, and Push notifications:

  1. Select SERVICE_INDICATOR_ASSIGNED as Notification Consumer ID.

  2. Select the Enable for Batch check box.

  3. Configure the SMS notification template:

    1. Select SI_ADDED_OR_CHANGED_SMS as Template Name.

    2. Select the Enable for Batch check box.

    3. Enter an optional Item Tag such as SERVICE_INDICATOR.

    4. Select an optional Notification Importance value.

    5. In the notification parameters grid, map the User (%1) Bind variable to Name.

  4. Configure the email notification template:

    1. Select SI_ADDED_OR_CHANGED_EMAIL as Template Name.

    2. Select the Enable for Batch check box.

    3. Enter an optional Item Tag such as SERVICE_INDICATOR.

    4. Select an optional Notification Importance value.

    5. In the notification parameters grid, map the User (%1) Bind variable to Name.

  5. Configure the push notification template:

    1. Select SI_ADDED_OR_CHANGED_PUSH as Template Name.

    2. Select the Enable for Batch check box.

    3. Enter an optional Item Tag such as SERVICE_INDICATOR.

    4. Select an optional Notification Importance value.

    5. Fill in the notification parameters grid as follows: i) Map the User (%1) Bind variable to Name; ii) ; Provide GOTO Key value as Holds.

To set up SI Removed events with notifications:

  1. Navigate to Set Up SACR > System Administration > Utilities > Notifications > Batch Notifications

  2. Add new Run Control ID (SI_REMOVED_BATCH).

  3. Set up the configuration as follows:

Population Selection

  1. Enable Population Selection.

  2. Select PS Query as Selection Tool.

  3. Select SCC_SI_ADD_DELETE as Query Name.

Event Setup

Configure Event Setup so that SI removed events appear on the Notifications tab in the Campus Mobile Landing Page.

  1. Select Enable Event Tracking.

  2. Select SERVICE_INDICATOR_REMOVED as the Event ID.

  3. Fill the Event Parameters Grid as follows:

    1. Enter SERVICE_INDICATOR_REMOVED as the value for EVENT_TYPE.

    2. Enter Holds as the value for GOTO.

Notification Consumers and Templates Setup

Configure notification consumers and templates to enable SMS, email, and Push notifications:

  1. Select SERVICE_INDICATOR_REMOVED as Notification Consumer ID.

  2. Select the Enable for Batch check box.

  3. Configure the SMS notification template:

    1. Select SI_REMOVED_SMS as Template Name.

    2. Select the Enable for Batch check box.

    3. Enter an optional Item Tag such as SERVICE_INDICATOR.

    4. Select an optional Notification Importance value.

    5. In the notification parameters grid, map the User (%1) Bind variable to Name.

  4. Configure the email notification template:

    1. Select SI_ REMOVED _EMAIL as Template Name.

    2. Select the Enable for Batch check box.

    3. Enter an optional Item Tag such as SERVICE_INDICATOR.

    4. Select an optional Notification Importance value.

    5. In the notification parameters grid, map the User (%1) Bind variable to Name.

  5. Configure the push notification template:

    1. Select SI_ REMOVED _PUSH as Template Name.

    2. Select the Enable for Batch check box.

    3. Enter an optional Item Tag such as SERVICE_INDICATOR.

    4. Select an optional Notification Importance value.

    5. Fill in the notification parameters grid as follows: i) Map the User (%1) Bind variable to Name; ii) ; Provide GOTO value as Holds Delete.

To set up enrollment appointment events with notifications:

  1. Navigate to Set Up SACR > System Administration > Utilities > Notifications > Batch Notifications

  2. Add new Run Control ID (ENROLLMENT_APPT_OPEN_BATCH).

  3. Set up the configuration as follows:

Population Selection

  1. Select an Academic Institution.

  2. Enable Population Selection.

  3. Select PS Query as Selection Tool.

  4. Select SCC_ ENROLLMENT_APPOINTMENT as Query Name.

Event Setup

Configure Event Setup so that enrollment appointment events appear on the Notifications tab in the Campus Mobile Landing Page.

  1. Select Enable Event Tracking.

  2. Select ENROLLMENT_APPT_OPEN as the Event ID.

  3. Fill the Event Parameters Grid as follows:

    1. Map the Appointment Number (%1) Bind variable to the Appointment Number field.

    2. Map the Appointment Start Date (%2) Bind variable to the Appointment Start Date field.

    3. Map the Appointment Start Time (%3) Bind variable to the Appointment Start Time field.

    4. Map the INST Bind variable to the Institution field.

    5. Map the Acad Career Bind variable to the Acad Career field.

    6. Map the Term Bind variable to the Term field.

    7. Enter ENROLLMENT_APPT_OPEN as the value for EVENT_TYPE.

    8. Enter Cart as the value for GOTO.

Notification Consumers and Templates Setup

Configure notification consumers and templates to enable SMS, email, and Push notifications:

  1. Select ENROLLMENT_APPT_OPEN as Notification Consumer ID.

  2. Select the Enable for Batch check box.

  3. Configure the SMS notification template:

    1. Select ENROLLMENT_APPT_OPEN_SMS as Template Name.

    2. Select the Enable for Batch check box.

    3. Enter an optional Item Tag such as ENROLLMENT_APPT_OPEN.

    4. Select an optional Notification Importance value.

    5. Fill in the notification parameters grid as follows: i) Map the User (%1) Bind variable to Name; ii) Map the Appointment Number (%2) Bind variable to the Appointment Number field; iii) Map the Appointment Start Date (%3) Bind variable to the Appointment Start Date field; iv) Map the Appointment Start Time (%4) Bind variable to the Appointment Start Time field.

  4. Configure the email notification template:

    1. Select ENROLLMENT_APPT_OPEN _EMAIL as Template Name.

    2. Select the Enable for Batch check box.

    3. Enter an optional Item Tag such as ENROLLMENT_APPT_OPEN.

    4. Select an optional Notification Importance value.

    5. Fill in the notification parameters grid as follows: i) Map the User (%1) Bind variable to Name; ii) Map the Appointment Number (%2) Bind variable to the Appointment Number field; iii) Map the Appointment Start Date (%3) Bind variable to the Appointment Start Date field; iv) Map the Appointment Start Time (%4) Bind variable to the Appointment Start Time field.

  5. Configure the push notification template:

    1. Select ENROLLMENT_APPT_OPEN_PUSH as Template Name.

    2. Select the Enable for Batch check box.

    3. Enter an optional Item Tag such as ENROLLMENT_APPT_OPEN.

    4. Select an optional Notification Importance value.

    5. Fill in the notification parameters grid as follows: i) Map the User (%1) Bind variable to Name; ii) Map the Appointment Number (%2) Bind variable to the Appointment Number field; iii) Map the Appointment Start Date (%3) Bind variable to the Appointment Start Date field; iv) Map the Appointment Start Time (%4) Bind variable to the Appointment Start Time field; v) Map the INST Bind variable to the Institutionfield; vi) Map the Term Bind variable to the Term” field; vii) Map the Acad Career Bind variable to the Acad Career field; viii) Enter Cart as the value for GOTO.

After you create the batch notification definitions, you should create a job definition to control when the batch notification process runs. Depending on your requirements you can create a single job definition for all batch notifications, or create individual jobs for each batch notification.

Note: Batch processing is expected to occur once per day. In addition, the system sends notifications to students at the time it executes the batch process. In other words, batch processes that typically run in the middle of the night might result in students receiving SMS text messages on their phone during non-waking hours. You can create a single job definition that is common to all batch notifications or, if needed, separate jobs for each batch process to schedule them in different recurrence definitions.

To create a job definition:

  1. Access the Jobs page (PeopleTools > Process Scheduler > Jobs).

    1. Add a New Job (CL_SMS).

    2. Click the Job Definition Tab.

    3. Select a Process Category of Default.

    4. Add the SCC_BAT_NTF Application Engine Process in the Process List.

  2. Click the Job Definition Options tab.

    1. Provide the Recurrence name (Daily).

    2. Select a process Group of ALL PAGES.

    3. Select a Component of SCC_BAT_NTF_RC.

To schedule a job:

  1. Access the JobSet Definitions page (PeopleTools > Process Scheduler > Schedule JobSet Definitions).

  2. Add a new schedule as follows (for example, for checklist batch SMS):

    1. Set the Status to Active.

    2. Provide a Run Control ID (CheckListBatchSMS).

    3. Enter schedule and timing details as required for your installation, keeping in mind the following implications:

      - The system sends checklist notifications for checklists that are added or updated the day prior to the batch process execution.

      - The system sends SI notifications for changes occurring in the 24 hours prior to the batch process execution.

      - The system sends enrollment appointment notifications for appointments that open the day after the batch process execution.

      - Executing the batch process more than once per day may lead to duplicate enrollment appointment notifications.

      - Executing the batch process less than once per day may lead to missed enrollment appointment notifications.

      - The system sends notifications to students at the time of batch process execution.

  3. Click Save and run the schedule.

Over time, the Events table can grow and need to be archived. Campus Mobile only shows events from the past 7 days so it would be reasonable to run a weekly Event Archive job that would clean up any events prior to that 7-day mark. The Events Archive process uses the Data Archive Manager and a delivered query.

Test Running the Delivered PS Query

  1. Navigate to Reporting Tools > Query > Query Manager.

  2. Select Advanced Search.

    Change Query Type from User to Archive.

  3. Click Search.

  4. Select the Edit link for the SCC_NFK_EVENT_ARCHIVE query in the search list.

  5. Click the Run tab.

    Enter appropriate values for input date, Read Events and Unread Events check boxes in the prompt table and click OK. The result set shows all the header rows that are eligible for archiving. The related child data would also be archived.

Create the Archive Process

  1. Navigate to PeopleTools > Data Archive Manager > Archive Data to History.

  2. Add a new archive run control ID (SCC_EVENT).

  3. Fill in the following information:

    1. Select the SCC_ENFK Archive Template.

    2. Select Appropriate Process Selection Value:

      Selection – to copy rows from online (main) tables to history tables.

      Delete – to delete rows from online (main) tables.

      Remove from History – to delete rows from history tables.

      Rollback – to restore online(main) tables from history tables.

    3. Select Selective Query SCC_NFK_EVENT_ARCHIVE if process type is Selection; otherwise select Batch Number.

    4. Select Commit Processing as needed.

  4. Select the Define Binds hyperlink to input or change archive query rule.

  5. Select the Reset Query Bind Variables button.

    A prompt table appears that accepts the Archive Rule input date, Read Events, and Unread Events check boxes.

  6. Click the Run button, and select the PSARCHIVE – Data Archive Manager Application Engine process.

    Run the process to success.

Check the Archive Audit

  1. Navigate to PeopleTools > Data Archive Manager > Audit Archiving.

  2. Select Archive ID SCC_ENFK.

  3. Click Search to view the audit report for the archive process.

Please note that while email and SMS notifications do not require Campus Mobile, push notifications do require Campus Mobile. Oracle recommends that you set up push notifications to provide proactive information to the students who use the Campus Mobile app.

In addition to the steps already outlined in this topic for activating push notifications, you must enter the appropriate values in the Push Notification Setup page. The push notification setup section of Notification Framework documentation provides details on the setup of push notifications, including integration with the Apple and Google notification services, which are required to deliver push notifications.

See Understanding the Notifications Framework.