From b1c8202ff85ef1ba369b8202176b01768610a784 Mon Sep 17 00:00:00 2001 From: Barry Brands Date: Tue, 24 Oct 2023 10:42:53 +0200 Subject: [PATCH 1/3] Added synchronizations info to readme --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index fd19efb..75c1f25 100644 --- a/README.md +++ b/README.md @@ -118,9 +118,42 @@ 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 |Trigger | Mapping | +|----------------------|----------------|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| BesluitType | casetype | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncBesluitTypeToZGWBesluitType.json) | +| ZaakType | casetype | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncCaseTypeToZGWZaakType.json) | +| StatusType | phase | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncPhaseToZGWStatusType.json) | +| RolType | role | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncRoleToZGWRolType.json) | +| ResultaatType | result | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncResultToZGWResultaatType.json) | +| Eigenschap | field | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncFieldToZGWEigenschap.json) | +| InformatieObjectType | field | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncFieldToZGWInformatieObjectType.json) | +| Zaak | case | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncCaseToZGWZaak.json) | +| Status | milestone | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncMilestoneToStatus.json) | +| Resultaat | outcome | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncOutcomeToResultaat.json) | +| Rol | role.requestor | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncRoleRequestorToRol.json) | +| ZaakEigenschap | attribute | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncAttributeToZaakEigenschap.json) | +| InformatieObject | document | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncDocumentToZaakInformatieObject.json) | + +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. From 228956af2f21478381526be089290cc6ed137bd1 Mon Sep 17 00:00:00 2001 From: Barry Brands Date: Tue, 24 Oct 2023 10:46:48 +0200 Subject: [PATCH 2/3] readme fix --- README.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 75c1f25..97e1ced 100644 --- a/README.md +++ b/README.md @@ -123,22 +123,23 @@ These are all current commands, you can fetch your synchronized objects through 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 |Trigger | Mapping | -|----------------------|----------------|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------| -| BesluitType | casetype | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncBesluitTypeToZGWBesluitType.json) | -| ZaakType | casetype | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncCaseTypeToZGWZaakType.json) | -| StatusType | phase | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncPhaseToZGWStatusType.json) | -| RolType | role | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncRoleToZGWRolType.json) | -| ResultaatType | result | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncResultToZGWResultaatType.json) | -| Eigenschap | field | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncFieldToZGWEigenschap.json) | -| InformatieObjectType | field | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncFieldToZGWInformatieObjectType.json) | -| Zaak | case | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncCaseToZGWZaak.json) | -| Status | milestone | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncMilestoneToStatus.json) | -| Resultaat | outcome | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncOutcomeToResultaat.json) | -| Rol | role.requestor | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncRoleRequestorToRol.json) | -| ZaakEigenschap | attribute | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncAttributeToZaakEigenschap.json) | -| InformatieObject | document | Cronjob or command| [View on GitHub](https://github.com/CommonGateway/XxllncZGWBundle/blob/main/Installation/Mapping/XxllncDocumentToZaakInformatieObject.json) | - +| 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: From 70eb368277cde28d85be368b320048358e78e3a9 Mon Sep 17 00:00:00 2001 From: GitHub Actions <> Date: Tue, 24 Oct 2023 08:47:17 +0000 Subject: [PATCH 3/3] Update src from remark-lint --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 97e1ced..480c648 100644 --- a/README.md +++ b/README.md @@ -139,7 +139,7 @@ Syncs from the zaaksysteem: | 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. +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: