Dit artikel beschrijft de eisen die xential stelt voor on-premises installaties aan de server en de werkplekken waarop gebruikers (en beheerders) werken. Versienummers die vermeld worden zijn het absolute minimum. Xential streeft ernaar om telkens de nieuwste versies te testen en ondersteunen, maar behoudt zich het recht voor om in geval van incompatibiliteit met bepaalde onderdelen van de applicatie terug te vallen op zogenaamde long-term support versies.

Werkplekken

Dit hoofdstuk beschrijft de eisen die xential stelt aan het werkstation van de gebruiker en de applicaties waarmee xential compatibel is. De URL's waarop xential bereikbaar is, moeten worden opgenomen in de zone trusted sites van de organisatie. Verder worden werkplekken voorzien van het codesigning-certificaat van Interaction|next. De Java-componenten van xential zijn hiermee gewaarmerkt en worden hiermee als vertrouwd aangemerkt. De minimaal ondersteunde resolutie voor werkstations is 1280x1024 pixels. Op lagere resoluties is het mogelijk dat bepaalde onderdelen van xential minder overzichtelijk worden getoond. Voor gebruikers en beheerders moet het mogelijk zijn om CScript (C:\Windows\System32\cscript.exe) uit te voeren. CScript is onderdeel van Windows Script Host (WSH).
Systeemeisen werkplekken
BesturingssysteemMicrosoft Windows Ondersteunde versies: 8 en 10
Niet ondersteund ChromeOS, Linux distributies, MacOS en overige niet in dit overzicht vermelde versies
BrowsersVoor het gebruik van xential in combinatie met onderstaande browsers is ondersteuning beschikbaar. Browser(-versies) die in dit overzicht niet beschikbaar zijn, worden niet ondersteund.
Microsoft Edge Ondersteunde versies: 44 (EdgeHTML) en 91 (Chromium)
Mozilla Firefox ESR Ondersteunde versie: 78.11
Xential kan tevens worden gebruikt in combinatie met onderstaande browsers. Deze kennen echter een snelle releasecyclus. Het is dus mogelijk dat nieuwe versies van deze browsers niet volledig compatibel zijn met de huidige major release van xential.
Apple Safari
Google Chrome
Opera
Office-pakkettenMicrosoft Office Ondersteunde versies: 2010, 2013, 2016 en 2019
Microsoft Office 365 Voor informatie m.b.t. ondersteunde abonnementen: zie de paragraaf "Office 365"
Apache OpenOffice Ondersteunde versies: 4.1.7.
LibreOffice Ondersteunde versies: 6.3.6 (Still)
Java Runtime Environment (JRE)Om beheerwerkzaamheden uit te kunnen voeren, dienen applicatiebeheerders te beschikken over de 32 bits versie van Java Runtime (JRE) 8. Hiervoor kan zowel Oracle Java als het gratis open source alternatief AdoptOpenJDK gebruikt worden.
De URL's waarop xential bereikbaar is, horen te worden opgenomen in de Exception Site List van Java. Dit kan geconfigureerd worden op het Java Control Panel.
Het moet voor beheerders mogelijk zijn om Java Web Start te openen (javaws.exe). Het is mogelijk dat vanaf Java JRE 8 update 281 deze bestandsassociatie .jnlp niet meer correct functioneert. De bestandsextensie .jnlp moet in dat geval handmatig worden geassocieerd met Java Web Start.
Als er gebruik wordt gemaakt van een https-verbinding met xential, dienen de uitgevers van de certificaten in de "chain" aanwezig te zijn in de lokale "keystore" van Java. Als dit niet het geval is, dienen deze te worden toegevoegd en de "keystore" opnieuw uitgerold over de diverse werkstations.

Instellingen voor applicatiebeheerders

