Beheer binnenkomend koppelverzoek (API)Beheer binnenkomend koppelverzoek (API)

Hoe werken binnenkomende verzoeken?How do incoming requests work?

Antwoord op deze vraag uit de Mozard-schermhulp.Answer to this question from the Mozard screen help.

Sectie 01Section 01

Hoe werken binnenkomende koppelverzoeken?How do incoming koppelverzoeken work?

Van elk binnenkomend koppelverzoek wordt een zaak aangemaakt. De xml van het koppelverzoek wordt als aanvraag in het zaakdossier weggeschreven. Per opdracht wordt de bijbehorende API uitgevoerd. De xml met het resultaat van het koppelverzoek wordt ook in het zaakdossier weggeschreven. Zie bijbehorend document voor een uitgebreide toelichting.

A case (zaak) is created for every incoming koppelverzoek. The koppelverzoek's XML is written to the zaakdossier as the request. The corresponding API is carried out per instruction. The XML holding the koppelverzoek's result is also written to the zaakdossier. See the accompanying document for a detailed explanation.

Zie ookSee also


Sectie 02Section 02

Voorbeeld inrichting Office Add-innVoorbeeld inrichting Office Add-inn

Volgnummer21
NaamOfficeAddin
OmschrijvingOfficeAddin
ReferentieOfficeAddin
Hashcode (doorgeven als waarde xxb)(pass as the value of xxb)de waarde uit je eigen omgeving — zie de opmerking hieronderthe value from your own environment — see the note below
Hashsleutel (om xxe te berekenen)(for calculating xxe)de waarde uit je eigen omgeving — zie de opmerking hieronderthe value from your own environment — see the note below
Kenmerktype naamUKVNAAM
Kenmerktype actieUKVACTIE
Kenmerktype referentieUKVREF
Kenmerktype nummerUKVNUMMER
Kenmerktype omschrijvingUKVOMSCHRIJVING

De hashcode en de hashsleutel zijn inloggegevens van de koppelinfrastructuur. Vul ze in je eigen omgeving naar eigen keuze in — zie Hoe configureer ik een koppelinfrastructuur? voor de werkwijze.

The hash code and the hash key are credentials of the koppelinfrastructuur. Fill them in as you choose in your own environment — see Hoe configureer ik een koppelinfrastructuur? for how.

Functieverbanden bij deze koppelinfrastructuur: 102 (doorgeven als waarde xxc) — Koppelvlak Office add-in.

Functieverbanden at this koppelinfrastructuur: 102 (pass as the value of xxc) — Koppelvlak Office add-in.

Ook moet de addin in de ACL gezet worden en Mozard moet deze op de Office addin server aanzetten.

The add-in also has to be placed in the ACL, and Mozard has to switch it on on the Office add-in server.

Systeem Parameter — INDOFFICEADDIN = Ja

System parameter — INDOFFICEADDIN = Ja


Sectie 03Section 03

Koppelverzoek aan specifieke wachtrijnaam kunnen toewijzenKoppelverzoek aan specifieke wachtrijnaam kunnen toewijzen

Er kan een wachtrij meegegeven via de xml tag <moz_wachtrijnaam>. Door een wachtrij mee te geven en directverwerken = N in te stellen in de XML, zal de wachtrij op volgorde van binnenkomst worden verwerkt.

A queue can be given through the XML tag <moz_wachtrijnaam>. By giving a queue and setting directverwerken = N in the XML, the queue is processed in order of arrival.

Vereiste tag <moz_wachtrijnaam>:

Requirements for the <moz_wachtrijnaam> tag:

  • Maximaal 22 karakters langAt most 22 characters long
  • Bevat alleen letters, cijfers en underscoresContains only letters, digits and underscores

Er lopen maximaal 3 achtergrondprocedures tegelijk. Als er 3 of meer verschillende wachtrijnamen gebruikt worden, dan zullen verzoeken zonder wachtrijnaam maar wel directstarten = J, pas uitgevoerd worden als er daadwerkelijk ruimte is bij de achtergrondprocedures. Dit betekent dus als er drie verschillende wachtrijen op een bepaald moment verwerkt worden, overige verzoeken pas verwerkt worden als 1 van de 3 achtergrondprocedures klaar is.

At most 3 background procedures run at the same time. If 3 or more different queue names are used, requests without a queue name but with directstarten = J are only carried out once there is genuinely room among the background procedures. So this means that if three different queues are being processed at a given moment, other requests are only processed once 1 of the 3 background procedures has finished.

Het bovenstaande betekent dus ook dat de instelling directstarten = J GEEN garantie biedt dat het direct op volgorde verwerkt wordt. Om de garantie te hebben dat verzoeken in volgorde van binnenkomst worden verwerkt, moet er bij koppelverzoeken aan de volgende eisen voldaan worden:

The above therefore also means that the directstarten = J setting offers NO guarantee that it is processed in order straight away. To have the guarantee that requests are processed in order of arrival, koppelverzoeken have to meet the following requirements:

  • Maximaal 2 verschillende wachtrijen + koppelverzoeken directverwerken = 'J' zonder wachtrijnaamAt most 2 different queues + koppelverzoeken with directverwerken = 'J' without a queue name
  • OF maximaal 3 wachtrijen en GEEN koppelverzoeken met directverwerken = 'J' zonder wachtrijnaamOR at most 3 queues and NO koppelverzoeken with directverwerken = 'J' without a queue name

Bestaande/Huidige werkingBestaande/Huidige werking

Voor klanten die géén gebruik maken van wachtrijen werkt de functionaliteit als volgt: koppelverzoeken met directverwerken = N worden verwerkt (nadat alle koppelverzoeken met directverwerken = J zijn verwerkt).

For customers who do not use queues, the functionality works as follows: koppelverzoeken with directverwerken = N are processed (after all koppelverzoeken with directverwerken = J have been processed).