MatrixProject Services 4.0

Deze pagina beschrijft de services voor MatrixProject (waaronder Matrix.Drive).
Deze pagina is van toepassing voor MatrixMetaal Project versie 4.0 MatrixKozijn Project 4.0.

Voor de services van MatrixKozijn Project MES zie:

Configuratie Tool

Vanaf MatrixProject 3.0 Service pack 2 is er een Configuratie Tool beschikbaar om de service in te richten, te starten en de logs te bekijken.
Kies in de Configuratie Tool voor Wizard Configuraie om een wizard te starten die u in een aantal stappen begeleid bij de configuratie.

Opbouw MatrixProject Services

MatrixProject bestaat uit verschillende services.

De onderstaande afbeelding geeft een schematisch overzicht:

MatrixProject ServicesMxP_Services_40.png diagram
MatrixProject Services diagram

Services van MatrixProject:

Matrix.Drive.Server

Matrix.Drive.Server is een NodeJS server die het documentenbeheer via Matrix.Drive regelt. Deze vervangt het documentenbeheer in MatrixKozijn Project 2.4.

De service Drive.exe wordt als een Windows service geregistreerd tijdens de installatie via 'NssM'.

Configuratie

Via de Configuratie Tool kan de configuratie aangepast worden (zie ook: Configuratie MatrixKozijn Project Services 4.0 (SP9) Server of Configuratie MatrixMetaal Project Services 4.0 Server).

Standaard draait deze service op poort 1337.

De configuratie wordt ook opgeslagen in het bestand config.json in de map van de service