Xential|studio (de applicatie waarin sjablonen gebouwd worden) dient lokaal tijdelijk bestanden te kunnen opslaan. De locatie die daarvoor gebruikt wordt kan geconfigureerd worden door applicatiebeheerders te voorzien van de systeemvariabele xential_root_folder. De waarde van deze variabele geeft aan op welke locatie deze bestanden geplaatst moeten worden. Daar zal minimaal 100 MB beschikbaar moeten zijn. Als deze systeemvariabele niet aanwezig is, zal xential|studio proberen de persoonlijke directory voor tijdelijke bestanden (%TEMP%) aan te spreken.

Servers

Xential is een serverbased applicatie. Dit houdt in dat de software van xential en de bijbehorende configuratiebestanden op een server geïnstalleerd worden. Dit mag een gevirtualiseerde omgeving zijn. Xential vereist een dedicated server. Installatie van xential op een server die gedeeld wordt met andere applicaties wordt expliciet niet ondersteund. Xential vereist een gescheiden datapartitie van minimaal 20 GB. Afhankelijk van onder meer het aantal gebruikers, sjablonen en gekoppelde applicaties is het mogelijk dat de grootte van de datapartitie van xential in de loop van de tijd (aanzienlijk) verhoogd moet worden.

SSL-versleuteling

Xential verwerkt normaal gesproken (gevoelige) persoonsgegevens. Onder meer om deze reden is het dan ook noodzakelijk om de verbindingen van en naar de server te versleutelen. Xential ondersteund het gebruik van self-signed certificaten niet en vereist derhalve een bij een (door Oracle Java) erkende certificaatautoriteit uitgegeven certificaat. Dit mag zowel een zogenaamd wildcardcertificaat, als een voor de server aangevraagd certificaat betreffen. Het is mogelijk om te ondersteunen bij het genereren van het certificate signing request.

Hardware

De systeemeisen voor xential zijn sterk afhankelijk van de mate van gebruik. Xential maakt gebruik van caching mechanieken om zoveel mogelijk gegevens in het geheugen te houden, zodat de database niet continu belast wordt. Hoe meer geheugen beschikbaar is, hoe beter xential objecten kan cachen, en hoe beter de performance wordt.

Productieomgeving

De onderstaande configuraties en genoemde aantallen gebruikers en sjablonen dienen ter indicatie. De ideale configuratie is sterk afhankelijk van hoe vaak er documenten gebouwd worden, hoe vaak verschillende sjablonen gebruikt worden, etcetera. Dit zal dus altijd in de praktijk gemonitord moeten worden en eventueel bijgesteld als de performance niet toereikend is. Xential kan gebruikt worden in combinatie met Oracle, Microsoft SQLServer en/of MySQL. Deze laatste dient voor het opslaan van tijdelijke bestanden altijd op de server van xential geïnstalleerd worden. Mocht er gebruik gemaakt worden van Oracle of Microsoft SQLServer, dan dienen deze op een separate databaseserver geïnstalleerd te zijn. Voor het indexeren van data wordt Solr ingezet. Normaliter wordt deze op de server van xential geïnstalleerd (zoals in het rekenvoorbeeld ook wordt aangegeven), maar het is in overleg ook mogelijk om van een separate Solr-server gebruik te maken.

Testomgeving

Na de initiële uitrol van xential zullen updates van xential altijd eerst worden geïnstalleerd op een testserver. De applicatiebeheerder(s) van xential zullen deze update eerst moeten testen en accorderen voordat de update kan worden uitgerold in een productieomgeving. Het inzetten van gescheiden test- en productieservers is dan ook een vereiste. Voor testservers wordt ervan uitgegaan dat deze niet zwaar belast worden.
Productieserver 2.000 gebuikers
(200 concurrent users)
Processor cores:4
RAM:10 GB, verdeling geheugen:

  • Java applicatieserver: 6 GB
  • MySQL: 1 GB
  • Solr: 1 GB
  • OS en overhead: 2 GB
Productieserver 200 gebruikers
(20 concurrent users)
Processor cores:2
RAM:8 GB, verdeling geheugen:

  • Java applicatieserver: 4 GB
  • MySQL: 1 GB
  • Solr: 1 GB
  • OS en overhead: 2 GB
