CAMPUS SOLUTIONS
CRM FOR HIGHER EDUCATION
DEVELOPER'S GUIDE
Campus Solutions CRM for Higher Education Developer's Guide
TABLE OF CONTENTS
1
Overview of Campus Solutions to CRM Integration ................................................................................................... 1
1.1
Test Scores ....................................................................................................................................................... 1
360 Aggregation Service .................................................................................................................................... 3
3.2
Admissions Core Service ................................................................................................................................... 4
3.3
Contributor Relations Core Service .................................................................................................................... 5
3.4
Student Financials Core Service ......................................................................................................................... 6
3.5
Interactions (3C’s) Core Service ......................................................................................................................... 7
3.6
Transfer Credits Core Service ............................................................................................................................ 7
3.7
Transcript Requests Service .............................................................................................................................. 8
3.8
Financial Aid Core Service ................................................................................................................................. 8
3.9
Constituent Summary Core Service ................................................................................................................... 9
3.10 Affiliations Core Service .................................................................................................................................... 9
3.11 Academics Core Service .................................................................................................................................. 10
3.12 Configuration page ......................................................................................................................................... 11
4
Source data analysis for Recruitment Section on CRM ............................................................................................. 12
HE360 Security Model ..................................................................................................................................... 18
CS Test Score Post Process ...................................................................................................................................... 19
6.1
Test Score CRM Messaging .............................................................................................................................. 20
6.2
Installation SA ................................................................................................................................................ 22
6.3
External Test Score Mapping ........................................................................................................................... 22
Campus Solutions CRM for Higher Education Developer's Guide
6.3.1
Admit Term Map ________________________________________________________________________ 22
Integration Set‐up with CRM ______________________________________________________________________ 28
Query Access Service (QAS) _______________________________________________________________________ 28
APPENDIX III
Data Publish Architecture ................................................................................................................... 29
Modes of Publishing _____________________________________________________________________________ 29
SOA Configuration ..................................................................................................................................................... 33
Event Registration _______________________________________________________________________________ 33
6.3.4
Campus Solutions CRM for Higher Education Developer's Guide
1 OVERVIEW OF CAMPUS SOLUTIONS TO CRM INTEGRATION
There are three broad components in the CRM for Higher Education (CRM4HE) integration with Campus Solutions (CS),
which all depend on the Campus Solutions Services Oriented Architecture (SOA):
• Enterprise Integration Points (EIPs)
• 360 Degree View
• Test Scores
1.1 ENTERPRISE INTEGRATION POINTS
EIPs support the information flows by providing the conduits for the information when the host detects specific data
changes. The student lifecycle changes described below are driven by EIPs, for example.
1.2 360 DEGREE VIEW
The 360 degree view in CRM has been expanded to provide Higher Education specific information to aid institutions in
building and maintaining relationships with constituents. For example, the Recruitment section of the 360 degree view
uses Last School Attended and School Type information, which is published from Campus Solutions as part of the
External Organization Data interface. This information is sought by CRM from CS via the synchronous “360 aggregation
service”.
The Student Life Cycle changes ‐ from suspect, to prospect, to applicant ‐ are currently tracked in Campus Solutions.
With the implementation of recruitment functionality in CRM, it is important that these life cycle changes are tracked
in CRM. Therefore, when there is a change in the life cycle of a student in Campus Solutions, it will reflect in CRM also.
1.3 TEST SCORES
Similarly, the Test Score Post Process requires External Organization data from Campus Solutions. Therefore, any
update to the external organization data in Campus Solutions is reflected in CRM.
2 ENTERPRISE INTEGRATION POINTS
The following table lists the EIPs that are delivered with this release of CRM4HE. All EIPs are asynchronous services.
Appendix II explains the steps required to activate them. APPENDIX III provides further details on CRM4HE’s data
publication architecture.
Functionality
Student Status Change
Academic Structure
Oracle Corporation ‐ Confidential
EIP
New
/Modified
Publish
Type
SSR_ACAD_PROG_SYNC
N
R
SSR_ACAD_PROG_FULLSYNC
N
F
SSR_ACADINST_SETUP_FULLSYNC
N
F
SSR_ACADCAMP_SETUP_FULLSYNC
N
F
SSR_ACADCAR_SETUP_FULLSYNC
N
F
SSR_ACADPROG_SETUP_FULLSYNC
N
F
SSR_ACADPLAN_SETUP_FULLSYNC
N
F
SSR_ACADSUBPLAN_SETUP_FULLSYNC
N
F
SSR_ACADTRM_SETUP_FULLSYNC
N
F
SSR_ACADINST_SETUP_SYNC
N
R
SSR_ACADCAMP_SETUP_SYNC
N
R
Page 1
Campus Solutions CRM for Higher Education Developer's Guide
Functionality
External Org
School Type Set up Table
Test Component ‐Setup
Admit Type Setup
Academic Structure Security
New
/Modified
Publish
Type
SSR_ACADCAR_SETUP_SYNC
N
R
SSR_ACADPROG_SETUP_SYNC
N
R
SSR_ACADPLAN_SETUP_SYNC
N
R
SSR_ACADSUBPLAN_SETUP_SYNC
N
R
SSR_ACADTRM_SETUP_SYNC
N
R
SCC_EXT_ORG_SYNC
N
R
SCC_EXT_ORG_FULLSYNC
N
F
SCC_SCHL_TYPE_SETUP_SYNC
N
R
SCC_SCHL_TYPE_SETUP_FULLSYNC
N
F
SAD_TEST_SETUP_SYNC
N
R
SAD_TEST_SETUP_FULLSYNC
N
F
SAD_TEST_COMP_SYNC
N
R
SAD_TEST_COMP_FULLSYNC
N
F
SAD_TEST_SCRTY_SYNC
N
R
SAD_TEST_SCRTY_FULLSYNC
N
F
SAD_ADMITTYPE_SETUP_FULLSYNC
N
F
SAD_ADMITTYPE_SETUP_SYNC
N
R
SSR_SCRTY_INST_UID_FULLSYNC
N
F
SSR_SCRTY_INST_UID_SYNC
N
R
SSR_SCRTY_CAR_UID_FULLSYNC
N
F
SSR_SCRTY_CAR_UID_SYNC
N
R
SSR_SCRTY_PROG_UID_FULLSYNC
N
F
SSR_SCRTY_PROG_UID_SYNC
N
R
SSR_SCRTY_PLAN_UID_FULLSYNC
N
F
SSR_SCRTY_PLAN_UID_SYNC
N
R
Prospect
SAD_ADM_PRSPCT_DATA_SYNC
N
R
Breakup – Pers Data Extnd full
Sync
SCC_SRVC_IND_SYNC
N
R
SAD_ADM_INTEREST_SYNC
N
R
SSR_EXTRACUR_ACTVTY_SYNC
N
R
SAD_EXT_ACAD_DATA_SYNC
N
R
SCC_PERSON_SYNC
N
R
PERSON_DISABILITY_SYNC‐HR Owned
No change
R
PERSON_DIVERSITY_SYNC‐HR Owned
No change
R
Applicant
SAD_ADM_APPL_DATA_SYNC
N
R
Application/Recruitment Center
Security
SAD_SCRTY_APPL_CTR_SYNC
N
R
SAD _SCRTY_RECR_CTR_SYNC
N
R
SAD_TEST_SCORES_SYNC
N
R
Test Score Sync
CS to CRM & CRM to CS
Referral Source Table
SAD_RFRL_SRC_SETUP_SYNC
N
R
SAD_RFRL_SRC_SETUP_FULLSYNC
N
F
T189 Application – CRM to SA
CS_T189_ADM_APPL_SYNC
M
R
Topics – CRM to SA
CS_STUDENT_TOPIC_SYNC
M
F in CRM
Mapping BOID & EMPLID
CS_STUDENT_BOID_SYNC
M
R
Prospect
CS_ADM_PRSPCT_DATA_FULLSYNC
M
F (EC)
Test Score Sync
CS_TEST_SCORES_FULLSYNC
M
F (EC)
Legend: N
M
R
F
EC
New EIP
Existing EIP ‐ modified
Real Time Publish
Full Sync Publish
Enterprise Component
Oracle Corporation ‐ Confidential
EIP
Page 2
Campus Solutions CRM for Higher Education Developer's Guide
3 CRM 360 VIEW SERVICES
The CS service that feeds information to the CRM 360 Degree View is based on a Synchronous Request/Response
integration pattern. CRM requests data from a single Aggregation Service in Campus Solutions to reduce integration trips
between CRM and CS applications. The Aggregation service in CS aggregates the output from the CS core service handlers
to feed the Aggregation Response Message to CRM.
Following are the 360 degree Sections for which data is populated from Campus Solutions:
• Constituent Summary
• Checklists/Communications/Comments
• Admissions
• Transfer Credits
• Academics
• Finances
• Financial Aid
• Transcript Request
• Contributor Relations
• Affiliations
The Integration Broker service SCC_CONSTITUENT’s service operation SCC_CONSTITUENT_READ360SUMMARY is exposed
for interaction with CRM, and aggregates the service handlers listed in the Request Handler Overview section in Chapter 5.
A Campus Solutions configuration page has been created to limit the amount of data that is sent to CRM for displaying on
CRM 360 degree view (See the Configuration Page section later in this document). This page can be used to limit the data
pertaining to Campus Community, Financial Aid Years, and Relationships for Contributor Relations data. It is located at
Home > Set Up SACR > System Administration > Configure Integrations.
On the CRM side, it is possible to amend a user’s 360 degree view setup to determine which parts of the 360 degree view
Higher Education Section components they may access. Disabling a component this way removes it from the request
message from CRM to CS. This setup is located in the CRM 9.1 system at Home > Set Up CRM > Common Definitions > 360‐
Degree View > Configure Role.
Common Service Rules:
• Rows are fetched as per service security implementation. If no data is found for the requested EMPLID, a response is
returned with the SCC_AUTH_FLAG value as ‘No Data’. If a user doesn’t have access, a response is returned with the
SCC_AUTH_FLAG value as ‘Secured’. The SCC_AUTH_FLAG is returned as E‐ ‘Error’ if there are any errors in the execution of
the service request.
• Related language processing is performed based on input request LANGUAGE_CD
Campus Solutions CRM for Higher Education Developer's Guide
This service aggregates the output of the core services handlers of CS modules into a single common output to feed the
HE360 degree view. On request from the CRM HE 360 Degree View, this service responds with a message containing the
requested section data filled from the local CS core services.
This Service aggregates data for the following CS sections on the CRM HE 360 Degree View
•
•
•
•
•
•
•
•
•
•
Constituent Summary
3C’s ‐ Interactions
Admissions
Transfer Credits
Academics
Finances
Financial Aid
Transcript Requests
Contributor Relations
Affiliations
Rules:
•
The Aggregation service handler invokes local service handler method calls based on the section flags for CS
modules in the input request message from CRM. It processes each of the section flags. If the flag for a
particular module is set, it invokes a local request for data for the module.
3.2 ADMISSIONS CORE SERVICE
Service: SAD_ADMISSIONS
Service Operation: SAD_READADMISSIONSSUMMARY
Handler Class: SAD_ADMISSIONS: ReadAdmissionsSummary
Purpose:
The service provides high level application information including Application Number and Application Date as well as the
Institution, Career and Program for the requested EMPLID. Multiple rows of data are returned if the student has applicant
records in multiple institutions. The data is used in the HE360 Degree View to resolve queries regarding applications and
application status. Here is the Admissions section of the CRM HE360 Degree view UI impacted by this service:
Rules:
•
•
•
The Service returns the most recent effective dated row and does not include effective date in the output
The service returns ‘DESCR’ fields for the fields to be displayed in the CRM UI.
Multiple rows of Level 1 Scroll (comprising of data from records PS_ADM_APP_DATA and
PS_ADM_APPL_PROG) based on INSTITUTION , APPLICATION_NBR , ACAD_CAREER and ACAD_PROG
Oracle Corporation ‐ Confidential
Page 4
Campus Solutions CRM for Higher Education Developer's Guide
•
Multiple rows of Level 2 scroll (comprising of data from ADM_APPL_PLAN and ADM_APPL_SBPLAN) unique
combinations of ACAD_PLAN and ACAD_SUB_PLAN
3.3 CONTRIBUTOR RELATIONS CORE SERVICE
Service: AV_INVOLVEMENT
Service Operation: AV_INVOLVEMENT_READGIVINGS
Handler Class: AV_INVOLVEMENT:ReadGivingSummary
Purpose:
The Contributor Relation section of 360 Degree View displays the giving details pertaining to a constituent. It also displays
giving details for selected relationships. These details are helpful for the fundraisers to know the donations made by the
constituents and his relatives. Also, the help desk analysts would be more interested in knowing the giving potential of a
constituent before they respond to their inquiries.
A constituent can have relationships with other persons and with organizations. This section will display these relationship
details with their giving information. To ensure that help desk analysts are aware of constituents with a history of giving, an
HTML Alert Popup window is displayed indicating that the constituent or relative of a constituent has a history of giving.
Included in the message are the Constituent’s Total Lifetime Commitment and their relative’s Total Lifetime Commitment
that exceeds a predefined dollar amount. Here is the Contributor Relations section of the CRM HE360 Degree view UI
impacted by this service:
Rules:
•
•
•
•
The following details have to be fetched from CS
o Giving details of the constituent
o Relationship details of the constituent (Person to Person / Person to Org)
o Giving details of the relationships(Person/Org) of the constituent
o Total Year To Date Giving and Total Years Giving
Currency Name
o Obtain the Currency name from AV_INSTALL_INST. BASE_CURRENCY. The giving details information is
stored in AV_CNST_ACC table after converting it to the base currency as defined in AV_INSTALL_INST.
BASE_CURRENCY.
Relationships
o Only Current and Active relationships should be fetched.
o Only those relationships that are defined in the 360 degree configuration page should be considered for
sending across
o Retrieve Relationship details only when the user has security provided for the Institution.
Giving Details
o Obtain Lifetime Commitment details, Lifetime Open Pledges, Lifetime Gift Payments, Lifetime Hard
Credits and calculate Total YTD and Total Years Giving
Oracle Corporation ‐ Confidential
Page 5
Campus Solutions CRM for Higher Education Developer's Guide
•
o Retrieve Giving details only when the user has security provided for the Institution.
Multiple Level 1 rows
o Level 1 can have multiple rows for the constituent who has a history of giving for more than on
Institution.
3.4 STUDENT FINANCIALS CORE SERVICE
Service: SSF_STUDENT_FINANCIALS
Service Operation: SSF_READSTDNTFINANCIALSSUMMARY
Handler Class: SSF_STUDENT_FINANCIALS: ReadFinancialSummary
Purpose:
The service provides high level financials information. Multiple rows of data are returned, based on the business unit
combination. The data is used in the HE360 Degree aggregation service. Here is the Finances section of the CRM HE360
Degree view UI impacted by this service:
Rules:
•
•
•
•
•
•
Level 1 has only one row and Level 2 contains multiple rows of scroll data based on Business Unit
CS SOA Framework Request configuration registration parameters ‐ Service Name: SSF_STUDENT_FINANCIALS
and Service Operation Name : SSF_READSTDNTFINANCIALSSUMMARY
Valid Values for SSF_1098T_STATUS:
P Printed (SF_1098_DTL.SF_TAX_PRINT_STAT.Value = "Y")
T Transmitted (SF_1098_DTL.SF_TAX_TRANS_STAT.Value = "Y" )
These Values only if not Printed or Transmitted:
A Awaiting Consent (SF_1098_INST.SSF_1098_EPRINT.Value = "Y" and not
SSF_1098_AGR_VW.SSF_AGREEMENT_STAT.Value = "1")
C Consented (SF_1098_INST.SSF_1098_EPRINT.Value = "Y" and
SSF_1098_AGR_VW.SSF_AGREEMENT_STAT.Value = "1")
G Generated (SF_1098_INST.SSF_1098_EPRINT.Value not = "Y" )
Valid values for SSF_PMT_PLAN_IND:
S Single (Student in single payment plan)
M Multiple (Student in multiple payment plans)
N None (Student in no payment plans)
SSF_PENDING_AID (Anticipated Aid) is a Y/N field
Institution Set field from the operator defaults table is used to determine which business units will be
processed/returned for the 360 service call. BUSINESS_UNITs that need to be processed will be based on the
INSTITUTION_SET field value of the OPR_DEF_TBL_CS table. This INSTITUTION_SET field is then used to
determine which BUSINESS_UNITs need to be processed using the ISET_BU_DTL table.
CURRENCY_CD is returned at the BUSINESS_UNIT level of the BASE_CURRENCY field in the BUS_UNIT_TBL_SF
setup table.
Oracle Corporation ‐ Confidential
Page 6
Campus Solutions CRM for Higher Education Developer's Guide
3.5 INTERACTIONS (3C’S) CORE SERVICE
Service: SCC_INTERACTIONS
Service Operation: SCC_INTERACTIONS_READCHECKLIST, SCC_INTERACTIONS_READCOMMENTS,
SCC_INTERACTIONS_READCOMMNCTNS
Handler Class: SCC_360: HANDLER: ReadChecklistSummary, ReadCommentsSummary and ReadCommunicationsSummary
Purpose:
The service provides checklists, communications and comments (3c’s) for a request emplid. The data will highlight all
interactions with the EMPLID on the period defined in the services configuration page. Here is the 3C’s section of the CRM
HE360 Degree view UI impacted by this service:
Rules:
•
•
•
The Service returns filtered 3C’s data based on the period entered on the configuration page.
The Interactions service includes three method calls internally (ReadCommunicationSummary,
ReadChecklistSummary and ReadCommentSummary)
CS SOA Framework Request configuration registration parameters ‐ Service Name: SCC_CAMPUS_COMMUNITY
Service Operation (Communications): SCC_ReadCommunicationSummary Service Operation(Comments):
SCC_ReadCommentSummary Service Operation(Checklists): SCC_ReadChecklistSummary
3.6 TRANSFER CREDITS CORE SERVICE
Service: SSR_STUDENT_RECORDS
Service Operation: SSR_READTRANSFERCREDITSUMMARY
Handler Class: SSR_360: ReadTransferCreditSummary
Purpose:
The service provides high level transfer credits summary information such as Course Credit, Test Credit, and Other Credit
information, including the credit’s type source and units transferred for the requested EMPLID. Here is the Transfer Credits
section of the CRM HE360 Degree view UI impacted by this service:
Oracle Corporation ‐ Confidential
Page 7
Campus Solutions CRM for Higher Education Developer's Guide
Rules:
•
•
Multiple rows of Level 1 Scroll based on INSTITUTION, Model Number and Term combination.
CS SOA Framework Request configuration registration parameters ‐ Service Name: SSR_STUDENT_RECORDS
and Service Operation Name : SSR_ReadTransferCreditSummary
3.7 TRANSCRIPT REQUESTS SERVICE
Service: SSR_STUDENT_RECORDS
Service Operation: SSR_READTRANSFERCREDITSUMMARY
Handler Class: SSR_360: ReadTranscriptRequestSummary
Purpose:
The service provides high level transcript request summary information including Transcripts type, reason and status for the
requested emplid. Here is the Transcripts Requests section of the CRM HE360 Degree view UI impacted by this service:
Rules:
•
•
Multiple rows of Level 1 Scroll based on Request Number.
CS SOA Framework Request configuration registration parameters ‐ Service Name: SSR_STUDENT_RECORDS
and Service Operation Name : ReadTranscriptRequestSummary
3.8 FINANCIAL AID CORE SERVICE
Service: SFA_FINANCIAL_AID
Service Operation: SFA_READFINANCIALAIDSUMMARY
Handler Class: SFA_FINANCIAL_AID: HANDLER: ReadAidSummary
Purpose:
The service provides high level financial aid information including financial aid year, application date, status of offer‐
acceptance‐disbursement, Satisfactory Academic Progress status and FAN letter data. Multiple rows of data are returned in
case the student has records in multiple institutions and financial aid year. The data is filtered by the financial aid year setup
defined in the services configuration page.
Here is the Financial Aid section of the CRM HE360 Degree view UI impacted by this service:
Oracle Corporation ‐ Confidential
Page 8
Campus Solutions CRM for Higher Education Developer's Guide
Rules:
•
•
•
Multiple rows of Level 0 Rowset based Institution and Aid Year
The response is returned filtered for the financial aid year setup defined in services configuration page.
CS SOA Framework Request configuration registration parameters ‐ Service Name: SFA_FINANCIAL_AID and
Service Operation Name : SFA_READFINANCIALAIDSUMMARY
3.9 CONSTITUENT SUMMARY CORE SERVICE
Service: SCC_CONSTITUENT
Service Operation: SCC_READPROFILESUMMARY
Handler Class: SCC_360: ReadConstituentSummary
Purpose:
The service provides high level constituent summary such as name, contact information, IDs, service indicators, and the
FERPA indicator. Here is the Constituent profile summary of the CRM HE360 Degree view UI impacted by this service:
Rules:
•
•
•
•
The constituent service returns addresses based on contact method usage in configuration page.
CS SOA Framework Request configuration registration parameters ‐ Service Name:
SCC_CAMPUS_COMMUNITY and Service Operation Name : SCC_ReadConstituentSummary
The following fields have Y/N values: DECEASED, SRVC_IND_NEG, SRVC_IND_POS, FERPA_FLAG indicators and
SCC_AFL_DISPLAY
ADDRESSLONG field returns the concatenated different address fields depending on the country code.
3.10 AFFILIATIONS CORE SERVICE
Service: SCC_CAMPUS_COMMUNITY
Service Operation: SCC_READAFFILIATIONSUMMARY
Handler Class: SCC_360: HANDLER: ReadAffiliationsSummary
Purpose:
The service provides an overview of Affiliations information. The data contains summary of each affiliation like start and
end dates and status.
Here is the Affiliations section of the CRM HE360 Degree view UI impacted by this service:
Oracle Corporation ‐ Confidential
Page 9
Campus Solutions CRM for Higher Education Developer's Guide
Rules:
•
CS SOA Framework Request configuration registration parameters ‐ Service Name:
SCC_CAMPUS_COMMUNITY and Service Operation Name : SCC_ReadAffiliationSummary
3.11 ACADEMICS CORE SERVICE
Service: SSR_STUDENT_RECORDS
Service Operation: SSR_READACADEMICSSUMMARY
Handler Class: SSR_360: ReadCareerSummary
Purpose:
The service provides overview of a student’s academic information. The response contains student’s Career, Program, Plan
and Sub‐Plan as well as their most recent term information. Here is the Academics section of CRM HE360 Degree view UI
impacted by this service:
Rules:
•
•
•
•
•
•
•
•
The Service returns the most recent effective dated row and does not include effective date in the output
Multiple rows of Level 1 Rowset based on Institution, Career, and Primary Program combination.
The Plan and Sub‐Plan Level 2 Rowset has one or more plans that are associated with each primary program.
There can only be one term for each primary program, career, and institution combination.
All the data (with the exception of Cumulative Units) in the Academics scroll area will all come from a view of
ACAD_PROG.
The Plans and Subplans grid is populated from ACAD_PLAN and ACAD_SUBPLAN.
Recent Term data comes from STDNT_CAR_TERM.
The Record STDNT_CAR_TERM references ACAD_PROG. Based on this underlying record relationship, there is
a zero‐to‐many relationship between recent term and academic data. That is, multiple academic programs
within the same institution and academic career can reference the same recent term. Some examples to
illustrate this relationship:
o
o
A student is active in two programs, Fine Arts and Liberal Arts which are both Undergraduate programs. ‐
CS would send 2 rows to populate the Academics scroll area ‐ one for each program. Since both programs
are defined within the same Institution and Academic Career, both programs will reference one and the
same recent term.
A student is pursuing two advanced programs, an MBA defined under the Graduate Career and Law
Degree under the Law Career. CS sends two rows to populate the Academics scroll area ‐ one for each
program with different careers. Recent term data will be sent for each career.
Oracle Corporation ‐ Confidential
Page 10
Campus Solutions CRM for Higher Education Developer's Guide
o
•
•
Incoming freshman has been activated in a program but not yet activated in a term. CS would send one
row to populate the Academics scroll area. No term data can be sent until the student has been term
activated in CS.
Cumulative Units in the Academics section come from STDNT_CAR_TERM and like the other term data in the
example above, this field will not be populated until the student is term activated.
CS SOA Framework Request configuration registration parameters ‐ Service Name: SSR_STUDENT_RECORDS
and Service Operation Name: SSR_ReadAcademicDataSummary
3.12 CONFIGURATION PAGE
New Component: SCC_INTEG_WSC (GBL)
This is a multiple page component, with pages for
•
Campus Community (Define Contact Method Usage and 3C Period)
•
Financial Aid (Define Financial Aid Year Data)
Oracle Corporation ‐ Confidential
Page 11
Campus Solutions CRM for Higher Education Developer's Guide
Purpose: This component will be used to define what kind of CS data should be included in services for display in the CRM
360 degree view. The page will reside in Campus Solutions at Home > Set Up SACR > System Administration > Integrations >
Configure Integrations. This page can be used to define Set Up Data pertaining to Contact Method Usage, 3C, Financial Aid
Year and Contributor Relations person or organization relationships.
Functionality: Upon navigation to the component, the user can enter set up data pertaining to:
• Contact Method Usage: This includes Address, Email and Phone usage. These define the order in which the
system searches for and uses the associated data.
• 3Cs: A large volume of data pertaining to 3C’s may be available. With the set up page, the user can limit the
data that should be sent to the CRM 360 degree view. The user can either include all data or data for the
past few months. By entering a value for months, for example “3”, the user is limiting the 3C data to the past
3 months.
• Financial Aid: This page gives the user an option to select which Financial Aid Years data under an Institution to
send to the CRM 360 degree view.
• Contributor Relations: It is possible that a constituent may have relationships with other persons and
organizations, but we may not want to send all these relationships to the CRM 360 degree view. With the set
up page, we can define which relationships are applicable to be sent across to the CRM 360 degree view.
Only those relationships selected here will be eligible for communication to the CRM 360 degree view.
• Audit History: The user can query the table SCC_WSC_COMMUN to know the last updated date time
(SCC_WSC_COMMUN .SCC_DATETIME_UPD) and last updated user id (SCC_WSC_COMMUN.
SCC_MOD_OPR)
More information on functionality of the Configure Integrations component may be found in the Campus Solutions CRM for
Higher Education PeopleBook.
4 SOURCE DATA ANALYSIS FOR RECRUITMENT SECTION ON CRM
Description
The Recruiting Section displays details of the suspects or prospects with regard to their academic interests. The
recruiters can view the summary of potential suspects or prospects, their academic interests, career, program, plan,
Oracle Corporation ‐ Confidential
Page 12
Campus Solutions CRM for Higher Education Developer's Guide
subplan details, Last School Attended and Graduation Date. The user can also view the Lifecycle Status, and the
Lifecycle Status Date along with other basic recruiting information.
Since the recruitment related data is available in CRM profile tables, the data is fetched from these tables directly
and displayed. The data to these profile tables comes through the CS_ADM_PRSPCT_ADM_FULLSYNC message from
CS.
Following are the Profile Tables in CRM into which the prospect data is populated:
•
•
•
•
•
5 SECURITY
The table below indicates what CS security is required to view the related CS data in the CRM HE360 View.
CRM 360 Section Name
Campus Solutions Security Parameters
3C's – Interactions
Academics
Admissions
Institution, 3C Group Security
Institution, Career, Program, Plan
Institution/Application Centre Security (Similar to "Application Summary"
component)
No row level security (Similar to "View Affiliations" component)
Institution
Institution (Similar to Giving Profile component)
Institution
Student Financials can be secured by Business Unit. Customers have the option
to secure the SF application by Business Unit via User ID / Oprid (should use
SSF_BU_OPRVW), by Business Unit via Permission List (should use
SSF_BU_CLSVW), or not use Business Unit related row level security (should use
SSF_BU_NONVW). The SSF_BU_NONVW should be the "default" security view,
the customer will need to make sure that if they implement row level security
for Business Unit that they update the CS "Request Handlers" page with the
correct security view.
Affiliations
Constituent Summary
Contributor Relations
Financial Aid
Student Finance
Campus Solutions CRM for Higher Education Developer's Guide
CRM 360 Section Name
Campus Solutions Security Parameters
Transfer Credits
No row level security
See the Service Notes in the section directly below for security navigation setup and Appendix IV for examples of security
roles and related access.
5.1 REQUEST HANDLER OVERVIEW
The CS request handlers have a significant impact on the security of many of the 360 degree view Higher Education Section
components as they enable the setting of particular security views. There is one overall, externally available request
handler for the “aggregation service” as shown below; and then each of the components has its own internal request
handler, which is shown in the relevant section below.
Request handlers are defined in Setup SACR > System Administration > Integrations > Request Handlers.
The following table outlines the request handlers needed for the CRM4HE 360 View.
Service
Service Name
Aggregation
NOTE: interacts with
CRM and serves as the
front end to all the
internal services
3C's – Interactions
NOTE: 3Cs 360
security is driven
primarily by the
Campus Solutions 3C
Security Group
assigned to the UserID
in Set Up SACR >
Security > Secure
Student
Administration > 3C
Group Security.
SCC_
CONSTITUENT
Academics
NOTE: Academics
security is controlled
by:
1. Institution
2. Career
3. Program
4. Plan
5. Request handler
SSR_STUDENT_
RECORDS
Oracle Corporation ‐ Confidential
SCC_
INTERACTIONS
Service
Operation
SCC_
CONSTITUENT_
READ360
SUMMARY
Package:
SCC_360
Path: HANDLER
Application Class ID:
ReadChecklistSummary
ReadCommentsSummary
ReadCommunications
Summary
Internal
STDNT_
INS_
SCRTY
Package:
SSR_360
Path: HANDLER
Application Class ID:
ReadCareerSummary
Package:
SCC_CONSTITUENT
Path: HANDLER
Application Class ID:
ReadConstituentSummary
Page 14
Campus Solutions CRM for Higher Education Developer's Guide
Service
Service Name
security view
Admissions
SAD_
ADMISSIONS
NOTE: Admissions
security in the 360
view is determined by
entries in Application
Center Security. Set
up Admissions Center
Security (Set Up SACR
> Security > Secure
Student
Administration > User
ID > Application Center
Security)
Affiliations
SCC_CAMPUS_
COMMUNITY
Supported
Interfaces
Security
View
Application Class
SAD_READ
ADMISSIONS
SUMMARY
Internal
ADM_
MAINT_
SCTY
Package:
SAD_ADMISSIONS
Path: HANDLER
Application Class ID:
ReadAdmissionSummary
SCC_READ
AFFILIATION
SUMMARY
Internal
STDNT_
INS_
SCRTY
Package:
SCC_360
Path: HANDLER
Application Class ID:
ReadAffiliationsSummary
Package:
SCC_360
Path: HANDLER
Application Class ID:
ReadConstituentSummary
Package:
AV_INVOLVEMENT
Path: HANDLER
Application Class ID:
ReadGivingSummary
Constituent Summary
SCC_
CONSTITUENT
SCC_READ
PROFILE
SUMMARY
Internal
STDNT_
INS_
SCRTY
Contributor Relations
NOTE: Contributor
Relations security is
controlled by:
1. CR Academic
Institution Security
(Setup SACR > Security
> Secure Contributor
Relations > Secure
Institution Table)
2. CR Business Unit
security (Setup SACR >
Security > Secure
Contributor Relations
> Secure Business
Unit)
3. The request
handler security view
AV_
INVOLVEMENT
AV_
INVOLVEMENT_
READGIVINGS
Internal
AV_INST_
P_SRCH3
Oracle Corporation ‐ Confidential
Service
Operation
Page 15
Campus Solutions CRM for Higher Education Developer's Guide
Service
Service Name
Financial Aid
NOTE: The security for
the Financial Aid
section is controlled by
Setup SACR > Security
> Secure Student
Administration > User
ID > Academic
Institution Security.
Financial Aid uses all
the levels of security
noted below ‐
institution, campus,
career, program,
depending on user
setup and the area of
Financial Aid. Also,
there is item type
security which is the
same as Student
Financials. Core local
services hard code row
level security via
security views at Main
Menu > Set Up SACR >
Security > Secure
Student
Administration >
UserID > Security
Views.
Transcript Requests
NOTE: Transcript
request security is
controlled by:
1. Institution
2. Transcript Type
(Setup SACR > Security
> Secure Student
Administration > User
ID > Transcript Type
Security)
3. Request handler
security view
SFA_
FINANCIAL_
AID
Oracle Corporation ‐ Confidential
SSR_STUDENT_
RECORDS
Service
Operation
SFA_ READ
FINANCIALAID
SUMMARY
Supported
Interfaces
Internal
Security
View
STUAID_
INS_SCTY
SSR_READ
TRANSCRIPT
REQSTSUMMARY
Internal
SSR_TRQ_
SCRT_VW
Application Class
Package:
SFA_FINANCIAL_AID
Path: HANDLER
Application Class ID:
readAidSummary
Package:
SSR_360
Path: HANDLER
Application Class ID:
ReadTranscriptRequest
Summary
Page 16
Campus Solutions CRM for Higher Education Developer's Guide
Service
Service Name
Transfer Credits
SSR_STUDENT_
RECORDS
Student Finance
NOTE: Student
Financials can be
secured by Business
Unit. This section has
three security views
that reflect how row
level security is
handled in Student
Financials.
The security for the
Finances section is
predominantly
governed by:
1. The security view in
the request handler
“SSF_STUDENT_FINAN
CIALS” in Setup SACR >
System Administration
> Integrations >
Request Handlers
2. Then the selection
of the Business Unit in
Setup SACR > Security
> Secure Student
Financials > User ID >
Business Unit
If no security seems to
be happening with
other settings, amend
the security view to
SFF_BU_OPRVW.
SSF_STUDENT_
FINANCIALS
Service
Operation
SSR_READ
TRANSFERCREDIT
SUMMARY
Supported
Interfaces
Internal
Security
View
None
SSF_READSTDNT
FINANCIALSSUM
MARY
Internal
SSF_BU_
NONVW
(Default)
or
SSF_BU_
OPRVW
Application Class
Package:
SSR_360
Path: HANDLER
Application Class ID:
ReadTransferCredit
Summary
Package:
SSF_STUDENT_FINANCIALS
Path: HANDLER
Application Class ID:
ReadFinancialSummary
(by
Business
Unit via
User ID /
OPRID)
or
SSF_BU_
CLSVW
(by
Business
Unit via
Permissio
n List)
5.2 RECRUITING
Data for the Recruiting section on 360 degree view is sourced from CRM. There is not a separate request handler for this
section of the Higher Education Information grid in the 360 degree view. Consequently, this section is an exception to the
others.
Oracle Corporation ‐ Confidential
Page 17
Campus Solutions CRM for Higher Education Developer's Guide
5.3 HE360 SECURITY MODEL
Security happens at two levels (3rd and 4th pillars).
Security Level 1 : The first level uses framework level security view , which is one security view
(STUAID_INST/CAR/PLAN_SCRTY) here, configurable within the product user interface.
This security check returns a "Yes‐Go ahead"/ Success response if the user has access to one or more rows of the
constituent’s Data. It returns a "No" / "Secured" response if the user doesn’t have access to any of the constituent’s data.
Security Level 2: (4th Pillar): This is a hard‐coded security setting written in service handlers (application classes), which may
use one or more security views and is NOT configurable, in most cases.
Oracle Corporation ‐ Confidential
Page 18
Campus Solutions CRM for Higher Education Developer's Guide
Security level 1 indicates whether it is okay to proceed with the data query for the request (if the result is Yes/ Success ‐ the
user has access to at least one row of the constituent’s data).
Security level 2 is responsible for actually filtering out that one row (or as many rows as the user is allowed to access) and
returns the appropriate data. This is typically achieved by joining security views with data retrieving SQLs so that only
authorized data is returned.
6 CS TEST SCORE POST PROCESS
To Process External Test Score Data:
1.
Load the test score data from a file into a suspense table using the external test score load process.
2.
Review and edit the data that was loaded in suspense pages.
Correct all load errors before moving on to the next step. In the search dialog page of the suspense
component, enter the test ID, Error in the Edit Processing Option field and click the Search button. Go into
each suspense record and correct the errors until every suspense record has a value of Complete (rather than
Error) in the Edit field on the Test Score Suspense Data page.
3.
After all of the load errors are corrected, run the search/match/post process.
This process looks for data in the database (based on search parameters defined on the search/match criteria
pages that can include name, social security number, birth date, and so forth) that matches the data being
posted. For a set of parameters that suggest only a possible match (such as name and gender, for example),
the process will not post the record until a person can manually determine which records are truly duplicates.
There is also a choice to create prospect records and assign 3Cs during the post process and to allow the user
to select where to post the data: Campus Solutions or Enterprise CRM.
4.
Go into each suspense record that did not get posted and check to see if it is truly a duplicate.
In the search dialog page of the suspense component, enter the test ID, Complete in the Edit Process Option
field and Perform in the Search/Match Process Option field. Then click the Search button. The search process
finds only those suspense records that went through the search/match/post process but did not get posted.
The reason the search/match/post process did not post the records is because it found a possible duplicate
record in the database. Once in the component, find the parameters for which the process identified a match,
then use Search Match to look up the bio/demo information that matches the suspense record and decide
whether a person who truly matches the incoming data already exists in the system. Then, specify whether
the search/match/post process should add the bio/demo and test record to your database, update an existing
record, or ignore the suspense record altogether.
5.
Run the search/match/post process again.
The process posts the suspense records that were manually tagged to post. By this time, all of the suspense
records should be posted to the database. When a record posts to the database, the search/match/post
process assigns an ID to the person. To view a bio/demo record that the search/match/post process created,
select Student Recruiting, External Test Score Processing, Add/Update a Person or Student Admissions,
External Test Score Processing, Add/Update a Person. To view a test score record that the search/match/post
process created or updated, select Student Recruiting, External Test Score Processing, Test Results or Student
Admissions, External Test Score Processing, Test Results.
6.
Purge the suspense tables.
Oracle Corporation ‐ Confidential
Page 19
Campus Solutions CRM for Higher Education Developer's Guide
It is recommended that the suspense tables are purged as soon as all of the suspense records have been
posted to the database. This helps avoid confusion the next time data is loaded into the suspense tables.
7.
Review Test Score Candidate Data, if desired.
When external test score loads contain additional information about the student such as academic interests,
extracurricular activities and prior schools attended, the search/match/post process stores the data in the Test
Score Candidate Data component.
The existing application engine program has been modified to:
• Update missing contact and biographical records for existing EMPLIDs in Campus Solutions if the target field is
blank, regardless of the Post To option selected
• Populate the Admit Term based on the new Admit Term Map component if populated for the Test ID entered.
This is done for prospect records if created in Campus Solutions or for records messaged to CRM
• Populate the prospect program, plan and subplan records based on the new Program/Plan/Subplan Map
component if populated for the Test ID entered. This is done for prospect records if created in Campus
Solutions or for records messaged to CRM
• Create a message to be consumed by CRM if the user selects Post to CRM on the Search/Match/Post Test
Scores run control. This message comprises a header record with some of the run control data entered in the
Search/Match/Post Test Scores run control page, records containing biodemo, prospect and test score
information, and further Campus Solutions test‐specific (i.e. test load) suspense records.
• Populate/Update Test Results in Campus Solutions if the user selects Post to CRM on the Search/Match/Post
Test Scores run control and an EMPLID exists in Campus Solutions.
6.1 TEST SCORE CRM MESSAGING
CRM messaging is based on Integration Broker – Message Segmentation technology. Message Segmentation is a
buffering technology used to send heavy payloads to an integrating PeopleSoft node. Segments of a message are
pushed to a database whenever required. Specifically, segments of a message are first buffered in the sender
database while the message is being created and later in the recipient database while the message is being
delivered to the recipient. The receiving system can process the message as a whole or one segment at a time.
This requires an extra setup wherein the Segment Aware option on the Node Definitions page in the PeopleSoft
PIA has to be set for the remote node defined on the local system to handle segmented messages. To configure a
node to handle segmented messages:
1. Select PeopleTools > Integration Broker > Integration Setup > Node Definitions
2. Select the CRM node (PSFT_CR) with which to work and click OK. The Node Definitions page appears
3. Select the Segment Aware box as shown below
4. Click the Save button.
Oracle Corporation ‐ Confidential
Page 20
Campus Solutions CRM for Higher Education Developer's Guide
The data structure of the test score messages is shown below:
Oracle Corporation ‐ Confidential
Page 21
Campus Solutions CRM for Higher Education Developer's Guide
6.2 INSTALLATION SA
The new CRM for Higher Education field should be checked if Enterprise CRM is installed.
6.3 EXTERNAL TEST SCORE MAPPING
The Available for CRM Post checkbox should be selected if the test scores will be posted to Enterprise CRM. For 12 Test IDs
(ACT, AP, CRS, DAT, EOS, GMS, GMT, GRE, LST, SAT, SSS, TFL) Available for CRM Post is delivered as Selected and cannot be
edited.
6.3.1 ADMIT TERM MAP
To populate the most complete prospect and suspect data to either Campus Solutions or CRM, two new mapping tables
have been added. The Admit Term Map (SAD_TERM_MAP mapping table) allows the customer to map a graduation date
range to an admit term.
Oracle Corporation ‐ Confidential
Page 22
Campus Solutions CRM for Higher Education Developer's Guide
Navigation: Setup SACR > Product Related > Recruiting and Admissions > External Test Scores > Create Prospects Setup
This page is used to map the major interest(s) from the suspense record if available to an academic program, plan or
subplan for population on the prospect record in CS or the staging record in CRM. The tests providing a major interest as
part of their layout are: ACT, EOS, GMASS, SAT and SSS.
Upon navigation to the component, the user can add the Institution, Career and Test ID for which they are mapping a
graduation date range to an Admit Term. Upon entering the page, the user will enter a row for each graduation date range
and admit term they are mapping.
The user can, as per current functionality, enter a default admit term on the Search/Match/Post Test Scores run control
page to cater to those cases where the field is blank on the suspense file. They can also leave the default value blank in
which case no admit term will populate during the post process.
6.3.2 PROGRAM/PLAN/SUBPLAN MAP
The Program/Plan/Subplan Map (SAD_INTPROG_MAP mapping table) allows the customer to map a major interest code to
an academic program, academic plan or academic subplan. Only tests where this data is available are eligible for mapping.
The option to enter default values on the Search/Match/Post Test Scores Run control still exists for those test scores where
this data is not provided and for records for an eligible test score where the data is not provided.
Navigation: Setup SACR > Product Related > Recruiting and Admissions > External Test Scores > Create Prospects Setup
This page is used to map the major interest(s) from the suspense record if available to an academic program, plan or
subplan for population on the prospect record in CS or the staging record in CRM. The tests providing a major interest as
part of their layout are: ACT, EOS, GMASS, SAT and SSS.
Upon navigation to the component, the user can add the Test ID for which they are mapping a major interest to a program,
plan or subplan. Upon entering the page, the user will enter a row for each major interest and program, plan or subplan
they are mapping.
The user can, as per current functionality, enter a default program, plan or subplan on the Search/Match/Post Test Scores
run control page to cater to those cases where the field(s) are blank on the suspense file. They can also leave the default
value blank in which case no program, plan or subplan will be created for the suspect/prospect during the post process.
Oracle Corporation ‐ Confidential
Page 23
Campus Solutions CRM for Higher Education Developer's Guide
6.3.3 SEARCH/MATCH POST TEST SCORES RUN CONTROL
The Search/Match/Post Test Scores run control page has been modified to allow the user to select where they want to post
the data: Campus Solutions or CRM. This option appears only for those customers who have CRM installed and where the
Test ID entered is eligible for posting to CRM.
If the Test ID entered on the page is eligible for posting to CRM and the CRM Installed checkbox is set to Y on
INSTALLATION_SA, the Post To radio buttons display. If the user selects Post To Enterprise CRM, the Create Prospects
checkbox is set to Yes and requires the user to enter the required fields for prospect creation. If the user selects Post To
Enterprise CRM, the Assign 3Cs checkbox will not display as this functionality is specific only to posting to Campus Solutions.
The users have the option to create prospects if they select Post to Campus Solutions as the functionality currently exists.
This change allows customers the option of moving the suspect and prospect records over to CRM without creating an
EMPLID in Campus Solutions.
If the user selects Post to Enterprise CRM on SAD_TEST_POST, the application engine will still go through the search/match
process and the Search Edit Option on the suspense record will be set based on the Search/Match Results.
•
If the Search/Match results in a New ID, the application engine program will be modified to not create the
EMPLID and records associated with the EMPLID in Campus Solutions but to create a message with the data
that exists in the suspense records for the Test ID entered that can be consumed by CRM. In addition, the
information on the run control and the data transformed from the various mapping routines will also be
created in a message to be consumed by CRM. The message will include a header record with some run
control parameters, a standardized biodemo and prospect information record, a standardized test score
record along with the test‐specific suspense records. Although not used in the current change, a record
containing name/value pair will also be introduced for any future customization or enhancements. Once the
messages are created, the application engine program should set SAD_TEST_SUSPN.SRCH_PROC_OPTN to
Complete (‘C’) and SAD_TEST_SUSPN.POST_PROC_OPTN to Purge (‘P’).
•
If the Search/Match results in updating an existing ID, the application engine program will be modified to
only create STDNT_TEST and STDNT_TEST_COMP records in Campus Solutions for the EMPLID. The
application engine program will also be modified to create a message with the data that exists in the
Oracle Corporation ‐ Confidential
Page 24
Campus Solutions CRM for Higher Education Developer's Guide
suspense records for the Test ID entered that can be consumed by CRM. In addition, the information on the
run control and the data transformed from the various mapping routines will also be created in a message to
be consumed by CRM. The message will include a header record with some run control parameters, a
standardized biodemo and prospect record, a standardized test score record and the common prospect
records along with the test‐specific suspense records. Although not used in the current change, a record
containing name/value pair will also be introduced for any future customization or enhancements. Once the
messages are created, the application engine program should set SAD_TEST_SUSPN.SRCH_PROC_OPTN to
Complete (‘C’) and SAD_TEST_SUSPN.POST_PROC_OPTN to Purge (‘P’).
•
If the Search/Match results in multiple matches, the user will need to manually determine if the suspense
record matches one of the possible matches found or should be a new EMPLID. This is documented in step
#4 of the current process above. The search/match routine sets SAD_TEST_SUSPN.SRCH_PROC_OPTN to
Perform (‘P’) and leaves SAD_TEST_SUSPN.POST_PROC_OPTN as Awaiting Search (‘A’). The user will
manually update SAD_TEST_SUSPN.SRCH_PROC_OPTN and SAD_TEST_SUSPN.POST_PROC_OPTN. If the
user sets POST_PROC_OPTN to Update Existing ID (‘U’), the user will also indicate the EMPLID to update on
the appropriate suspense record based on the Test ID.
•
Suspense Records that are eligible for messaging to CRM:
o
o
o
o
o
o
o
o
ACT:
AP
CRS
DAT
EOS
GMASS
GMAT
GRE
Users will continue to use the existing External Test Score Purge Process to purge the suspense records once they have
completed posting the data.
Oracle Corporation ‐ Confidential
Page 26
Campus Solutions CRM for Higher Education Developer's Guide
APPENDIX I GLOSSARY
Term
Description
Asynchronous
Message
Enterprise
Integration Point
(EIP)
Asynchronous messages are not real‐time – the message is sent to be picked up at some later time
by the receiving application’s message broker.
Commonly referred to as “EIPs” in CRM4HE, these are asynchronous services that push information
such as changes to the values of fields to other systems as XML messages via Integration Broker.
Please refer to chapter 2 “Enterprise Integration Points” and Appendix II for further information
HTML
Hyper Text Markup Language ‐ designed to display data, with focus on how data looks. HTML is the
universal markup language for the Web. HTML lets you format text, add graphics, create links, input
forms, frames and tables, etc., and save it all in a text file that any browser can read and display.
Basic unit of data sent from one web services agent to another in the context of web services.
Message
Rowset‐based non‐
container message
Rowset based messages are used for publishing hierarchical data, with a parent child relationship.
These messages are built from the PeopleSoft records hierarchically. A container message is
basically comprised of message parts and these message parts can be either rowset messages or non
rowset messages – therefore, a non‐container message lacks component parts and is in one “chunk”
only.
SOA
SOA Framework
Service Oriented Architecture ‐ SOA is an architectural style that supports integration of business
processes as linked services that may be accessed when needed over a network.
Campus Solutions has implemented its own SOA, and this has been referred to as a framework.
Synchronous
Message
Synchronous messages are sent and the receiving application waits for a successful response from
the remote system before it will continue.
Web Service
A web service is a set of related application functions that can be programmatically invoked over the
internet , designed to support interoperable machine‐to‐machine interaction over a network, making
it easy for applications to communicate.
Alternative description: Web Service is an application (function/task) of a system exposed over the
internet for use by external systems. Built on XML and HTTP
eXtensible Markup Language ‐ Designed to structure, store and transport data, with focus on what
data is. XML is independent of hardware, software, and application
XML
Oracle Corporation ‐ Confidential
Page 27
Campus Solutions CRM for Higher Education Developer's Guide
APPENDIX II INTEGRATION BROKER SETUP
Before using CRM4HE, users are strongly advised to familiarize themselves with PeopleSoft Integration Broker, which is
the mechanism that handles the messaging at the core of CRM4HE. Please consult the Integration Broker PeopleBook
(Enterprise PeopleTools 8.49 PeopleBook: PeopleSoft Integration Broker > Integration Scenarios) or undertake a course
with Oracle University to acquire this knowledge. CRM4HE will not work if the integration between the Campus
Solutions and CRM databases is not functioning.
INTEGRATION SET‐UP WITH CRM
CRM4HE aims at providing integration between Campus Solutions and CRM through various Web Services. Please note
that all service operations are delivered inactive. Users will need to activate the required service operation to get
started.
1) Set up the gateway in CS and CRM (PeopleTools > Integration Broker > Gateway)
2) Set up the Node in CS and CRM (PeopleTools > Integration Broker > Integration Setup > Nodes)
3) Node name should be the same in both the publishing and subscribing databases. The CRM Node has to be
marked Segment Aware, since Test scores use message segmentation. See Section 6.1 Test Score CRM Messaging
for more information.
4) Setup single sign‐on in both databases (PeopleTools > Security Objects > Single Sign on). Select both nodes in both
databases.
5) Check domain status is Active. (PeopleTools > Integration Broker > Service Operation Monitor > Domain Status)
6) Verify the required queues are running (PeopleTools > Integration Broker > Service Operation Monitor > Queue
Status). If not, press the Run Button. It may be necessary to change the status of the following Queues to RUN in
case it has not been set: SAD_CRM_SETUP, SAD_CRM_DATA, and PERSON_DATA. (Navigate to PeopleTools >
Integration Broker > Integration Setup > Queues)
7) Activate the Service Operations Required. (PeopleTools > Integration Broker > Integration Setup > Service
Operations > Integration Points)
QUERY ACCESS SERVICE (QAS)
QAS enables external applications to access PeopleSoft Query via several service operations. Depending on the
application, the external application will need to use several service operations in combination. The service
operations for QAS are part of the service QAS_QRY_SERVICE. QAS service operations are grouped into the
following categories to help describe the service operations:
•
•
•
•
The value of QAS is that, rather than having to bring all of the student information to CRM4HE, it enables the
enrollment manager, for example, to dynamically access student data when building an audience for a retention
program. In this way, an institution can set up its definition of an at‐risk student on the Campus Solutions side and
have CRM4HE dynamically access that data when creating the audience. Then the institution can run retention
programs targeted to that audience.
NOTE: To use CRM4HE with QAS requires PeopleTools 8.5. However, using CRM4HE without using QAS does not.
Oracle Corporation ‐ Confidential
Page 28
Campus Solutions CRM for Higher Education Developer's Guide
APPENDIX III DATA PUBLISH ARCHITECTURE
The main objective of the EIPs is to publish data whenever a change happens on the record for the given entities of the
EIPs or when the user requests data. This data can be created/updated/deleted through various channels like
Components, Component interfaces, and Batch Processes.
For publishing data, the EIP project uses CS Service Oriented Architecture (SOA) which is simple, lightweight, flexible,
and configurable. This framework has a set of classes and APIs which may be used either directly or by
extending/implementing one of the framework classes.
MODES OF PUBLISHING
B ATCH P UBLISH
Batch Publish is a process that does Real Time publishing of data that is created/updated/deleted by any batch
process: COBOL, SQR or Application Engine. A more comprehensive explanation of using this mode is provided in
APPENDIX VI Batch Publish EIPs.
The main process, while creating data in an application table, will also write a row of data in the Batch Delay table
which will be used by the batch replay process to fetch the actual data from the application tables and publish.
Many existing processes have already been converted into batch replay processes, and they are listed in the Batch
Process Table shown later in this section. The following steps explain how to implement Batch Replay for a
Process, if a new process is required or an existing one needs modification (not listed in the Table):
•
Create a Job, where the first process will be the actual Batch Process and the second one will be the Batch
Replay process. If the existing process is already part of a job with multiple processes, then the batch
replay process will be added as the last process to that existing job.
•
Modify the first process so that for each record that is created, updated or deleted from the application
table, a row is written into the Batch Delay Table. The Batch Delay Table contains the Application table
Name, Key field values, and an Audit Action field to tell if the data was Added, Updated or Deleted in the
application table.
•
The second process in the job which is the Batch Replay process will query the Batch Delay table for
process instances of all batch processes part of that job to know the records that were updated by the
actual processes. It uses the Key field values stored in the Batch Delay table to fetch the actual data from
the application tables. The message is populated with this data and is published. The data in the Batch
Delay Table is purged after publishing.
•
Users should note that running both the normal and batch replay versions of processes simultaneously
will generate an error. Consequently, it is recommended that a choice is made about which process is
retained in the process group before the implementation of CRM4HE is made available to the users.
Oracle Corporation ‐ Confidential
Page 29
Campus Solutions CRM for Higher Education Developer's Guide
This diagram illustrates the batch processes:
O NLINE P UBLISH
This mode of publishing is used when data is created/updated/deleted from online Components or Component
Interfaces. The process flow diagram below illustrates online publishing.
O NLINE P UBLISH ‐ R EMOTE COBOL INVOCATION
COBOL processes can be invoked from online components as a remote call. A remote call to COBOL happens when
the user clicks a button in the page. This means the message that is published from this component should also
contain the data processed by the COBOL program, apart from the data from the component buffer.
Oracle Corporation ‐ Confidential
Page 30
Campus Solutions CRM for Higher Education Developer's Guide
An example of such a process is found on the Application Program Data page:
`
Clicking the “Create Program” button initiates 2 COBOL processes to calculate any deposit fees due (SFPDEPRC)
and add the application program into Student Records (ADPCPRRC). The logical flow of a remote call is illustrated
below.
User clicks button in
the page
Triggers Field Change Event
‐‐DoSaveNow()
‐‐In Component SavePostChange, Populate the message
Partially with data from component buffer.
‐‐Remote call to COBOL.
‐‐Capture data processed by COBOL from database. Populate
the message with this data.
Field Change Event
F ULL S YNC P UBLISHING
This mode of publishing is used when the user requests a full synchronization of entities between the participating
systems for a given EIP. Generally, a “full sync” is run initially to synchronize the data between CS and CRM and
thereafter the data is usually synchronized through incremental publishing. A notable example of this is the
existing EIP “CS_PERS_DATA_EXTEND_FULLSYNC”, which has been broken down into the new real time EIPs listed
below:
•
•
•
•
•
Campus Solutions CRM for Higher Education Developer's Guide
The existing CS_PERS_DATA_EXTEND_FULLSYNC should be used to seed the data initially, but thereafter the real
time EIPs listed above would keep it synchronized. There are 2 patterns of Full Sync Publishing that could be
chosen depending on the EIP:
•
•
Enterprise Component (EC) Full Sync
SOA Full Sync
E NTERPRISE C OMPONENT (EC) F ULL S YNC
The existing Full Sync Publishing between CS and CRM has already been implemented using the EC Full Sync
Pattern. Following are the EIPs which can be published using EC Full Sync from CS to CRM:
Functionality
Application Center Security
Recruitment Center Security
Prospect
Applicant
Test Score Sync
Person Extension
SOA F ULL S YNC
This pattern of Full Sync publishing will publish data from all the records that appear in the message structure.
Users will have to select the Full Data Publish Mode in the CS Event Registration for a particular EIP to execute a
Full Data Sync.
All the new EIPs specified below will be using this pattern of SOA Full sync publishing:
Functionality
Academic Institution Setup
Academic Campus Setup
Academic Career Setup
Academic Program Setup
Academic Plan Setup
Academic Subplan Setup
Academic Term Setup
External Org
School Type Set up Table
Test Setup
Test Component Setup
Test Security Setup
Admit Type Setup
Academic Institution Security
Academic Career Security
Academic Program Security
Academic Plan Security
Referral Source Table
Student Status Change
Oracle Corporation ‐ Confidential
Campus Solutions CRM for Higher Education Developer's Guide
SOA FULL SYNC SETUP
The following steps are needed to set up SOA full data sync, using SAD_TEST_SCRTY_FULLSYNC as an example:
1. Event Registration (Home > Setup SACR > System Administration > Integrations > Event Registry
2. Click the “Run Now” button on the row with the Integration Mode set as Full Refresh. This will publish all the
data from the underlying message records of the Service Operation in context:
Note: Event Registry configurations for all EIPs are delivered as scripts as part of the Feature Pack 2 project
package.
SOA CONFIGURATION
EVENT REGISTRATION
Navigation: Home > Setup SACR > System Administration > Integrations > Event Register.
It is mandatory that all the EIPs are registered in SOA Event Registry. The SOA Event Registration for CRM4HE is
delivered and configured as shown below to make an Effective Date/Full Sync Replay.
EIP
Student Status Change
Academic Institution Setup
Academic Campus
Academic Career
Academic Program
Academic Plan
Campus Solutions CRM for Higher Education Developer's Guide
EIP
Academic Sub Plan
Academic Term
Ext Org
School Type Setup
Test ID Setup
Test Component Setup
Test Security Setup
Admit Type Setup
Academic Institution
Security
Academic Career Security
Academic Program Security
Academic Plan Security
Application Center Security
Recruitment Center Security
Test Score Sync
Prospect
Applicant
Service Indicator Sync
Admission Interest Sync
Extra Curricular Activity
External Academic Data
Person Sync
Referral Source Table
Mapping BOID & EMPLID
Event Replay Support
Effective Dated. Full Refresh.
Effective Dated.
Effective Dated. Full Refresh.
Effective Dated.
Effective Dated. Full Refresh.
Effective Dated.
Effective Dated. Full Refresh.
Effective Dated.
Effective Dated. Full Refresh.
Effective Dated.
Effective Dated. Full Refresh.
Effective Dated.
Effective Dated. Full Refresh.
NA
Full Refresh.
Effective Dated.
Effective Dated. Full Refresh.
NA
Full Refresh.
NA
Full Refresh.
NA
Full Refresh.
NA
Full Refresh.
NA
NA
NA
NA
Effective Dated.
NA
Effective Dated.
NA
NA
NA
Effective Dated.
Effective Dated. Full Refresh.
NA
EFFDT Filtering
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
Yes
NA
NA
Yes
Yes
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
NA
Yes
NA
Yes
NA
NA
NA
Yes
Yes
NA
For all the above listed EIPs, EventNotification processing is used. No application class needs to be mentioned in the SOA
Event Registration.
6.3.4 EVENT REPLAY MODE
In the Event Register page’s Event Replay Mode group box, for the Integration Mode column, there are 3 integration modes
with the following options:
1. Effective Dated ‐ this mode sends only the current effective dated rows of data in the message. It removes future‐
dated rows from the current message data, and sends the remaining data to the Effective Dated Delay Table
SCC_EFFDELAY, then sends the remainder of the message
2. Full Refresh ‐ this mode completely replaces the old data with all data in the source records, and would normally be
used when the system is being set up for the first time. This mode causes all data from all the tables which are
used in the message structure to be sent
Oracle Corporation ‐ Confidential
Page 34
Campus Solutions CRM for Higher Education Developer's Guide
3. Incremental ‐ This mode is not yet implemented
SOA –NOTIFICATION HANDLER (FOR CRM Æ CS)
Navigation: Home > Setup SACR > System Administration > Integrations > Notification Handlers
The Notification Handler has been delivered configured as shown below:
EIP
BATCH PROCESS TABLE
The following table lists the batch processes that have been converted into batch replay processes as part of CRM4HE. If
you are modifying any of these batch processes, and the modification inserts/updates/deletes data in records listed below,
there would be a CRM4HE EIP impact.
Note: The run control pages for these below mentioned batch processes will display the original process as well as the new
Batch Replay job (original process plus the batch replay process). Selecting the original process would do the usual
processing without data publishing. Selecting the batch replay job would do the usual processing and publish the data.
Batch Process
Campus Solutions CRM for Higher Education Developer's Guide
APPENDIX IV SECURITY ROLE EXAMPLES
Hypothetical
CRM Role / HE
Role
IT HE Agent
Responsibilities
The IT HE agent is responsible for responding
to IT cases.
Note: On Actions Dropdown ‐ only Add Cases
and Add Service Orders should be visible in the
dropdown.
CS – CRM HE
Level One Agent
The HE Agent (Level 1) is a support agent who
is responsible for non‐IT cases and providing
solutions (directly or indirectly) to cases that
are raised by constituent and staff.
CS – CRM HE
Level Two Agent
The HE Agent (Level 2) is a blended agent who
is responsible for responding to both IT and
non‐IT cases and providing solutions (directly
or indirectly) to cases that are raised by
constituents and staff.
This is a super user and has access to all
sections and nodes within 360.
HE Blended
Agent
The HE Blended Agent is responsible for both
IT Cases and Non IT Cases. They do not have
access to financial information.
Oracle Corporation ‐ Confidential
Accessible Sections
within 360 degree
view
Not applicable for this
user
Nodes within 360 degree
view
(IT Tree)
Global Cases
Cases
Assets
Service Orders
Change Requests
Work Orders
Defects
Interactions
(Support Tree)
Global Cases
Cases
Installed Products
Leads
Opportunities
Marketing Activities
Events
Interactions
(Blended Tree)
Global Cases
Cases
Installed Products
Assets
Service Orders
Change Requests
Work Orders
Defects
Leads
Opportunities
Marketing Activities
Events
Interactions
(Blended Tree)
Global Cases
Cases
Installed Products
Assets
Service Orders
Change Requests
Work Orders
Defects
Leads
Opportunities
Page 40
Campus Solutions CRM for Higher Education Developer's Guide
Hypothetical
CRM Role / HE
Role
Responsibilities
Accessible Sections
within 360 degree
view
HE
Administrator
The HE Administrator who is responsible for
HE related setups.
This is a super user and has access to all
sections and nodes within 360.
Profile
Checklist
Communications
Comments
Admissions
Academics
Transfer Credits
Transcript Request
Finances
Financial Aid
Contributor Relations
Affiliations
Recruiting
CS – CRM
Financial Aid
Officer
Financial Aid Officer provides guidance with
grants, loans, bursaries and scholarships to
provide for the payment of tuition and other
expenses incidental to attendance at
institution.
CS – CRM HE
Recruiter
Recruiter answers questions or issues from
constituent.
Profile
Checklist
Communications
Comments
Admissions
Academics
Transfer Credits
Finances
Financial Aid
Affiliations
Profile
Checklist
Communications
Comments
Admissions
Academics
Transfer Credits
Financial Aid
Contributor Relations
Affiliations
Recruiting
CS – CRM
Fundraiser
Fundraiser who solicits financial contributions
from constituents (usually alumni) for the
institution.
Nodes within 360 degree
view
Marketing Activities
Events/Interactions
(Blended Tree)
Global Cases
Cases
Installed Products
Assets
Service Orders
Change Requests
Work Orders
Defects
Leads
Opportunities
Marketing Activities
Events
Interactions
(Support Tree)
Global Cases
Cases
Installed Products
Leads
Opportunities
Marketing Activities
Events
Interactions
(Support Tree)
Global Cases
Cases
Installed Products
Leads
Opportunities
Marketing Activities
Events
Interactions
(HE Recruiter can see Leads
and Opportunities assigned
to him only)
(Support Tree)
Global Cases
Cases
Installed Products
Leads
Opportunities
Marketing Activities
Events
Interactions
Page 41
Campus Solutions CRM for Higher Education Developer's Guide
Hypothetical
CRM Role / HE
Role
Advisor,
Student,
Instructor
HE Student
HE Faculty
Member
HE Admin for all
of CRM HE
Responsibilities
Student accesses the HE Self Service
application to log cases, view cases and search
for solutions and FAQs
Student accesses the HE Self Service
application to log cases, view cases and search
for solutions and FAQs
Faculty Member or Staff accesses the HE Self
Service application to log cases, view cases
and search for solutions and FAQs
This role would be able to access setup
components and transactional pages
Nodes within 360 degree
Accessible Sections
view
within 360 degree
view
Only
self
service N/A
access. Does not access
360 degree view
Only
self
service N/A
access. Does not access
360 degree view
Only
self
service N/A
access. Does not access
360 degree view
Profile
Checklist
Communications
Comments
Admissions
Academics
Transfer Credits
Transcript Request
Finances
Financial Aid
Contributor Relations
Affiliations
Recruiting
(Blended Tree)
Global Cases
Cases
Installed Products
Assets
Service Orders
Change Requests
Work Orders
Defects
Leads
Opportunities
Marketing Activities
Events
Interactions
Oracle Corporation ‐ Confidential
Page 42
Campus Solutions CRM for Higher Education Developer's Guide
APPENDIX V TROUBLESHOOTING TIPS
Common Error, Exceptions and their Resolutions
1.
Configuration error:
Sections impacted: Checklists, Communications, Comments, Financial Aid, and Contributor Relations.
Some sections displayed in the 360 degree view need configuration defined in the Configure Integrations page to work, in
absence of a configuration they will throw a defined exception on the UI “The Configure Integration Filters have not been
defined in Campus Solutions.”
Define the configuration for these sections as covered in Section 3.12 Configuration Page.
2. Institution Set Setup Error
Sections Impacted: Finances
The Finances section requires an Institution Set to be mapped to the current user. In the absence of this mapping , a
defined exception is thrown: “Unable to determine the Business Units as Institution Set field has not been setup for OPRID:
'XYZ"”.
3.
Generic Section Error
Sections Impacted: Any
In case of a generic SQL/PeopleCode error in a section, all other working sections are fetched and the particular section
display’s the summary of the error as shown below
Enable and View the CS SOA Framework log, to analyze the point and cause of error.
Oracle Corporation ‐ Confidential
Page 43
Campus Solutions CRM for Higher Education Developer's Guide
APPENDIX VI Batch Publish EIPs
When viewing a Process Scheduler Request page, many processes will now have two versions, as shown below:
Drilling down on the job reveals it includes the original process plus another “batch replay” process:
All processes impacted by CRM4HE ‐ EIP's will have this publish job in addition to the existing process. This is referred to as
the “batch delay model”. Batch processes may update more than one row at a time and could process a large number of
rows. Hence, instead of sending one XML message per row, one consolidated XML message is created for all rows impacted
by the batch process and sent to CRM, which improves performance.
The Batch Publish mode is used when data is created, updated or deleted through batch processes like Application Engine,
SQR or COBOL programs. This contrasts with the online mode of publishing, which is used when data is created, updated or
deleted from online Components or Component Interfaces, such as a page in the CS application. It does real time
publishing of data that is created, updated or deleted by any batch process‐Cobol, SQR or Application Engine.
The main process will, while creating data in an application table, also write a row of data in the Batch Delay table which
will be used by the Batch Replay process to fetch the actual data from the application tables and publish them in an XML
message.
Another important distinction between the ordinary process and the batch replay process is how they handle EIPs. In the
example shown above, the Application Delete process ADAPPDEL only deletes the applications and inserts rows into the
batch delay table if CRM4HE is enabled whereas the EIPAPDEL job runs the ADAPPDEL process and also publishes EIPs as
part of the second process in the job.
EIP's synchronize certain setup and transactional entities with CRM, and there are two distinct entry points for this data:
• Online UI
• Batch Processes
Triggering EIP's from the online UI is straight forward, but batch processes are comprised of online objects (Application
Engines), code line objects (SQR's, COBOLs) and integration PeopleCode which cannot be used in code line objects. To
streamline the EIP triggers across all batch processes, the SOA Framework's Batch Delay Model is used. Whenever an
Oracle Corporation ‐ Confidential
Page 44
Campus Solutions CRM for Higher Education Developer's Guide
Add/Update/Delete operation is performed on these shared entities, an entry is made in the batch replay table. It stores
enough information to construct an XML message (like process instance, record names, key values and audit action). The
batch delay process is coupled with this impacted process as a job, which picks up the rows in batch delay table and forms
the XML message for transmission to CRM. The batch delay table holds these rows for the batch delay process to pick up,
and then they are purged.