Verbinding met lokale map via ClientConnector tool

Verbinding met lokale map via ClientConnector tool

Als je financiële software geen ingebouwde e-facturatie-functionaliteit heeft, maar het exporteren naar of het importeren uit een lokale map wel ondersteunt, bieden we de mogelijkheid te verbinden met een lokale map.

In deze instructiepagina behandelen we de inrichting van de ClientConnector tool. Dit is een commandline programma dat nieuwe documenten ontvangt en verzendt op basis van een mappenstructuur per bedrijf en documenttype. Hiermee blijft de uitwisseling met het eConnect-platform optimaal veilig.

AlertLet op! Voor het inrichten van de ClientConnector is uitgebreide kennis van IT vereist.

Wat zijn de minimale vereisten voor de ClientConnector?

  • Deze moet op een Windows machine draaien - er zijn geen versies voor andere besturingssystemen
  • .NET framework 4.6.1 of hoger dient aanwezig te zijn
  • Er moet verbinding naar buiten mogelijk zijn over poort 443 richting het eConnect endpoint (wordt vermeld in de subscription key)
  • Zorg dat de software gestart mag worden/exetutable is en lees- en schrijfrechten heeft in de werkmap
  • Voor de tool zelf is 1 MB schijfruimte vereist plus ruimte voor het downloaden van de bestanden (variabel op basis van aantal te verwerken documenten, inclusief de eventuele pdf)
  • Er zijn geen verdere systeemvereisten qua processor, geheugen etc., het is een erg lichte app en de systeembelasting is vrijwel nihil.

Stap 1 – Maak de werkomgeving aan

  • Als u beschikt over een subscriptionKey dan kan er gebruik worden gemaakt van de laatste versie EConnectCommandLine_1_0_10_1 (zie bijlage). Neem contact op met sales@econnect.eu om een subscriptionKey aan te vragen.

Stap 2 – Genereer de beveiligingssleutels

Volg deze link en de instructies in Stap 1

Stap 3 – Selecteer Organisatie-ID

Selecteer Organisaties en daarna de organisatie waarvoor documenten moeten worden opgehaald of verzonden.


Bij de organisatie is het Extern-ID te vinden wat u nodig heeft tijdens het instellen van de config als CompanyID. 

Stap 4 – Stel de configuratie in

Vul de waarden in de application settings in en controleer deze. Gebruik de beveiligingssleutels uit stap 2. De waarden kunnen overruled worden door deze mee te geven als argument.
De volgende waarden dienen aangepast te worden voor het gebruik.

  1. Vul de beveiligingsgegevens uit Stap 2 in bij ConsumerKey, ConsumerSecret en RequesterId.
  2. Vul Organisatie-ID in uit Stap 3 in bij CompanyId.
  3. Vul de locatie in voor de documenten moeten komen die opgehaald worden of waar de documenten vandaan komen voor verzending in bij WorkingDirectory. Deze directory behoort voor gebruik aangemaakt te worden. Bijvoorbeeld: {{ComapnyId}}\{{DocumentType}}  of XCAB123456\Inbox (Deze locatie is relatief ten opzichte van de huidige directory.)
  4. Met DocumentType wordt aangeven welke documenten gedownload moeten worden (Inbox of Outbox) of dat documenten verzonden dienen te worden (Send)
  5. Geef met PDFDownload of het document ook als .pdf file moet worden opgehaald.
  6. Standaard waarden (alleen aanpassen in overleg): MasterTemplateId, ConversionPartnerGroupId, ConversionFileExtensions, ConversionPartner, TransformXSLT, AddExternalId, CleanXML, Action
Sinds versie 1.0.1 is er een subscriptionKey nodig. Deze wordt op aanvraag toegezonden, hiervoor is een API abonnement vereist. De subscriptionKey moet worden ingevuld in de sectie //system.serviceModel/client/endpoint  onderaan de configuratie file. Een voorbeeld van een configuratiefile is als bijlage toegevoegd.
Stap 5 – Test de werking

