https://github.com/tools4everbv/helloid-conn-prov-source-anthology-student

Anthology Student - Source - Students
https://github.com/tools4everbv/helloid-conn-prov-source-anthology-student

edu provisioning sis source

Last synced: about 1 month ago
JSON representation

Anthology Student - Source - Students

• Host: GitHub
• URL: https://github.com/tools4everbv/helloid-conn-prov-source-anthology-student
• Owner: Tools4everBV
• Created: 2023-09-29T18:39:29.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-09T09:06:56.000Z (12 months ago)
• Last Synced: 2024-01-09T10:38:30.013Z (12 months ago)
• Topics: edu, provisioning, sis, source
• Language: PowerShell
• Homepage:
• Size: 25.4 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# HelloID-Conn-Prov-Source-Anthology-Student

| :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 Student


## Table of Contents

* [Getting Started](#getting-started)

* [Requirements](#requirements)

* [Configure API Access](#configure-api-access)

## Getting Started

By using this connector you will have the ability to import data into HelloID:

* Student Demographics

## Requirements

* API Access

## Configure API Access

To configure Key Based Authentication, please follow these steps

* Location - Select Settings > System > Application API Keys

    * [Product Help Link](https://help.campusmanagement.com/CNS/23.0/WebClient/Content/SU/System/ApplicationAPIKey/p_AddApplicationAPIKey.htm?cshid=CNSp_AddApplicationAPIKey)

![image](https://github.com/Tools4everBV/HelloID-Conn-Prov-Source-Anthology-Student/assets/24281600/3a07a6d9-f860-4156-8827-dd74ac57b6f1)

![image](https://github.com/Tools4everBV/HelloID-Conn-Prov-Source-Anthology-Student/assets/24281600/0331c3a3-5faf-4789-9798-1afa9a52a3fd)

* Encode the Application Key with Base64. Encode the value and share it with client/vendor

    * CallingAppName: Calling Application Name

    * KeyValue: Application Key

`{"CallingAppName":"DualEnrollAPI","KeyValue":"YsIQkq2Hj/viKSM5Lzn07Q=="}`

![image](https://github.com/Tools4everBV/HelloID-Conn-Prov-Source-Anthology-Student/assets/24281600/7000a276-172c-4d40-ab3a-3ab9b534005b)

![image](https://github.com/Tools4everBV/HelloID-Conn-Prov-Source-Anthology-Student/assets/24281600/13b26604-77c8-4e01-8b37-390b18b22a75)

## Setup the PowerShell connector

1. Add a new 'Source System' to HelloID and make sure to import all the necessary files.

    - [ ] configuration.json

    - [ ] persons.ps1

    - [ ] departments.ps1

2. Fill in the required fields on the 'Configuration' tab.

* Base URI

    * URI of Instance

* Application Key

    * API Key

* Page Size

    * Size of Results to pull back per page

* Student Fields

    * Fields to pull from Student Endpoint

* Include Statuses

    * Student Statuses to include in HelloID Import (no value results in all statuses)

* Exclude Shifts

    * Shifts to exclude from Import (no value results no filtering of shifts)

# HelloID Docs

The official HelloID documentation can be found at: https://docs.helloid.com/