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.

Sign up for GitHub

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

Added synchronizations info to readme #69

Merged
merged 3 commits into from
Oct 24, 2023
Merged

Added synchronizations info to readme #69

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1c8202
Added synchronizations info to readme
bbrands02 Oct 24, 2023
228956a
readme fix
bbrands02 Oct 24, 2023
70eb368
Update src from remark-lint
Oct 24, 2023
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
34 changes: 34 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,43 @@ These are all current commands, you can fetch your synchronized objects through
`/api/ztc/v1/zaaktypen`
`/api/ztc/v1/besluittypen`

## Synchronizations

There are a lot of objects being synced from and to the xxllnc zaaksysteem to zgw objects. Here is a table of them.

Syncs from the zaaksysteem:
| ZGW | Zaaksysteem | Mapping |
|----------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| BesluitType | casetype | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncBesluitTypeToZGWBesluitType.json) |
| ZaakType | casetype | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncCaseTypeToZGWZaakType.json) |
| StatusType | phase | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncPhaseToZGWStatusType.json) |
| RolType | role | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncRoleToZGWRolType.json) |
| ResultaatType | result | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncResultToZGWResultaatType.json) |
| Eigenschap | field | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncFieldToZGWEigenschap.json) |
| InformatieObjectType | field | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncFieldToZGWInformatieObjectType.json) |
| Zaak | case | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncCaseToZGWZaak.json) |
| Status | milestone | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncMilestoneToStatus.json) |
| Resultaat | outcome | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncOutcomeToResultaat.json) |
| Rol | role.requestor | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncRoleRequestorToRol.json) |
| ZaakEigenschap | attribute | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncAttributeToZaakEigenschap.json) |
| InformatieObject | document | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncDocumentToZaakInformatieObject.json) |

All above synchronizations are triggered by cronjob or command. Note that all child objects you see from Zaak and ZaakType are synced during synchronization of Zaak or ZaakType.
Also read [commands](#commands) on how to execute certain synchronizations.

Syncs to the zaaksysteem:
| Zaaksysteem | ZGW | Trigger | Mapping |
|-------------|------------------|---------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
| case | Zaak | POST/PUT /zrc/zaken | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncZaakToCase.json) |
| case | Besluit | POST/PUT /brc/besluiten | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/ZgwBesluitToXxllncCase.json) |
| document | InformatieObject | POST/PUT /zrc/zaken/id/zaakinformatieobject | [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/ZgwBesluitToXxllncCase.json) |

Note: casetypes can't be created yet on the zaaksysteem api so we do not sync back ZaakTypen.

## Design decisions

Special noted decisions made in this project are:

* ZGW 'verlenging' is not mappable from a xxllnc case and thus ignored during synchronization.
* The xxllnc zaaksysteem does not ZGW BesluitTypen or Besluiten and thus there have been created 3 specific BesluitTypen as normal xxllnc casetypes which can be synced with the ZaakType command, so when a Besluit in the gateway is created for one of these 3 BesluitTypen we synchronize it back to xxllnc as a case and link it to the main case (Zaak) as related case.
* Casetypes can't be created/updated through the zaaksysteem api, so we do not sync ZaakTypen back to the zaaksysteem if they are created/updated on the gateway.