Testserver
Processor cores:2
RAM:6 GB, verdeling geheugen:

  • Java applicatieserver: 2 GB
  • MySQL: 1 GB
  • Solr: 1 GB
  • OS en overhead: 2 GB

Software

Besturingssysteem

Linux
Xential wordt primair geïnstalleerd op servers met een 64-bits versie van CentOS 7. Eventuele netwerklocaties waarop door xential documenten dienen te worden opgeslagen, horen bereikbaar zijn vanaf de server van xential. Dit kan bijvoorbeeld gerealiseerd worden door deze te mounten.

Windows
De installatie van xential kan ook op een Windows server uitgevoerd worden. De volgende versies van Windows Server worden ondersteund:
  • Windows Server 2012R2
  • Windows Server 2016
  • Windows Server 2019
N.B. De aanwezigheid van het .NET-framework is vereist voor het aanmaken van de Windows service voor xential. Als er gebruikt wordt gemaakt van een Windows server, zal xential als Windows service gestart worden. Hieraan dient een account gekoppeld te worden dat ten minste lokaal administrator is op deserver en schrijfrechten heeft op de diverse netwerklocaties waar documenten moeten worden opgeslagen, bijvoorbeeld de opslaglocaties voor afdelingsdocumenten.

Java Development Kit (JDK)

Onderstaande tabel beschrijft de benodigde versies per release van xential.
Xential versieJDKPayara
4.0.3Oracle Java Development Kit 8 update 131 (64 bit)4.1.1.171.1
4.0.4Adopt Open Java Development Kit 8 update 212 (64 bit)5.192
4.0.5Adopt Open Java Development Kit 8 update 212 (64 bit)5.192
4.0.6Adopt Open Java Development Kit 8 update 212 (64 bit)5.192
4.0.8Adopt Open Java Development Kit 8 update 242 (64 bit)5.194
4.0.9Adopt Open Java Development Kit 8 update 242 (64 bit)5.194
4.0.10Adopt Open Java Development Kit 8 update 242 (64 bit)5.194
4.0.11Adopt Open Java Development Kit 8 update 275 (64 bit)5.2020.7

Backups

De klant is verantwoordelijk voor het maken van backups van de servers en databases van xential. Voor xential is het van belang dat de configuratiedirectory (ook bekend onder de naam xential.home), de installatiedirectory van de Java applicatieserver en databases hierin volledig meegenomen worden. Het is van belang dat de backups van de configuratiedirectory en de database volledig synchroon verlopen om inconsistentie te voorkomen.

Databases

Xential vereist een MySQL/MariaDB database om tijdelijke data voor bepaalde onderdelen van de applicatie in op te slaan. Deze database hoeft niet te worden meegenomen in enige back-upprocedure. Voor de overige applicatiedata (waaronder de sjabloon- en gebruikersgegevens) kunnen onderstaande databases worden gebruikt. Hiervoor geldt dat xential niet verantwoordelijk is voor het maken, beheren en optimaliseren. Deze verantwoordelijkheid ligt te allen tijde bij de klant. Xential adviseert nadrukkelijk om deze databases wel in de standaard back-up-procedure van databases op te nemen. Xential is compatibel met de volgende databases:
MySQL / MariaDB
Ondersteunde versies: 5.5, 5.6 en 5.7 voor MySQL, 10.2, 10.3 en 10.4 voor MariaDB. De maximale grootte van packets moet worden ingesteld op 1 GB. Daarnaast moet het aantal toegestane connecties worden ingesteld op 5000.
Oracle
Ondersteunde versies: 11g, 12c release 1, 12c release 2 en 19c. Het minimaal aantal benodigde cursors is 500.
SQLServer
Ondersteunde versies: 2014, 2016, 2017 en 2019. Xential kan niet worden gebruikt i.c.m. Windows authenticatie. Er moet dus een specifieke databasegebruiker gemaakt worden met db_owner rechten.

