Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#2709] Add beheerhandleiding entry or ZGW import/export #1506

Merged
merged 1 commit into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 78 additions & 4 deletions docs/beheerhandleiding/09_datakoppelingen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,86 @@ gebruikers. Dit is overzichtelijk weergegeven in de tabel op deze pagina.
| | Webhook-abonnementen | | Mijn aanvragen - notificaties |
+-----------------------------------+---------------------------------------------------------------+

9.1 Catalogus Configs
=====================

9.1. Catalogus configs
======================
Catalogus configs worden automatisch geïmporteerd vanuit Open Zaak of eSuite via de
ZGW-koppeling. Aan deze catalogi zijn zaaktypes gekoppeld, zoals geconfigureerd in
het onderdeel Zaaktypeconfiguratie.

Dit zijn de catalogi die automatisch worden geïmporteerd vanuit Open Zaak of eSuite via de ZGW-
koppeling. Aan de catalogi zijn zaaktypes geconfigureerd, zoals in het onderdeel Zaaktypeconfiguratie.
Import en Export
----------------

Catalogi kunnen worden geëxporteerd en geïmporteerd tussen verschillende OIP-installaties
(bijvoorbeeld tussen acceptatie- en testomgevingen).

.. note::
De import/export-functionaliteit vereist dat de gekoppelde zaaksystemen
materieel gelijk zijn. Dit betekent dat de catalogi en onderliggende zaaktypes
in beide ZGW API's aanwezig moeten zijn (hoewel de URLs en UUIDs mogen verschillen).
Voer daarom de ``Importeer ZGW data`` periodieke taak eerst handmatig uit op zowel de
bron als bestemming zodat de ZGW objecten volledig in sync zijn.

Importproces
^^^^^^^^^^^^

Tijdens de import zoekt de ontvangende installatie catalogi en zaaktypes op basis van
specifieke kenmerken. Deze matching bepaalt hoe bijbehorende data (beschrijvingen,
instellingen en metadata) worden gekoppeld.

Matching-attributen
"""""""""""""""""""

- **Catalogus Config**: ``domein`` en ``rsin`` moeten gelijk zijn
- **Zaaktype Configuratie**: ``identificatie`` en bovenliggende ``catalogus`` moeten gelijk zijn
- **Status, Resultaat en Informatie Object Typen**: ``omschrijving`` en de bovenliggende
``zaaktype`` moeten gelijk zijn

Exporteren
----------

Stappen voor exporteren:

#. Selecteer een of meer Catalogus Config-objecten
#. Kies "Opslaan als bestand" in de "Actie" dropdown linksboven de catalogilijst

.. figure:: images/image140.png
:width: 709px
:height: 305px
:alt: Exporteren van catalogus configuraties

Exporteren van catalogus configuraties

De export omvat alle zaaktypes en onderliggende objecten (resultaattypen,
informatie-objecttypen, etc.) van de geselecteerde catalogi.

Importeren
----------

Stappen voor importeren:

#. Klik op "Importeer uit een bestand" rechtsboven op de catalogus configs-overzichtspagina

.. figure:: images/image141.png
:width: 1178px
:height: 120px
:alt: Importeren van catalogus configuraties

Importeren van catalogus configuraties

#. Selecteer een bestand van uw lokale computer
#. Upload het bestand

.. warning::
- Het importeren kan aanzienlijke tijd in beslag nemen

#. Na afloop toont het systeem:

* Aantal succesvol geïmporteerde objecten
* Aantal niet-geïmporteerde objecten. De meest voorkomende reden voor foutmeldingen
betreft pntbrekende objecten met de gespecificeerde matching-attributen. De
attributen die ertoe leidde dat bepaalde objecten niet gevonden konden worden,
zullen zoveel mogelijk worden vermeld.

9.2. Configuratie ‘Open Klant’
==============================
Expand Down
Binary file added docs/beheerhandleiding/images/image140.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/beheerhandleiding/images/image141.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading