Overview
Prospect Premium extends the Prospect workflow by adding AI-powered program recommendations and transfer credit evaluation capabilities. Before deploying Prospect Premium:
Prospect Standard must already be configured
Smart Extract must be installed and configured
Prospect Premium relies on these components to process transcript information and generate program recommendations.
The Prospect workflow can be initiated through a Web Entry link. Students can either:
Upload an academic transcript in PDF format.
Enter transcript and course information manually.
Prospect Standard processes course information using the Review Matches logic, while Prospect Premium adds the recommendation engine and program catalog required for program recommendations.
Prerequisites
Verify that the following components are installed before deployment:
Component | Required Version |
|---|---|
ProcessMaker Platform | 2026.15.4 |
package-plg | v1.8.5 |
PMAI Microservice | v2026.14.2.50 |
package-smart-extract | v1.0.1 |
connector-send-email | Installed |
package-files | Installed |
Deployment Sequence
Complete the deployment in the following order:
Step 1: Import the Prospect Bundle
Use DevLink to import the required Prospect assets from the source environment to the target environment.
Source Environment
Create a bundle containing the required Prospect assets.
Include the following assets:
Prospect process
Prospect Dashboard screen
Publish the bundle version.
Target Environment
Create a DevLink connection.
Download the bundle from the source environment.
Complete any additional environment-specific configuration required after the import.
Step 2: Import Prospect Collections
Import the following Prospect-specific collections:
Collection | Purpose |
|---|---|
APP - APV1 - Coll- Grade Validation-Prospect | Stores grade validation rules for Prospect |
APP - APV3 - Coll-Configuration-Prospect | Stores Prospect configuration and validation rules |
Note: Prospect may use validation rules that differ from those used by College. These collections should contain the generic validation and configuration rules intended specifically for Prospect processes.
Step 3: Configure Prospect Standard
Configure Environment Variables
Add the following variables to the .env file:
ENABLE_PROSPECT_CLIENT=true
PROSPECT_TYPE=basic_integratedVariable | Description |
|---|---|
ENABLE_PROSPECT_CLIENT | Enables the Prospect functionality. |
PROSPECT_TYPE | Defines the Prospect deployment mode. |
Supported values for PROSPECT_TYPE include:
basic_integratedbasic_non_integrated
Basic Integrated Processing
In Basic Integrated mode, users can upload transcripts as PDF files or enter course information manually.
During processing:
The system retrieves courses associated with the selected institution.
Course information is mapped to identify exact matches.
Grade and credit validation rules are applied using the Prospect collections.
Courses that meet all validation requirements are marked as TRANSFERABLE.
Courses that require additional review are marked as NEEDS ASSESSMENT.
Configure Email Notifications
The Prospect process includes two Send Email connector nodes:
Student notification email
TCO notification email
Prerequisite: An SMTP email server must be configured in ProcessMaker Administration before enabling email notifications.
Student Notification
Field | Configuration |
|---|---|
To |
|
Email Server | Select the configured email server |
Subject |
|
Body | Prospect Transfer Evaluation Report Email screen |
The student email address is required. Mustache syntax can be used to populate values dynamically from the request data.
TCO Notification
Field | Configuration |
|---|---|
To | Designated TCO email address |
Email Server | Select the configured email server |
Subject |
|
Body | Prospect Transfer Evaluation Report Email TCO screen |
Because Prospect is launched through a Web Entry, the request data contains information provided during process execution. For this reason, the TCO email connector uses a predefined email address.
Step 4: Configure Smart Extract
Configure Smart Extract Settings
Configure Smart Extract through the ProcessMaker Administration interface using the following values:
SMART_EXTRACT_REQUEST_TIMEOUT=500
SMART_EXTRACT_API_HOST=extract-api.processmaker.net
SMART_EXTRACT_HITL_ENABLED=false
SMART_EXTRACT_CLIENT_ID=<provided value>
SMART_EXTRACT_CLIENT_SECRET=<provided value>The Client ID and Client Secret are environment-specific credentials and must be provided by the deployment or CloudOps team. Do not use sample or hardcoded credentials.
Configure the Process
Open the Prospect process in Modeler.
Configure the Smart Extract block using the transcript file variable.
Select College as the model type.
Select the appropriate published model.
Configure the required validation.
Enable or disable HITL based on your deployment requirements.
Use the College model alias identified in the Smart Extract deployment documentation. The alias should reference the latest published College model available for deployment.
Create the Empty Rules Validation
Create the following validation configuration in Admin > Smart Extract:
Setting | Value |
|---|---|
Validation Name | empty_rules |
Model Type | College |
Model | Applicable College-1.x.x published model |
The empty_rules validation satisfies the required validation setting when HITL is not used in Prospect workflows.
Step 5: Configure Prospect Premium
After Prospect Standard and Smart Extract are fully configured, complete the Prospect Premium configuration.
Configure Environment Variables
Add the following variables to the .env file:
ENABLE_PROSPECT_PREMIUM=true
PACKAGE_AI_RAG_BULK_UPLOAD_CONCURRENCY=5
PROSPECT_PREMIUM_RECOMMENDED_PROGRAMS_LIMIT=6
PROSPECT_PREMIUM_MAX_SELECTED_PROGRAMS=6Variable | Description |
|---|---|
ENABLE_PROSPECT_PREMIUM | Enables Prospect Premium functionality |
PACKAGE_AI_RAG_BULK_UPLOAD_CONCURRENCY | Defines the number of files processed simultaneously during catalog uploads |
PROSPECT_PREMIUM_RECOMMENDED_PROGRAMS_LIMIT | Sets the maximum number of programs displayed in Recommended for You |
PROSPECT_PREMIUM_MAX_SELECTED_PROGRAMS | Sets the maximum number of programs users can select |
Step 6: Upload the Programs Catalog
Prospect Premium requires a program catalog to identify available programs and generate recommendations.
To upload a catalog:
Go to Admin.
Select PLG Modules Package.
Select Prospect Premium Programs.
Upload the approved program catalog file.
Validate the Deployment
Before releasing Prospect Premium, verify the following:
Software and Package Validation
ProcessMaker is running version 2026.15.4.
package-plg version 1.8.5 is installed.
PMAI microservice version 2026.14.2.50 is installed.
package-smart-extract version 1.0.1 is installed.
connector-send-email is installed.
package-files is installed.
Configuration Validation
SMTP email services are configured.
Prospect collections have been imported.
ENABLE_PROSPECT_CLIENT=trueis configured.PROSPECT_TYPEis configured correctly.Smart Extract is configured.
HITL is disabled when required.
The appropriate College model is configured.
The
empty_rulesvalidation exists and is assigned.ENABLE_PROSPECT_PREMIUM=trueis configured.Recommendation limits are configured.
Program selection limits are configured.
The program catalog has been uploaded.
Functional Validation
The process is published.
The workflow launches successfully from a Web Entry.
Transcript processing completes successfully.
Program recommendations are displayed correctly.
Student notifications are sent successfully.
TCO notifications are sent successfully.
Next Steps
After deployment is complete, perform an end-to-end validation of the workflow:
Launch the Prospect process using a Web Entry link.
Upload a transcript PDF.
Verify Smart Extract processing.
Review transfer credit evaluation results.
Confirm that recommendations appear in the Recommended for You section.
Verify that student and TCO email notifications are delivered successfully.
For more information about the end-to-end validation, see Prospect Premium Workflow.