Experience Ethos Examples

1. Account Detail
2. Account Detail Data Connect
3. API Dashboard
4. Emergency Contacts
5. Instructor Classes Lambda
6. Leave Balance
7. Leave Balance Data Connect
8. No Code Data Template Cards
9. Today Classes GraphQL Proxy
10. Today Classes Lambda
11. Today Classes Node

Extension Compatibility Baseline

For extension projects in this repository, use the following baseline:

• Node.js 22 (nvm use in each */extension directory)
• React 19
• @ellucian/experience-extension SDK 8

Account Details Example

This example includes a card and page that show the current user their account details and balance. There are two npm projects in this example, an extension, and a microservice. The data for the card and page are acquired through the BP API (Banner Business Process API) through Ethos Integration. Additional data and behavior could include using a Pay Now feature that integrates with your payment provider.

This example is detailed here: account-details

<br/>

<br/>

Account Details Data Connect Example

This example includes a card and page that show the current user their account details and balance. There are two directories in this example, an extension, and dataconnect. The data for the card and page are acquired using Data Connect's Serverless API. The Data Connect Serverless API pipeline calls a BP API (Banner Business Process API) through Ethos Integration. Additional data and behavior could include using a Pay Now feature that integrates with your payment provider.

Note: Using Data Connect Serverless API allows the extension code in the browser to directly make the API call to Ethos without the need for a microservice. The browser user's identity is used to restrict the execution of the DC pipeline API through Data Connect permissions. The API Key used in the pipeline is configured in the card server configuration to protect it from the browser.

This example is detailed here: account-details-dataconnect

<br/>

<br/>

API Dashboard Example

This example includes a card that can be used to observe the other examples of API requests. This simple card is to allow you to do simple comparisons of the various examples by capturing API request times.

This example is detailed here: api-dashboard

<br/>

<br/>

Emergency Contacts Example

This example extension includes a card that shows the current user's emergency contacts and allows them to add, edit or remove emergency contacts and the several Data Connect Serverless API pipelines.

This example is detailed here: emergency-contacts

<br/>

<br/>

Instructor Classes Lambda Example

This example includes a card that shows an instructor's classes. There are two npm projects in this example, an extension, and a microservice. The data for the card is acquired through the Ethos GraphQL utilizing the same resources as the Today Classes examples.

This example is detailed here: instructor-classes-lambda

<br/>

<br/>

Leave Balance Example

This example includes a card and page that show the current user, an employee their leave balance. There are two npm projects in this example, an extension, and a microservice. The data for the card and page are acquired through the BP API (Banner Business Process API) through Ethos Integration.

This example is detailed here: leave-balance

<br/>

<br/>

Leave Balance Data Connect Example

This example includes a card and page that show the current user, an employee their leave balance. There are two directories in this example, an extension, and dataconnect. The data for the card and page are acquired using Data Connect's Serverless API. The Data Connect Serverless API pipeline calls a BP API (Banner Business Process API) through Ethos Integration.

Note: Using Data Connect Serverless API allows the extension code in the browser to directly make the API call to Ethos without the need for a microservice. The browser user's identity is used to restrict the execution of the DC pipeline API through Data Connect permissions. The API Key used in the pipeline is configured in the card server configuration to protect it from the browser.

This example is detailed here: leave-balance-dataconnect

<br/>

<br/>

No Card Data Template Cards Example

This example includes the Data Connect pipelines and the instructions to create two No Code Data Template cards. This includes a Big Number card to show the students cumulative GPA and a Progress card to show the number of enrollments in a term as a progress towards a goal.

Note: Using Data Connect Serverless APIs allows the no code cards in Experience directly make the API call to Ethos without the need for a microservice. The browser user's identity is used to restrict the execution of the DC pipeline API through Data Connect permissions. The API Key used in the pipeline is configured in the card server configuration to protect it from the browser.

This example is detailed here: no-card-data-template-cards

<br/>

<br/>

Today's Classes GraphQL Proxy Example

This example is part of a suite of examples that illustrate multiple methods to access institution data through Ethos from Experience cards and pages. The use case is a card that displays the student's classes that meet today. This example fetches the Ethos data utilizing the Experience GraphQL proxy. Using Experience's GraphQL proxy avoids the need to deploy a microservice. The efficiency of GraphQL also reduces the round trips to Ethos by returning graphs of objects. There is some extra setup effort involved in loading the needed resources into Ellucian Data Access and authorizing the Ethos Application to use those resources.

This example is detailed here: today-classes-graphql

<br/>

<br/>

Today's Classes Lambda Example

This example is part of a suite of examples that illustrate multiple methods to access institution data through Ethos from Experience cards and pages. The use case is a card that displays the student's classes that meet today. This example fetches the Ethos data through a Lambda microservice that utilizes Ethos GraphQL. The efficiency of GraphQL also reduces the round trips to Ethos by returning graphs of objects. Using Lambda provides a reduced effort deployment of the microservice endpoints. There is some extra setup effort involved in loading the needed resources into Ellucian Data Access and authorizing the Ethos Application to use those resources.

This example is detailed here: today-classes-lambda

<br/>

<br/>

Today's Classes Node Example

This example is part of a suite of examples that illustrate multiple methods to access institution data through Ethos from Experience cards and pages. The use case is a card that displays the student's classes that meet today. This example fetches the Ethos data through a Node microservice which retrieves the data using Ethos EEDM resources (Ellucian Ethos Data Model). Accessing the Ethos EEDM resources reduces the setup effort over using GraphQL. Note, this node application will need to be deployed in a scalable manner.

This example is detailed here: today-classes-node

<br/>

<br/>

Copyright 2021–2023 Ellucian Company L.P. and its affiliates.