Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tools4everbv/helloid-conn-prov-source-anthology-campusnexus
Anthology CampusNexus - Source - Students
https://github.com/tools4everbv/helloid-conn-prov-source-anthology-campusnexus
edu provisioning sis source
Last synced: about 1 month ago
JSON representation
Anthology CampusNexus - Source - Students
- Host: GitHub
- URL: https://github.com/tools4everbv/helloid-conn-prov-source-anthology-campusnexus
- Owner: Tools4everBV
- Created: 2023-10-17T21:52:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-08T08:54:36.000Z (5 months ago)
- Last Synced: 2024-08-09T11:15:09.891Z (5 months ago)
- Topics: edu, provisioning, sis, source
- Language: PowerShell
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HelloID-Conn-Prov-Source-Anthology-CampusNexus
| :information_source: Information |
|:---------------------------|
| This repository contains the connector and configuration code only. The implementer is responsible to acquire the connection details such as username, password, certificate, etc. You might even need to sign a contract or agreement with the supplier before implementing this connector. Please contact the client's application manager to coordinate the connector requirements. |
HelloID Provisioning Source Connector for Anthology CampusNexus
## Table of Contents
* [Getting Started](#getting-started)
* [Setting up the API access](#setting-up-the-api-access)
* [Configuration](#configuration)
## Getting Started
By using this connector you will have the ability to import data into HelloID:
* Student Demographics
* Student Enrollment Periods
## Setting up the API Access
The purpose of this is to provide steps on generating and using key based authentication for Student Rest APIs
* Introduction
The Application API Keys configuration is enhanced to be used when authenticating to the entire Student REST API set instead of only being used for the Campuslink APIs.
This enhancement:
* Limits the integrating partners to only access the modules to which they have permissions. Appropriate audits will be recorded in the database.
* Allows the integrating partner to generate their own application key, associated to a user in the Staff entity.
* Steps
* Location - Select Settings > System > Application API Keys.
* Product Help Link
https://help.campusmanagement.com/CNS/23.0/WebClient/Content/SU/System/ApplicationAPIK
* Encode the Application with Base 64
https://www.base64encode.org/
`{"CallingAppName":"DualEnrollAPI","KeyValue":"YsIQkq2Hj/viKSM5Lzn07Q=="} `
* CallingAppName: Calling Application Name
* KeyValue: Application Key
Encode the value and share it with client/vendor
Client/Vendor can use the encoded value with “ApplicationKey encoded value
## Configuration
1. Add a new 'Source System' to HelloID and make sure to import all the necessary files.
- [ ] configuration.json
- [ ] person.ps1
2. Fill in the required fields on the 'Configuration' tab. See also, [Setting up the API access](#setting-up-the-api-access)
* Base URI
* URL of Instance
* Page Size
* Application Key
* Student Fields
* Statuses Included
* Shifts Excluded
_For more information about our HelloID PowerShell connectors, please refer to our general [Documentation](https://docs.helloid.com/hc/en-us/articles/360012557600-Configure-a-custom-PowerShell-source-system) page_
# HelloID Docs
The official HelloID documentation can be found at: https://docs.helloid.com/