search

maykinmedia / archiefbeheercomponent

An application for record management
Other
2 stars 1 forks source link
commonground

readme

====================== ArchiefBeheerComponent

:Version: 1.1.5 :Source: https://github.com/maykinmedia/archiefbeheercomponent :Keywords: Common Ground, Record Management, Archiving

|build-status| |code-quality| |docs| |coverage| |black| |python-versions|

Create, manage and execute destruction lists, for use with for "Zaakgericht werken" (case-oriented working). (Nederlandse versie_)

Developed by Maykin Media B.V._ commissioned by the Municipality of Utrecht and Delft.

Introduction

Record management is the practice of destroying data-records that have met their end-of-life time. "Zaakgericht werken" prescribes the archiving terms for cases that have been brought to an end.

The ArchiefBeheerComponent (ABC) proBides functionality for record managers to schedule destruction of cases according to the archiving parameters. It implements a multi-step, multi-role accordance process.

Attention is paid to the user experience of the staff using the app, with notifications to inform you of pending work-load, full audit logging and traceability of user and system actions.

The ABC supports all backends implementing the 1.0.x API's voor Zaakgericht Werken, like Open Zaak.

Quickstart

A docker-compose-quickstart.yml_ is provided to get up and running quickly. To run the container:

.. code:: shell

    $ wget https://raw.githubusercontent.com/maykinmedia/archiefbeheercomponent/master/docker-compose-quickstart.yml
    $ docker-compose -f docker-compose-quickstart.yml up -d
    $ docker-compose -f docker-compose-quickstart.yml exec web src/manage.py createsuperuser

Then, navigate to http://127.0.0.1:8000/ and log in with the credentials created.

.. _docker-compose-quickstart.yml: docker-compose-quickstart.yml

License

Copyright © Maykin Media, 2021

Licensed under the EUPL_.

References

.. Nederlandse versie: README.NL.rst .. Maykin Media B.V.: https://www.maykinmedia.nl .. API's voor Zaakgericht Werken: https://github.com/VNG-Realisatie/gemma-zaken .. Open Zaak: https://opengem.nl/producten/open-zaak/ .. Common Ground: https://commonground.nl/ .. EUPL: LICENSE.md

.. |build-status| image:: https://github.com/maykinmedia/archiefbeheercomponent/workflows/Run%20CI/badge.svg?branch=master :alt: Build status :target: https://github.com/maykinmedia/archiefbeheercomponent/actions?query=branch%3Amaster+workflow%3A%22Run+CI%22

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :alt: Code style :target: https://github.com/psf/black

.. |python-versions| image:: https://img.shields.io/badge/python-3.8-blue.svg :alt: Supported Python version

.. |code-quality| image:: https://github.com/maykinmedia/archiefbeheercomponent/workflows/Code%20quality%20checks/badge.svg :alt: Code quality checks :target: https://github.com/maykinmedia/archiefbeheercomponent/actions?query=workflow%3A%22Code+quality+checks%22

.. |docs| image:: https://readthedocs.org/projects/archiefbeheercomponent/badge/?version=latest :target: https://archiefbeheercomponent.readthedocs.io/ :alt: Documentation Status

.. |coverage| image:: https://codecov.io/github/maykinmedia/archiefbeheercomponent/branch/master/graphs/badge.svg?branch=master :alt: Coverage :target: https://codecov.io/gh/maykinmedia/archiefbeheercomponent