Client Online connector – Serviceomgeving PinkWeb

Wat doet de koppeling

De Client Online Connector wordt gebruikt om documenten ter accordering aan te bieden aan cliënten in Client Online voor externe software pakketten waar er geen directe koppeling beschikbaar is. Bestanden uit het bronpakket worden opgeslagen op een netwerk schijf of locatie. De Client Online Connector ondersteunt zowel XBRL als PDF documenten.

Hoe werkt de koppeling

De Client Online Connector wordt door Visma | PinkWeb geconfigureerd en leest een mappenstructuur uit om te bepalen welke documenten ter accordering moeten worden aangeboden.

XBRL

Bij XBRL documenten wordt er één map geconfigureerd. De bestanden in deze map worden automatisch elke minuut gecontroleerd en naar Client Online gestuurd, zodat deze geaccordeerd kunnen worden. Client Online bepaalt automatisch op basis van de inhoud van het document bij welke cliënt het document hoort, en wat voor soort document het is.

Voorbeeld:

C:\Client Online Connector\

C:\Documenten\Naar portal\

PDF

Bij PDF documenten wordt er een map geconfigureerd per PDF documenttype die geaccordeerd dienen te worden. Omdat PDF documenten niet kunnen worden uitgelezen, dient de mappenstructuur en de bestandsnaam aan een aantal voorwaarden te voldoen, namelijk:

In de mappenstructuur moet een map bestaan die alleen het jaartal bevat;
In de mappenstructuur moet een map bestaan die alleen de periode bevat;
De bestandsnaam dient een identificatienummer van de cliënt te bevatten waarvoor het document ter accordering aangeboden dient te worden;
Het identificatienummer in de bestandsnaam dient als eerste in de bestandsnaam te staan, en wordt gescheiden van de rest van de bestandsnaam door middel van een underscore (“_”).

Voorbeeld:

C:\Client Online Connector\Omzetbelasting\2021\januari\12345_document.pdf

C:\Client Online Connector\Omzetbelasting\	Basispad, wordt geconfigureerd door Visma \| PinkWeb. Dit basispad wordt door de Client Online Connector gebruikt om het documenttype te bepalen
2021\	Jaartal waarover het document gaat. De Client Online Connector gebruikt het jaartal in de mapnaam om het jaartal te bepalen. Alle mappen op deze positie worden beschouwd als jaartal, en kunnen door de gebruikers van de Client Online zelf toegevoegd of verwijderd worden. De positie van het jaartal in de mappenstructuur wordt door Visma \| PinkWeb geconfigureerd en kan afwijken van het voorbeeld.
januari\	Periode waarover het document gaat. De Client Online Connector gebruikt de periode in de mapnaam om de periode te bepalen. Alle mappen op deze positie worden beschouwd als periode, en kunnen door de gebruikers van de Client Online Connector zelf toegevoegd of verwijderd worden. De positie van de periode in de mappenstructuur wordt door Visma \| PinkWeb geconfigureerd en kan afwijken van het voorbeeld.
12345	Identificatienummer van de client in de bestandsnaam.
_	Scheidingsteken tussen identificatienummer en de rest van de bestandsnaam.
document.pdf	Het overige gedeelte van de bestandsnaam

Indien het document een datum als periode vereist, dan dient er een map in de structuur aanwezig te zijn die de volledige van en tot datum bevat. Het formaat van deze datum staat vast. de van en tot datum worden gescheiden door een spatie streepje spatie (“ - “).

Voorbeeld:

C:\Client Online Connector\Jaarrekeningen\01-01-2020 - 31-12-2020\12345_document.pdf

Documenten door de koppeling verwerkt

Wanneer het document door de Client Online Connector verwerkt is en er is geen fout opgetreden bij het plaatsen van het document in Client Online, dan wordt het document automatisch verplaatst naar de map “Processed”. Deze map wordt door de Client Online Connector automatisch aangemaakt indien deze niet bestaat, op de positie waar het document initieel gevonden is.

Wanneer het document door de Client Online Connector verwerkt is, en er een fout optreed bij het plaatsen van het document in Client Online, dan wordt het document automatisch verplaatst naar de map “Error”. Deze map wordt door de Client Online Connector automatisch aangemaakt indien deze niet bestaat, op de positie waar het document initieel gevonden is. Tevens wordt er een koppelfout e-mail verstuurd door Client Online met een omschrijving van het probleem.

Wanneer Client Online tijdelijk niet bereikbaar is probeert de Client Online Connector automatisch het document opnieuw in Client Online te plaatsen. Het document wordt daarom niet verplaatst.

Wanneer het document in de “Processed” of “Error” map staat, is het document door de koppeling verwerkt, en wordt het daarna niet meer door de koppeling aangeraakt. Er vindt geen status terugkoppeling plaats na het accorderen door de cliënt.

Technische informatie

De Client Online Connector koppeling werkt op basis van een door Visma | PinkWeb ingekocht product genaamd Frends (uitgebracht door HiQ Finland), en wordt ondersteund door Visma Connect. Om de Client Online Connector koppeling te gebruiken dient er een Frends agent geïnstalleerd te worden op een server in het netwerk van het kantoor. De Frends agent is een programma dat taken kan uitvoeren op basis van signalen en processen die het ophaalt. Dit zorgt er voor dat een Frends agent meerdere taken kan uitvoeren, en doordat de Frends agent verbinding maakt naar buiten, hoeft er geen port forwarding plaats te vinden. De Frends agent draait als een service namens een gebruiker. De systeembeheerder kan de rechten van deze gebruiker naar wens beperken, met inachtneming van de werking van de gewenste koppeling. Meer informatie over de werking van een Frends agent is beschikbaar via de documentatie van Frends.

Voorwaarden voor gebruik

De koppeling dient te worden geïnstalleerd op een server die minimaal aan de volgende eisen dient te voldoen:

Windows Server 2012 R2 (of hoger)
.NET framework 4.7.1
Bij voorkeur 4vcpu, 8GB RAM geheugen, 1 GB hardeschijfruimte
Het hangt sterk af van de hoeveelheid documenten en het gebruik van de koppeling hoeveel geheugen en andere resources benodigd zijn.
Outbound internet toegang via poort 443 (voor https) en poorten 9350 t/m 9354, poort 5671 en 5672 (voor Azure service bus zonder restrictie op IP adressen)
Een Windows gebruiker namens wie de service draait, met lees-toegang tot de benodigde mappen op het netwerk, en schrijf-toegang tot de benodigde mappen op het netwerk.

Foutmeldingen

Wanneer er iets mis gaat, geeft Client Online doorgaans duidelijk aan wat er aan de hand is, al dan niet aan de hand van een koppelfouten e-mail.
Controleer in ieder geval het volgende:

Staat het bestand dat opgepakt dient te worden in de juiste mappenstructuur? Zie de voorbeelden onder XBRL en PDF.
Het bestand dat geplaatst wordt mag momenteel niet groter zijn dan 50 MB, het wordt automatisch verplaatst naar de “Error” map.
Het bestand mag niet opgepakt worden indien het een ander bestandstype betreft dan XBRL of PDF.
De Frends agent service draait
De Frends agent service gebruiker heeft toegang tot de juiste mappen en bestanden

Indien bovenstaande het probleem niet verhelpt, neem contact op met Visma | PinkWeb Support.

Verwante artikelen