EDOs & APIs
Schedule and Process
The SIS EDOs and APIs will be released on the dates listed below. Milestones include when the EDO is available for review and comment on bMeta and when the API will in API Central UAT for testing.
The last date listed is when the Production version of the API will be available in API Central Production serving Production data. Check out API Central for access and information.
Existing applications that send or receive student data will need to be changed to integrate with the new SIS. The SIS Integration team will help application owners and developers understand and prepare for the way data formats, integration access, and security enforcement will change. Here are the primary issues you need to know about.
The SIS Replacement project provides campus with an important opportunity to improve student, faculty, and staff experience by redesigning the ways data is shared. An important step towards a more modern integrations environment is to decouple the data used within any application from that exchanged across the campus. This can be done by introducing a standard data format for each information entity, referred to as an “Enterprise Data Object” or “EDO.” Integrations with core SIS systems will rely on these EDOs as intermediary data formats.
Applications that interact with SIS will be required to use the the Integration Hub, a collection of services provided by IST-API’s Enterprise Integration Services, as the intermediary for all integrations with core SIS systems. The Integration Hub provides management, transformation, and security layers to each integration. The centralization of this functionality reduces the duplicative workload of every application and integration developer and makes every integration more robust.
Both coarse and fine-grained authorization of systems to access integrated data will be maintained and enforced within the Integration Hub. Authentication of the calling service will be handled by the API Management layer. Authorization will permit access to the content of the EDOs, with row and column filtering based on roles assigned to integrating systems, or even their attributes (such as college or major).
How to Get Ready
The SIS Integration team will be working with campus application owners and developers to identify and build necessary integrations. This work will proceed based on the scheduled launch dates of the several modules of PeopleSoft Campus Solutions. Here are some keys things you can do now.
- Gain a basic understanding of web services.
- Begin to identify the data you will need to send to or receive from SIS.
- Review "What's Changing" to understand what changes you will need to make to your application to be compatible with the new methods.
- Start to identify and catalog any downstream applications that are dependent on yours, since you will be responsible for making sure they will continue to work as expected.
Each week an email goes out to the sis-integrations-tech-announce email list to describe upcoming events and activities. Here are copies of what has gone out to date. Contact email@example.com if you would like to be added to this email list.
- October 20, 2016: Integration Announcement
- October 13, 2016: Integration Announcement
- October 6, 2016: Integration Announcement
- September 29, 2016: Integration Announcement
- September 22, 2016: Integration Announcement
- September 15, 2016: Integration Announcement
- September 8, 2016: Integration Announcement
- September 1, 2016: Integration Announcement
- August 25, 2016: Integration Announcement
- August 18, 2016: Integration Announcement
- August 11, 2016: Integration Announcement
- August 4, 2016: Integration Announcement
- July 28, 2016: Integration Announcement
- July 21, 2016: Integration Announcement
- July 14, 2016: Integration Announcement
- July 6, 2016: Integration Announcement
- June 30, 2016: Integration Announcement
- June 23, 2016: Integration Announcement
- June 16, 2016: Integration Announcement
- June 9, 2016: Integration Announcement
- June 2, 2016: Integration Announcement
- May 26, 2016: Integration Announcement
- May 19, 2016: Integration Announcement
- May 12, 2016: Integration Announcement
- May 5, 2016: Integration Announcement
- April 21, 2016: Integration Announcement
- April 14, 2016: Integration Announcement
- April 7, 2106: Integration Announcement
- March 31, 2016: Integration Announcement
- March 24, 2016: Integration Announcement
- March 17, 2016: Integration Announcement
- March 10, 2016: Integration Announcement
- March 4, 2016: Integration Announcement
- February 25, 2016: Integration Announcement
- February 4, 2016: Integration Announcement
The first major EDOs are for student and registration and are now available on bMeta. Future EDOs are scheduled for release by Go Live. We need your feedback to ensure we will deliver the data you need for your application, so please review them and comment! Each EDO represents the data payload you can expect to consume. Once that is "frozen", the API will be drafted and made available for review and comment on API Central. The API design will likewise be "frozen" and form the contract from which both server and client code can be developed in parallel. These dates are also listed below.
Files used for integration will be based on the EDO format. If your application cannot use an API to consume or deliver data and you need to work with files, you will still need to review the EDOs to understand how to refactor your file-based processes.
The SIS Integration team will be available each Friday afternoon from 1-3 p.m. beginning January 8th, to help the campus development community with the SIS APIs and views. We welcome your questions, so give us a call.
Blue Jeans Access Information
- Call in number: 1.888.240.2560 (US Toll Free)
- meeting ID: 113695594 (#)
- 9/29/15 API design drafts for the new SIS Integrations: "Student" and "Registration" - sent to Campus Application Developers and Technical Contacts
- 9/3/15 Student Data from the new SIS Integrations: "Student" and "Registration" - sent to Campus Application Developers and Technical Contacts
- 6/23/15 Questionnaire Reminder - sent to those who had not yet responded to the questionnaire
- 6/11/15 Application Technical Questionnaire - sent to identified contacts with link to technical questionnaire
- 5/13/15 Contact Verification - sent to identified applications integrating with SIS
- 4/28/15 Application Integration with SIS Project - sent to all campus staff with IT position
- 4/10/15 SIS Project Outreach - sent to Deans and Directors
If you have a question or concern, contact us at firstname.lastname@example.org.
SIS Integrations FAQ
Q: I understand the student ID is changing from 8 digits to 10 digits. What if my system cannot handle that change?
The 10-digit student ID will be of the form 303#######. The right-hand eight digits (3#######) will not overlap with any previously used student IDs for at least 4 years and therefore can be used in local systems as an interim fix. This 8-digit version of the student ID will be present on Cal 1 Card Barcodes and mag stripes, while the full 10-digit version will be printed on the Cal 1 Card. If your local system stores only the 8-digit version, you'll need to prepend "30" to any student ID that begins with "3" when sending it as a parameter to SIS APIs, and strips the left-hand two characters of any 10-digit student-id found when parsing the payloads returned.
Q: How do we use the new term code?
Campus Solutions uses a four-digit number to represent a Term ID/Term Code. For SIS, the first three digits of the Term ID are taken from the first, third and fourth digits of the year, followed by one digit representing the Term. Term values are: 8 = Fall, 2 = Spring, 5 = Summer. For example, for the Fall 2016 term, drop the "0" from the year to get "216" and append an "8" for fall to get "2168."
Q: How can I see the registration status?
Reg Status Code has been used for many different kinds of information that are now represented as individual data elements. For example "new" or "continuing" is now a boolean called “new”.
Q: How are Majors and Colleges represented now?
Majors, Minors and Emphases are now called Plans (and SubPlans) and the meaning of “College” or “School” has been split between its Academic Policy called a "Program" and its administrative functions called an “Organization".
Q: How has the U/G flag and Role code changed?
This information is now represented as Academic Career and Affiliation. Academic Career will have values such as "GRAD", "HAAS", and "UGRD". Affiliations will have values such as: Applicant-Admitted, Student-Matriculated, Student-Registered, etc. (Note: these are examples and may not represent final values as implemented in SIS bMeta).
For more detail on data changes view the SIS Data Changes Table.