XSD-schema ophalen met DataConnector (AppConnectorData)
Er zijn meerdere manieren om de beschrijving/specificatie van velden in een UpdateConnector op te halen.
Let op:
Deze beschrijving heeft betrekking op SOAP/XML. Gebruik je REST/JSON? Dan haal je de specificatie op via AFAS Connect.
Het XSD-schema beschrijft de velden die je via een UpdateConnector kunt aanleveren en enkele technische regels. Zoals de indeling van het XML-bericht of maximale lengte van elk veld. Het XSD-schema kan je helpen om zelf beter te weten wat bepaalde velden doen. Ook kun je het XSD-bestand gebruiken om via andere software een XML-bestanden te controleren of om een voorbeeld XML-bestand te genereren voor de Updateconnector.
Tip: Je kunt bepaalde controles en handelingen makkelijk uitvoeren via NotePad++ als je de daarvoor beschikbare XML-plugins installeert.
|
Inhoud |
DataConnector activeren (verplichte stap voor elke methode)
Let op:
Voor het gebruik van deze functies moet de connector GetXMLSchema (dit is de DataConnector) in de eigenschappen van de app connector geactiveerd zijn.
- Open de omgeving waarin je de connectoren gebruikt.
- Ga naar: Algemeen / Beheer / App connector.
- Open de app connector, tabblad Connectoren.
- Klik op Nieuw en voeg GetXMLSchema toe.
Meer informatie:
Methode 1: Aanroep via AFAS Connect
Via de onderstaande stappen haal je de XSD op via AFAS Connect. Je kunt de XSD ook ophalen door de DataConnector via een webservice aan te roepen.
- Start https://connect.afas.nl en log in.
- Ga naar: SOAP/XML / Retrieve XSD/Create XML.
- Gebruik de stappen
voor de aanroep. - Vul de naam van de UpdateConnector in.
- Gebruik Create XML om een leeg XML-bestand op te halen. Je kunt dit eventueel downloaden en de velden zelf vullen.
- Gebruik Retrieve XSD om het XSD-bestand op te halen. Je kunt dit eventueel downloaden.
Je kunt externe tools gebruiken om de XSD te raadplegen en om de XML te valideren, zoals Notepad++ (AFAS verleent geen ondersteuning op deze tools). Hieronder zie je een voorbeeld van Notepad++ met gebruik van de Plug-in XML-tools.
Methode 2: Aanroep via SOAP
Ondersteunt je software dit (bijvoorbeeld SOAP UI), lees dan het WSDL-document in van het DataConnector-endpoint: /appconnectordata.asmx?wsdl.
Voorbeeld:
Productie-omgeving van abonnement 12345.
Aanroep: https://31425.soapaccept.afas.online/profitservices/appconnectordata.asmx?wsdl.
Doe voor het opvragen van het XSD-schema een ‘Execute’ call naar het endpoint, met het juiste SOAP-schema.
Velden:
- token
Token van de gebruiker die de connector uitvoert. Je moet een CDATA-tag gebruiken bij de token, zie het te downloaden XML-voorbeeld.
- dataID
Vaste waarde: GetXmlSchema
- parametersXML
De technische naam van de UpdateConnector (bijvoorbeeld 'KnPerson'). Je vindt de technische naam van de UpdateConnector op de volgende plaatsen:
- In AFAS Connect, bij de aanroep van een UpdateConnector.
- In de eigenschappen van de App Connector, tabblad UpdateConnector.
- In het overzicht van alle UpdateConnectoren.
Output omzetten:
Wanneer je XML-bestand compleet is voer je een Execute uit op het DataConnector endpoint. Je ontvangt een bestand dat nog omgezet moet worden in een normale XML. Wil je zelf met het bestand aan de slag (in plaats van geautomatiseerd in bepaalde software) dan kan je voor deze acties bijvoorbeeld Notepad++ met de daarbij beschikbare XML-plugins gebruiken.
- Als je hebt gekozen voor <EncodeBase64>true</EncodeBase64> ontvang je in de response een XML met daarin een Base64. Je kan het Base64 deel decoden.) Na het decoden van de Base64 krijg je een XML te krijgen met in de ‘Schema’ tags het XSD-schema. De < en > tekens zijn ge-escaped naar < en >, vertaal die zo nodig terug.
- Als je hebt gekozen voor <EncodeBase64>false</EncodeBase64> hebt krijg je als response een XML met in de ‘ExecuteResult’ tags het XSD-schema. De < en > tekens zijn ge-escaped naar < en >, vertaal die zo nodig terug.
Zie ook:
|
Direct naar
|