Algemene database-instellingen

  • Minimale databasegrootte van 1 GB met een automatische groei van 10% of 100 MB.
  • Een databasegebruiker voor xential met volledige rechten op de database.
De inhoud van de database wordt door de applicatie zelf aangemaakt, er hoeven vooraf dan ook geen scripts te worden uitgevoerd. Xential maakt geen gebruik van database specifieke functionaliteiten. Daarnaast stelt xential geen specifieke eisen aan de architectuur van de databaseserver.

Authenticatie

Xential ondersteunt een aantal authenticatiemethodes. Dit hoofdstuk beschrijft de bijbehorende eisen die xential stelt aan de inrichting van deze methodes.

Azure Active Directory

Xential beschikt over een module waarmee gebruikers kunnen inloggen met behulp van hun Microsoft-account. Hiertoe dient xential als native application in Azure AD geregistreerd te worden. Daarbij is de delegated permission Sign in and read user profile verplicht.

Active Directory Federation Services

Xential beschikt over een module voor ondersteuning van het SAML-protocol. Deze kan onder andere gebruikt worden om gebruikers via AD FS in te laten loggen op xential. Xential stelt de volgende eisen aan de inrichting van AD FS:
  • Xential ondersteunt Windows Server 2016 AD FS. Er is niet getest met lagere versies zoals Windows Server 2012 R2 / AD FS 3.0.
  • Connectiviteit van en naar het AD FS endpoint (https://hostname)/adfs/ls/) dient beschikbaar te zijn en naar behoren te functioneren.
  • Xential dient als claims-aware application toegevoegd te worden binnen AD FS.
  • Ten behoeve van de gebruikersadministratie in xential dienen er claims toegevoegd te worden. Deze claims bevatten de gebruikersgegevens die xential automatisch in documenten verwerkt. Welke gegevens dit zijn is afhankelijk van de documenten die u door middel van xential opstelt.
  • Azure AD MFA wordt op dit moment nog niet ondersteund.

Kerberos

Deze functionaliteit maakt gebruik van het authenticatieprotocol Kerberos. Om Kerberos in te kunnen zetten is een VPN-verbinding met de SaaS-omgeving van xential benodigd.

Integraties

Office 365

Xential beschikt over een optionele integratie met Office 365. Om deze integratie te kunnen gebruiken dient deze te voldoen aan onderstaande eisen.
  • Xential dient bereikbaar te zijn via een SSL-verbinding. Mogelijk moet er dus een certificaat worden aangevraagd voor de server(s) van xential.
  • De cloudservices van Microsoft moeten bereikbaar zijn vanaf de server(s) van xential.
  • De integratie kan in combinatie met één SharePoint Online tenant (tegelijk) gebruikt worden.
  • Het abonnement op Office 365 dient SharePoint Online te bevatten, met minimaal één teamsite en één document library per teamsite.
  • Het abonnement op Office 365 dient OneDrive For Business te bevatten.
  • Het abonnement op Office 365 dient (voor beheerdoeleinden) de desktopversie van Word te bevatten.
  • Xential moet in Azure AD geregistreerd worden als native application. Om delegation succesvol uit te kunnen voeren zijn de volgende permissions van toepassing:
    • Van de API “Microsoft Graph” is de delegated permission “Sign in and read user profile” verplicht;
    • Van de API “SharePoint” zijn de delegated permission “Read and write items in all site collections” en “Read user profiles” en noodzakelijk. Voor deze laatste permissie is beheerderstoestemming (admin consent) benodigd.
  • Het is mogelijk om xential middels een URL door te starten uit Office 365, mits het een site betreft die beschikbaar is onder het domein waarvoor xential geconfigureerd is.
  • De integratie biedt geen ondersteuning voor invoegtoepassingen van derde partijen.
  • De integratie kan niet worden gebruikt in combinatie met Seamless Single Sign-On.