Instellingen:

  • Host
    De host waarop de Matrix.Drive.Server service bereikt kan worden. Er kan gekozen worden voor:
    Lokaal - De service bind zich aan de localhost (127.0.0.1) en kan niet van buitenaf bereikt worden
    Publiek - De service bind zich aan de publieke IP-Adressen en kan van buitenaf bereikt worden
    Geadviseerd wordt om Publiek te kiezen.
  • Poort
    De poort waarop de service bereikt kan worden. Er kan gekozen worden voor:
    Automatisch - De service bind zich aan een vrije poort
    Afwijkend - De service bind zich aan de popgegeven poort (standaard 1337)
    Geadviseerd wordt om Afwijkend te kiezen met als standaard poort 1337.
  • Privésleutel
    Een sleutel (https://jwt.io/) om de gebruiker te versleutelen.
    De waarde kan niet aangepast worden..
  • Opslaglocatie
    De locatie waar de bestanden worden opgeslagen. Deze kan aangepast worden naar een andere locatie.
    UNC paden (https://en.wikipedia.org/wiki/Path_(computing)#UNC) zijn toegestaan.
    Bijvoorbeeld: \\ComputerName\SharedFolder\Resource

    Het account waaronder de Matrix.Drive.Server draait dient voldoende rechten te hebben op de opgegeven locatie om bestanden te schrijven (Modify).
    Het is aan te raden een netwerk share te gebruiken waar de service toegang tot heeft, maar normale gebruikers niet.
    Belangrijk: Gebruik geen drive mappings/redirected drives maar altijd een volledige verwijzing naar een netwerk share of een lokale map (zie ook: https://docs.microsoft.com/en-us/windows/win32/services/services-and-redirected-drives).
    Bij het gebruik van een "\" dient de door een "\" vooraf gegaan te worden om het teken te 'escapen'.
    Voor het aanpassen van het account waaronder de service draait zie: Matrix.Drive.Server service account

  • Backuplocatie
    De locatie waar de backups worden weggeschreven
  • Mongo DB Gebruiker
    De gebruiker waarmee verbinding wordt gemaakt met MongoDB.
  • Mongo DB Wachtwoord
    Het wachtwoord waarmee verbinding wordt gemaakt met MongoDB.
  • Mongo DB Host
    De hostnaam (of IP) waarop MongoDB server bereikt kan worden.
  • Mongo DB Poort
    De poort waarop MongoDB server bereikt kan worden.
  • Mongo DB Database
    De naam van de database de benader wordt op de MongoDB server.
  • Mongo DB tools (pad)
    Locatie naar de tools bestanden van MongoDB/ Deze worden o.a. gebruikt bij het maken van een backup.

Foutopsporing

De Matrix.Drive.service service schrijft zijn logs in de map log binnen de installatiemap van de service.
Indien men inlogt op de site van de service (http://iphost:port) dan wordt men doorvewezen naar een pagina die het laatste log toont.

Ook kunnen de logs eenvoudig bekenen worden via de Configuratie Tool.

MongoDB

Matrix.Drive maakt gebruik van MongoDB om de objecten op te slaan in een Object database.
Zie ook: https://www.mongodb.com/download-center/community

Minimaal vereist is mongodb-win32-x86_64-2012plus-4.2.5-signed. MongoDB  (Community Edition) kan door de setup van MatrixProject gedownload en geïnstalleerd worden. Eventueel kan MongoDB handmatig geïnstalleerd worden door deze te downloaden via de volgende link: https://downloads.matrix-software.biz/misc/MongoDB/mongodb-win32-x86_64-2012plus-4.2.5-signed.msi.

De standaard installatie locatie is: %programfiles%\MongoDB\Server\4.2.

Standaard draait deze service op poort 27017.

Met het bestand mongod.cfg in %programfiles%\MongoDB\Server\4.2\bin kan MongoDB geconfigureerd worden.

Matrix.MxProject.Web.Service

Service voor het afhandelen van verzoeken van de MatrixProject website (Matrix.Project.Server).

Configuratie

Via de Configuratie Tool kan de configuratie aangepast worden (zie ook: Configuratie MatrixKozijn Project Services 4.0 (SP9) Server of Configuratie MatrixMetaal Project Services 4.0 Server).

Standaard draait deze service op poort 8025.

De configuratie wordt ook opgeslagen in het bestand Matrix.MxProject.Web.Service.exe.json.

Instellingen:

  • Host
    De host waarop de Matrix.MxProject.Web.Service service bereikt kan worden. Er kan gekozen worden voor:
    Lokaal - De service bind zich aan de localhost (127.0.0.1) en kan niet van buitenaf bereikt worden
    Publiek - De service bind zich aan de publieke IP-Adressen en kan van buitenaf bereikt worden
    Geadviseerd wordt om Publiek te kiezen.
  • Poort
    De poort waarop de service bereikt kan worden. Er kan gekozen worden voor:
    Automatisch - De service bind zich aan een vrije poort
    Afwijkend - De service bind zich aan de popgegeven poort (standaard 8025)
    Geadviseerd wordt om Afwijkend te kiezen met als standaard poort 8025.
  • Timeout
    Timeout in seconden voor de service

Let op: Het is van belang dat de licentie de juiste Technische modules bevat voor het gebruik van onderdelen in de Website.
221 (TijdReg - Mobile Website), 434 (TijdReg - Lite) en 436 (TijdReg - Full) voor de tijdregistratie

Foutopsporing

De service schrijft meldingen en fouten naar het Windows Aplication eventlog.
Zoek naar de bron Matrix.MxProject.Web.Service.

Ook kunnen de logs eenvoudig bekeken worden via de Configuratie Tool.

Matrix.Project.Server

Matrix.Project.Server is een NodeJS server die een website voor onderdelen (Urenregistratie, Tijdregistratie) van MatrixProject beschikbaar stelt.

De service MxPWeb.exe wordt als een Windows service geregistreerd tijdens de installatie via 'NssM'.

Configuratie

Via de Configuratie Tool kan de configuratie aangepast worden (zie ook: Configuratie MatrixKozijn Project Services 4.0 (SP9) Server of Configuratie MatrixMetaal Project Services 4.0 Server).

De website draait bij een standaard installatie op poort 1335 op de machine waar de service is gestart.

De configuratie wordt ook opgeslagen in het bestand config.json in de map van de service.

De service wordt automatisch gekoppeld aan alle IP-adressen van de server waarop de service draait. Indien gewenst kan de service op een Localhost (127.0.0.1) worden geconfigureerd.

Het benaderen van camera's werkt alleen in een beveiligde website (HTTPS), hiervoor is het noodzakelijk om een certificaat en bijbehorende key op te geven.

De configuratie wordt ook opgeslagen in het bestand config.json in de map van de service.

  • Host
    De host waarop de Matrix.Drive service bereikt kan worden. Er kan gekozen worden voor:
    Lokaal - De service bind zich aan de localhost (127.0.0.1) en kan niet van buitenaf bereikt worden
    Publiek - De service bind zich aan de publieke IP-Adressen en kan van buitenaf bereikt worden
    Geadviseerd wordt om Publiek te kiezen.
  • Poort
    De poort waarop de website service bereikt kan worden.
    Geadviseerd wordt om te kiezen voor de standaard poort 1335.
  • SSL Certificaat
    Pad naar het bestand met het Certificaat voor het draaien van de service als https
  • SSL Privésleutel
    Pad naar het bestand met de Private key voor het certificaat

Foutopsporing

De Matrix.MxProject.Web service schrijft eventuele details over fouten naar het bestand "\Matrix\MatrixProject Services\Matrix.MxProject.Web\service-error.log".

Ook kan het log van de service zelf eenvoudig bekeken worden via de Configuratie Tool.

Firewall

Indien de services van MatrixProject vanaf andere locaties benaderd worden is toegang via de firewall nodig.

Bij standaard instellingen draaien de services op de volgende poort. Zorg dat deze poorten geopend zijn (inbound) in de firewall:

  • Matrix.Drive.Server: poort 1337 TCP
  • Matrix.MxProject.Web.Service poort 8025 TCP
  • Matrix.Project.Server poort 1335 TCP

De setups van MatrixProject voegen bij het installeren van de services automatisch uitzonderingen toe aan de Windows firewall voor de standaard configuratie.
Bij gebruik van een andere firewall, dan de Windows firewall, dienen uitzonderingen toegevoegd te worden aan deze Firewall door systeembeheer.

Wordt gebruik gemaakt van de Windows Firewall dan kunnen de Firewall regels ook eenvoudig toegevoegd worden via de Nestsh.exe app van Microsoft.
Het onderstaande script voegt de Firewall regels toe via de Netsh.exe app:

netsh advfirewall firewall add rule name="Matrix.Drive.Server 1337 TCP" dir=in action=allow protocol=TCP localport=1337
netsh advfirewall firewall add rule name="Matrix.MxProject.Web.Service 8025 TCP" dir=in action=allow protocol=TCP localport=8025
netsh advfirewall firewall add rule name="Matrix.Project.Server 1335 TCP" dir=in action=allow protocol=TCP localport=1335