Start de ClientConnector via de commandline of snelkoppeling als volgt: EConnectCommandLine.exe -help

  • Voorbeeld: download inbox documenten
    EConnectCommandLine.exe -w C:/EConnect/XCNL10019/Inbox/ -t inbox -c XCNL10019 -d 2016-03-01
  • Voorbeeld: download outbox documenten
    EConnectCommandLine.exe -w C:/EConnect/[CompanyId]/[DocumentType]/ -t outbox -c XCNL10019 -d 2016-03-01
  • Voorbeeld: Verstuur documenten
    EConnectCommandLine.exe -w C:/EConnect/XCNL10019/Send/ -t send -c XCNL10019

 Enkele opmerkingen bij het gebruik

  • De ClientConnector zal een .econnect bestand aanmaken waarin wordt bijgehouden wat het laatste moment van bijwerken is geweest. De inhoud van dit bestand kan worden aangepast op documenten met een eerdere datum en tijd op te halen.
  • Er wordt na het downloaden en opslaan van de XML-factuur ook een PDF-factuur aangemaakt met de zelfde naam maar met de .PDF extensie in dezelfde map. Indien de PDF in de XML als ‘primary file’ aanwezig is wordt deze hiervoor gebruikt en in de andere gevallen wordt de PDF gegenereerd op basis van de informatie in de XML. Dit is uit te zetten doormiddel van de optie "-p false" of de value bij PDFDownload op "false" te zetten in de config file.
  • De ClientConnector kan meerdere keren worden opgestart en als parallelle processen draaien. Hier is vanuit de app zelf geen controle op.
  • Alle applicationSettings uit de config file zijn ook mee te geven als optie. Gebruik  EConnectCommandLine -? om alle mogelijke opties te weer te geven.
  • Er wordt een log-bestand aangemaakt in de map waar de programmabestanden staan. Dit kan aangepast worden in de config in de log4net sectie. Zie ook https://logging.apache.org voor meer voorbeelden. Zie hiervoor in het //log4net deel in het config bestand. In dit deel kan er ook gekozen worden om via EventLogAppender de logs in de Windows Event logs te laten komen.
  • Alleen *.xml bestanden worden behandeld bij het versturen in de werkmap.
  • De bestandsnaam wordt hernoemd na het versturen door een toevoeging, ‘.done’ indien succesvol, of ‘.error’ als er iets fout is gegaan.

Belangrijke verzendvelden in de SI-UBL

De gegevens voor de ontvanger staan in (volgorde van belangrijkheid):

//cac:AccountingCustomerParty/cac:Party/cbc:EndpointID

//cac:AccountingCustomerParty/cac:Party/cac:PartyLegalEntity/cbc:CompanyID

//cac:AccountingCustomerParty/cac:Party/cac:PartyTaxScheme/cbc:CompanyID

E-mail adres:

//cac:AccountingCustomerParty/cac:Party/cac:Contact/cbc:ElectronicMail

//cac:AccountingCustomerParty/cac:AccountingContact

//cac:AccountingCustomerParty/cac:BuyerContact

Er dient minimaal bij voorkeur 1 ID en 1 E-mail adres ingevuld te worden. Het E-mail adres is optioneel maar kan leiden tot een foutmelding tijdens het verzenden als het document niet op basis van het ID afgeleverd kan worden. Om goede controle te houden over de routering van het document is het advies om cbc:EndpointID te gebruiken. Dit geeft de mogelijkheid om te versturen op basis van btw (VAT) nummer en ook het KvK nummer ingevuld te hebben. Zonder cbc:EndpointID wordt er verstuurd op KvK nummer als deze aanwezig is.

Sinds versie 1_0_4_2 is het ook mogelijk om NLCIUS te versturen met getallen als identifiers. Zoals 0106: voor de NL:KVK: en de 0190: voor de NL:OIN:.


IdeaTIP : Stel een automatische taak in (Windows)

    • Related Articles

    • 4PS koppelen met eConnect

      1. Softwarekoppeling: eConnect Ben je intermediair/accountant volg dan de stappen voor het koppelen via een machtigingsverzoek. 2. Inrichting in 4PS Construct Voor een koppeling met 4PS is een contract nodig voor API rechten. Hiervoor kan contact ...
    • Koppelen met QicsMilestones

      Vanuit QicsMilestones is het ook mogelijk om de verkoopfacturen te versturen via eConnect. Om dit te kunnen doen heb je een koppeling nodig en dien je daarna een aantal instellingen aan te passen. 3. Koppelen met QicsMilestones. In QicsMilestones ga ...
    • Koppelen met QicsTime

      Hieronder leggen we uit hoe je de koppeling met QicsTime tot stand brengt. 1. Softwarekoppeling: eConnect Ben je intermediair/accountant volg dan de stappen voor het koppelen via een machtigingsverzoek. 2. Inrichting in QicsTime QicsTime kan vanaf ...
    • AFAS koppelen met eConnect

      Hieronder leggen we uit hoe je de koppeling met AFAS tot stand brengt. Bekijk je liever de instructievideo? Klik dan hier. 1. Softwarekoppeling: eConnect Ben je intermediair/accountant volg dan de stappen voor het koppelen via een machtigingsverzoek, ...
    • SnelStart koppelen met de Autopilot

      Je kunt met de Autopilot koppelen als: Je toegang hebt tot alle organisaties in het platform; Je de beheerder bent in SnelStart; De administratie van SnelStart staat online. Hieronder leggen we in stappen uit hoe je SnelStart met de Autopilot kan ...