The Coscine Organization Parser is a C# script designed to parse organizational data from JSON files. It is a commandline application which downloads the IDM exports and parses it to a `.ttl` file. The script is part of the Coscine environment that aims to provide a comprehensive view of the organizational structure of a company or institution.
Most commandline parameters can be set over the variables section of the Gitlab project.
The help and output parameter are unused or fixed.
The scheduled CI task runs every morning at 01:00 am.
The task builds the executable and runs it automatically.
## ⚙️ Configuration
Before you can run and use the script, you need to ensure that the following dependencies and prerequisites are in place:
1. The project's referenced .NET SDK(s) must be installed. Please refer to the project's source code for information on which .NET SDK(s) are required.
Once you have all the necessary dependencies and prerequisites in place, you should be able to run and use this script.
## 📖 Usage
To get started with this project, you will need to ensure you have configured and built it correctly.
1. Execute the built executable (`.exe`)
2. It has the following parameters
-`force`: Skip checks for to many or no changes in the exports.
-`username`: Username for the export. If none is provided, the consul value is used.
-`password`: Password for the export. If none is provided, the consul value is used.
-`organizationsLink`: Link for the organizations export. If none is provided, the consul value is used.
-`employeesLink`: Link for the employee export. If none is provided, the consul value is used.
-`rorId`: The RWTH ror Id. If none is provided, the consul value is used.
-`output`: Output for the generated file (Mandatory).
-`h | help`: show help and exit
To show the above output, run: `.\OrganizationLoader.exe --h`
Create a `.ttl` file with: `.\OrganizationLoader.exe --output="index.ttl"`
Should a parameter be empty or not provided, the program will look it up in Consul. Only the `output` parameter has to be supplied via the commandline. The other configuration parametes must be provided by the commandline or by Consul. Commandline parameters have a higher priority and are choosen instead of Consul values.
## 👥 Contributing
As an open source plattform and project, we welcome contributions from our community in any form. You can do so by submitting bug reports or feature requests, or by directly contributing to Coscine's source code. To submit your contribution please follow our [Contributing Guideline](https://git.rwth-aachen.de/coscine/docs/public/wiki/-/blob/master/Contributing%20To%20Coscine.md).
## 📄 License
The current open source repository is licensed under the **MIT License**, which is a permissive license that allows the software to be used, modified, and distributed for both commercial and non-commercial purposes, with limited restrictions (see `LICENSE` file)
> The MIT License allows for free use, modification, and distribution of the software and its associated documentation, subject to certain conditions. The license requires that the copyright notice and permission notice be included in all copies or substantial portions of the software. The software is provided "as is" without any warranties, and the authors or copyright holders cannot be held liable for any damages or other liability arising from its use.
## 🆘 Support
1.**Check the documentation**: Before reaching out for support, check the help pages provided by the team at https://docs.coscine.de/en/. This may have the information you need to solve the issue.
2.**Contact the team**: If the documentation does not help you or if you have a specific question, you can reach out to our support team at `servicedesk@itc.rwth-aachen.de` 📧. Provide a detailed description of the issue you're facing, including any error messages or screenshots if applicable.
3.**Be patient**: Our team will do their best to provide you with the support you need, but keep in mind that they may have a lot of requests to handle. Be patient and wait for their response.
4.**Provide feedback**: If the support provided by our support team helps you solve the issue, let us know! This will help us improve our documentation and support processes for future users.
By following these simple steps, you can get the support you need to use Coscine's services as an external user.
## 📦 Release & Changelog
External users can find the _Releases and Changelog_ inside each project's repository. The repository contains a section for Releases (`Deployments > Releases`), where users can find the latest release changelog and source. Withing the Changelog you can find a list of all the changes made in that particular release and version.
By regularly checking for new releases and changes in the Changelog, you can stay up-to-date with the latest improvements and bug fixes by our team and community!
