Samenvatting: Ontdek wat een BrynQ-interface is, welke statussen een interface kan hebben en hoe een interface van inrichting naar live gebruik gaat.

Vereisten: - Je hebt toegang tot Interfaces nodig om interfaces te bekijken. - Je hebt de juiste rechten nodig om een interface aan te maken (create), te bewerken (edit), te publiceren (publish) of uit te voeren (run). - De bron- en doelapps moeten actief zijn voordat een interface geactiveerd en gebruikt kan worden.

Interfaceconcepten en levenscyclus

Een interface verbindt een bronapp met een doelapp, zodat data gecontroleerd tussen beide kan worden uitgewisseld.

Wat een interface is

• Een interface bepaalt welke data wordt uitgewisseld, waar die vandaan komt, waar die naartoe gaat en hoe BrynQ die moet verwerken.
• Een bronapp is de app waar de data vandaan komt.
• Een doelapp is de app waar de data naartoe wordt gestuurd.
• Een schedule bepaalt wanneer de interface draait. Dat kan handmatig, op basis van tijd of na een andere interface.
• Variables zijn waarden die gebruikt kunnen worden wanneer de interface draait.

Soorten interfaces

• Kies Use our templates als je wilt starten vanuit een standaard BrynQ-template.
• Kies Build together with us als je een maatwerkoplossing met ondersteuning van BrynQ nodig hebt.
• Een template-interface kan Configuration, Scenarios, Data filters, Authorization, Mapping, Variables en Schedule bevatten.
• Een maatwerkinterface kan Scoping, Authorization, Mapping, Variables en Schedule bevatten.

Actieve en inactieve interfaces

• Active interfaces kunnen draaien zodra de vereiste inrichting compleet is.
• Inactive interfaces zijn uitgeschakeld en kunnen niet draaien.
• Als je een interface deactiveert, schakelt BrynQ ook de planning ervan uit.
• Je kunt een interface niet deactiveren terwijl die draait.
• Als een interface apps nodig heeft die niet actief zijn, vraagt BrynQ je om die apps eerst te activeren.

Hoe een interface door de levenscyclus gaat

Een interface gaat meestal van aanmaken, naar inrichten als concept, naar live gebruik, en daarna naar latere wijzigingen wanneer dat nodig is.

De interface aanmaken

• Open Interfaces.
• Selecteer New interface.
• Kies Use our templates of Build together with us.
• Kies bij een template het template dat past bij je bron- en doelapps.
• Voer bij een maatwerkinterface een duidelijke interfacenaam in.
• Selecteer Finish of Confirm and start om het eerste concept aan te maken.

Het concept afronden

• Een draft (concept) is de bewerkbare versie van de interface.
• BrynQ slaat wijzigingen op terwijl je werkt.
• Vul alle verplichte tabbladen in die zichtbaar zijn voor jouw type interface.
• Verschijnt er een waarschuwing op een tabblad, open dat tabblad dan en vul de ontbrekende gegevens aan.
• Selecteer Continue later als je het concept wilt verlaten zonder het te publiceren.

Het concept publiceren

• Selecteer Publish zodra alle verplichte onderdelen compleet zijn.
• BrynQ controleert het concept voordat het wordt gepubliceerd.
• Publiceren wordt geblokkeerd als verplichte autorisatie, configuratie, scenario's, mapping of andere verplichte gegevens ontbreken.
• Na het publiceren wordt de versie Live.
• Als de interface een actieve planning heeft, kan het publiceren van een nieuw concept invloed hebben op de volgende run.

De live interface gebruiken

• Een Live interface is de gepubliceerde versie die BrynQ gebruikt voor runs.
• Gebruik Run om handmatig een run te starten als de interface handmatige runs toestaat.
• Gebruik Schedule om de interface automatisch te laten draaien.
• Gebruik View logs om eerdere runs, fouten en meldingen te bekijken.
• Als de interface actief is en een geldige planning heeft, kan BrynQ de interface zonder handmatige actie uitvoeren.

Een live interface wijzigen

• Selecteer Create draft om vanuit de live versie een nieuwe bewerkbare versie te starten.
• Selecteer Show draft als er al een concept bestaat.
• Bewerk het concept en publiceer het zodra het klaar is.
• Door het concept te publiceren wordt het de nieuwe live versie.
• Oudere live versies kun je bekijken. Het terugzetten van een oudere versie kan gegevens van latere versies verwijderen, dus doe dit alleen als je het zeker weet.

Interfacestatussen

Statussen helpen je te begrijpen of een interface kan draaien, wordt bewerkt of aandacht nodig heeft.

Versiestatussen

• Draft betekent dat de versie nog wordt voorbereid.
• Live betekent dat de versie is gepubliceerd en voor runs wordt gebruikt.
• Old version betekent dat de versie eerder live was, maar niet meer de nieuwste live versie is.
• In development betekent dat BrynQ nog aan de interface werkt. Je kunt de interface bekijken en mogelijk al autorisatie of mapping voorbereiden, maar voor sommige wijzigingen is mogelijk ondersteuning nodig.

Runstatussen

• Idle betekent dat de interface niet draait.
• Queued betekent dat de run wacht om te starten.
• Running betekent dat de interface data verwerkt.
• Stopping betekent dat BrynQ de run aan het stoppen is.
• Unknown betekent dat BrynQ geen duidelijke runstatus kan tonen.

Resultaten van de laatste run

• Successful betekent dat de run zonder fouten is afgerond.
• Completed betekent dat de run is afgerond, maar met fouten of waarschuwingen.
• Failed betekent dat de run niet succesvol is afgerond.
• Stopped betekent dat de run door een gebruiker is gestopt.
• Never run betekent dat er nog geen runhistorie is.

Goede werkwijzen

Doe deze controles voordat je een interface publiceert of uitvoert.

Voor het publiceren

• Controleer of Authorization compleet is voor de live omgeving.
• Controleer of verplichte velden in Configuration zijn ingevuld.
• Controleer of verplichte Scenarios en Mapping compleet zijn.
• Controleer of elk actief scenario een Unique key heeft als dat vereist is.
• Controleer de Schedule voordat je publiceert als de interface al automatisch draait.

Voor het uitvoeren

• Zorg ervoor dat de interface Active is.
• Zorg ervoor dat de bron- en doelapps actief zijn.
• Controleer of de interface handmatige runs, een planning of een andere interface als trigger gebruikt.
• Bekijk Variables als de run waarden nodig heeft die per run kunnen verschillen.
• Open View logs na een run als het resultaat mislukt is of met fouten is afgerond.

Meer informatie Gebruik Interfaces voor live en inactieve interfaces. Gebruik Setups om interfaces te vinden die nog een concept of inrichting in uitvoering hebben.