GeolinQ
Support Portal

XML Script

GeolinQ XML script automatiseert veel voorkomende beheerprocedures door operaties te definiëren in een XML script. Voor het XML script is een XSD beschikbaar om het XML script te kunnen genereren en te kunnen valideren: https://schema.geolinq.nl/script/script.xsd. Het XML script opgezet met als doel dat gebruikers ook eenvoudig zelf scripts kunnen aanmaken en aanpassen. Het XML script wordt uitgevoerd als een taak op de taakserver waarna een log beschikbaar is van de uitvoering van het script.

Script context

Het XML Script bestaat uit een lijst operaties in een context. Afhankelijk van de context kunnen operaties worden uitgevoerd. In een databron context kunnen bijvoorbeeld geen tenant functies zoals CreateTenant worden uitgevoerd.

Context Omschrijving
Root Context Context van de root tenant waarop onderliggende tenants beheerd kunnen worden.
Tenant Context Context van de tenant waarop databronnen, gebruikers en gebruikersgroepen worden beheerd.
Datasource Context Context van de databron waarop datasets, klasse definities, processen en schermen worden beheerd.

Aanmaken van een XML script

Het XML script wordt aangemaakt door operatie toevoegen aan een XML document met de volgende structuur:

<?xml version="1.0" encoding="UTF-8"?>
<Script xmlns="http://www.geolinq.com/script"> 
  <Header>
    <Name>My Script Title</Name>
  </Header>
  <Operations>
    <CreateTenant>
      ...
    </CreateaTenant>
    <UpdateDatasource>
      ...
    </UpdateDatasource>
    ...
  </Operations>
</Script>

Het script heeft de target namespace http://www.geolinq.com/script en wordt door GeolinQ gevalideerd aan een XSD. Het script begint altijd met het element Script gevolgd door een header en een lijst met operaties in een tenant of root tenant context.

De header start met Header element en in de header wordt verplicht de naam van het script opgenomen in het element Name.

De operaties van het script worden gedefinieerd tussen de Operations elementen van het script. Het script draait in de context van de tenant waarop de taak met het script is gestart. Dit betekent dat de root tenant context voor de root tenant en de tenant context voor een onderliggende tenant. 

Het XML script kan onderdeel uit van een ZIP bestand waarin alle aanvullende bestanden worden opgenomen die nodig zijn tijdens het uitvoeren van het script. Het script kan ook als XML bestand worden uitgevoerd als het script geen referenties naar importbestanden heeft.