PeopleSoft
Implementation
Duration
It is crucial to supply all necessary integration details as soon as possible to provide the best possible service and the fastest implementation time. The document section “Checklist” lists all the required information ProcessMaker needs to ensure a quick implementation and go-live.
The typical variation time varies by installed solutions (TCE for Prospects and TCE for Applicants), the integration method, and the optional SSO setup.
The initial setup and rollout can be as quick as 14 days. However, most implementations range from 1 to 2 months, with some slightly exceeding that based on the availability of the customer resources and ability to collaborate timely.
Timeline: TCE for Prospects
Timeline: TCE for Applicants
Prerequisites and Required Information
ProcessMaker TCE
To identify required accounts and API keys, please refer to the relevant section below describing Option A and Option B in more detail. Additionally, the checklist appended at the end of this document will briefly list all information required by ProcessMaker to ensure a speedy rollout.
Optional Components
Single Sign-On (SSO) in ProcessMaker allows users to log in through a centralized identity provider rather than maintaining separate credentials for ProcessMaker itself. This streamlines access to ProcessMaker’s workflow and process management features while enhancing security and user convenience. ProcessMaker supports integrations with various SSO providers—including Microsoft (Azure AD), Google, Okta, and other SAML-compatible services—using widely adopted protocols like OAuth and SAML. With these integrations, organizations can unify authentication management and leverage existing identity infrastructures without disrupting users’ login experiences.
Security & Compliance
Visit our Security Trust Center: https://www.processmaker.com/security-statement/ — Your assurance of our unwavering commitment to providing a secure and reliable platform. Trusted by 3 million users and customers worldwide, at ProcessMaker, we prioritize transparency and aim to empower our customers with the information they need to trust in the security and resilience of our services. Explore the Trust Center to gain insights into the safeguards we have in place to protect your data and ensure uninterrupted business operations. Your peace of mind is our top priority.
Compliance Certifications
Other Relevant Certifications
Higher Education Community Vendor Assessment Toolkit (HECVAT) — ProcessMaker has completed a HECVAT self-assessment for ProcessMaker’s BPM Platform product and the TCE solution built upon this platform. These assessments detail our compliance with industry standards and the security protocols built into our infrastructure and services.
Family Educational Rights and Privacy Act (FERPA) — ProcessMaker is dedicated to helping our customers meet their obligations under the FERPA. Through robust security and privacy measures, our platform ensures that student records remain protected and can only be accessed by authorized personnel. To learn more about FERPA requirements, please visit the U.S. Department of Education’s website.
California Consumer Privacy Act (CCPA) — ProcessMaker is fully committed to helping our customers fulfill their obligations under these data regulations by providing convenient tools and integrating strong privacy and security safeguards into our platform and agreements. To learn more about your responsibilities as a business under the CCPA, you can visit the California Office of the Attorney General’s website.
General Data Protection Regulation (GDPR)* — ProcessMaker is committed to complying with the General Data Protection Regulation (GDPR), a new EU data privacy regulation effective May 25, 2018. The regulation gives EU citizens more control over their personal data and unifies several existing privacy and security laws under one comprehensive law. * Relevant for ProcessMaker’s customers in the European Union (EU).
Student Information System (SIS) Integration
Integration via PeopleSoft Custom API
Oracle PeopleSoft provides the ability to define custom APIs and test and expose these via the Oracle PeopleSoft Integration Broker. These APIs allow external systems to communicate effectively with PeopleSoft, promoting efficient data exchange and enhancements in functionality.
This section will give a thorough overview of all the APIs used within the TCE solution process, outlining their purposes, functions, and contributions to the overall system integration.
Authentication
Oracle PeopleSoft custom APIs support Basic HTTP Authentication. This means a username and password have to be assigned when setting up the custom API. The username and password, along with the REST API base URL have to be shared with the integrating party (here, ProcessMaker TCE).
Server URL
The API base URL
API Username
The username allowed to access the custom-configured REST API
API Password
The Password for the assigned API user
Required APIs
This section lists all APIs utilized by ProcessMaker’s TCE solution. Please confirm that the API Token provides access to all the API endpoints below.
All API endpoints listed below provide the expected endpoint address as required by the ProcessMaker TCE solution. Oracle PeopleSoft’s custom API feature allows you to specify the endpoint URL freely. It is crucial that you follow the expected endpoint names listed below.
Student Management — Get Student by ID
Expected Endpoint
/api/students/{studentId}
Endpoint Example
/api/students/8271
Request Type
GET
Content-Type
application/json
Accept
application/json
Purpose
Retrieves the student data for a given student ID.
Request Parameters
{studentId}
Mandatory
The student’s PeopleSoft ID
Reply Parameters
first_name
Mandatory
The student’s first name
last_name
Mandatory
The student’s last name
Mandatory
The student’s email address
type
Optional
The student type (e.g., Freshman)
admin_period
Optional
The administrative period (e.g., Summer 2022)
Student Management — Get Student by Name/Email
Expected Endpoint
/api/students?first_name={first_name}&last_name={last_name}&email={email}
Endpoint Example
/api/students?last_name=Doe
Request Type
GET
Content-Type
application/json
Accept
application/json
Purpose
Retrieves the student data for a given student's name or email. At least one of the otherwise optional input parameters is mandatory.
Request Parameters
first_name
Optional
The student’s first name
last_name
Optional
The student’s last name
Optional
The student’s last name
Reply Parameters
first_name
Mandatory
The student’s first name
last_name
Mandatory
The student’s last name
Mandatory
The student’s email address
type
Optional
The student type (e.g., Freshman)
admin_period
Optional
The administrative period (e.g., Summer 2022)
Course Equivalency — Get Equivalency
Expected Endpoint
/api/course-equivalency?course={course}&institution={institution}
Endpoint Example
/api/course-equivalency?course=MAT-101&institution=918524
Request Type
GET
Content-Type
application/json
Accept
application/json
Purpose
Retrieves the course equivalency for a given course and external institution. This API enables the successful mapping of courses of external institutions to ensure accurate credit transfer.
Request Parameters
course
Mandatory
The course name
institution
Mandatory
The external institution
Reply Parameters
institution_id
Mandatory
The student’s first name
student_id
Mandatory
The student’s last name
courses
Mandatory
The student’s email address
courses. admin_period
Mandatory
The administrative period (e.g., Fall 2024)
courses.
subject
Mandatory
The subject (e.g. MAT-101)
courses.
credits
Mandatory
The amount of credits
courses.
grade
Mandatory
The grade (e.g., A, C)
Checklist
The following checklist includes all the information required and actions to be taken to set up the ProcessMaker TCE/Oracle PeopleSoft integration.
Oracle PeopleSoft with Custom API
SSO (optional)
The required SSO parameters depend highly on the single sign-on provider used. Please refer to the ProcessMaker online documentation for SSO at https://docs.processmaker.com/docs/sso-settings.
The online documentation contains a section for all relevant services:
Last updated