Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tools4everbv/helloid-conn-prov-source-esis
Esis - Source
https://github.com/tools4everbv/helloid-conn-prov-source-esis
edu on-premises provisioning sis source
Last synced: about 1 month ago
JSON representation
Esis - Source
- Host: GitHub
- URL: https://github.com/tools4everbv/helloid-conn-prov-source-esis
- Owner: Tools4everBV
- Created: 2021-12-23T15:03:14.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-15T13:12:31.000Z (11 months ago)
- Last Synced: 2024-01-15T17:07:29.639Z (11 months ago)
- Topics: edu, on-premises, provisioning, sis, source
- Language: PowerShell
- Homepage:
- Size: 27.3 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HelloID-Conn-Prov-Source-ESIS
| :warning: Warning |
|:---------------------------|
| Note that this connector is not yet implemented. Contact our support for further assistance |
| :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. |
## Table of contents
- [Introduction](#Introduction)
- [Getting started](#Getting-started)
+ [Connection settings](#Connection-settings)
+ [Prerequisites](#Prerequisites)
+ [Remarks](#Remarks)
- [Setup the connector](@Setup-The-Connector)
- [Getting help](#Getting-help)
- [HelloID Docs](#HelloID-docs)
## Introduction
_HelloID-Conn-Prov-Source-ESIS_ is a _source_ connector. ESIS provides a SOAP webservice that allows you to programmatically interact with it's data. The HelloID connector uses the SOAP actions listed in the table below. This connector adds Student and group information in HelloID.
| Endpoint | Description |
| ------------ | ----------- |
| HaalLeerlinggegevens | Contains all Student, School, Location, Group and Teacher Data |
## Getting started
### Connection settings
The following settings are required to connect to the API.
| Setting | Description | Mandatory |
| ------------ | ----------- | ----------- |
| BaseUrl | The URL to the webservice | Yes |
| Autorisatiesleutel | Authorization key for the webservice | Yes |
| Klantcode | - | Yes |
| Klantnaam | - | Yes |
| brinIdentifiers | Brin Indentifers (Comma sperated string) | Yes |
| Certpath | Fullpath to the Certifcate (.p12) | Yes |
| Certpassword | Certificate passwword | Yes |
| Xsdversie | Default 1 | No |
| dependancecode | School Location code (Default = 00) | No |
### Prerequisites
- A Certificate to authenticate with the webservice (.p12)
- A agent server with access to the certificate (local HelloID Agent)
- Windows Powershell 5.1
- The Mandatory field from the connector Settings.
### Remarks
- Active Other groups and Instructiongroups are delivered by the connector when the property “In koppelingen beschikbaar” In ESIS at the group is marked as Yes. The groups can be found in the node subgroups.
- The connector only retrieves the students of the current Schoolyear, so it is not able to retrieve from the past and upcoming students.
## Setup the connector
> _How to setup the connector in HelloID._ Are special settings required. Like the _primary manager_ settings for a source connector.
## Getting help
> _For more information on how to configure a HelloID PowerShell connector, please refer to our [documentation](https://docs.helloid.com/hc/en-us/articles/360012557600-Configure-a-custom-PowerShell-source-system) pages_
> _If you need help, feel free to ask questions on our [forum](https://forum.helloid.com)_
## HelloID docs
The official HelloID documentation can be found at: https://docs.helloid.com/