In order to fully integrate all the necessary data that is expected from the CFNC app into Colleague, Ethos must be extended to account for custom entities and fields that were developed for the Community Colleges in North Carolina. Below are the steps you will want to follow to get the baseline extensions completed.
Delivered Entity - persons
- In Colleague, navigate to EAEE
- At the lookup prompt, enter persons
- If the resource does not exist, select Add
- Navigate to EAEV and configure:
- Description: Extend Element451 integration
- Version Number: Leave blank (or leave at default value, do not increment)
- Version Status: R (Released)
- Add the following fields:
- PERSON.OVRL.EMP.STAT
- RESIDENCE.COUNTY
- RESIDENCE.STATE
- Verify:
- Property names are generated correctly (camelCase, no spaces)
- Read Only = No
- Path = /
- Save all changes
Custom Entity - xnc-person
- In Colleague, navigate to EAPI
- At the lookup prompt, enter xnc-person
- If the resource does not exist, select Add
- Configure the resource:
- Primary Entity: XNC.PERSON
- GUID Source/Key: XNC.PERSON.ID
- Methods:
- Navigate to EAEV and configure:
- Description: Extend Element451 integration
- Version Number: Leave blank (or leave at default value, do not increment)
- Version Status: R (Released)
- Add the following fields:
- XCN.PERSON.ID
- XCN.HIGH.SCHOOL.TRACK
- XNC.EDUCATIONAL.LEVEL
- XNC.MIGRANT.FARMWORKER
- XNC.FOSTER.CARE.YOUTH
- XNC.PARENT1.EDUCATION.LEVEL
- XNC.PARENT2.EDUCATION.LEVEL
- XNC.HS.STU.ID
- XNC.HS.LAST.ATTENDED.DATE
- XNC.EXPELLED.SUSPENDED
- XNC.ACADORDISC
- XNC.VETERAN.STATUS
- XNC.ACTIVE.DUTY.BRANCH
- XNC.ACTIVE.DUTY.DEPEND
- XNC.MILITARY.RESERVE.FLAG
- XNC.CHILDCARE.AVAIL.FLAG
- XNC.TRANSPORTATION.FLAG
- XNC.FATHER.DEGREE.FLAG
- Verify:
- Property names are generated correctly (camelCase, no spaces)
- Read Only = No
- Path = /
- Save all changes
- Access RFGU to define the custom resource:
- On lookup enter XNC.PERSON
- In the Key Field Name enter XNC.PERSON.ID
- In the resource name enter xnc-person
- Save all
- Access GNGU to generate the Ethos GUIDs for your custom entity (xnc-person)
- Log into Ethos, under Applications, in the Colleague Web API application, click Owned Resources, add the custom entity (xnc-person).