Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

DifficultyMoeilijkheidsgraad: expert

Content

Inhoud

Table of Contents
minLevel1
maxLevel1

Learning Objectives

After reading this article, you’ll be able to:

  • What SFTP is and when to use it

  • Setup connection to SFTP server in WPM

  • Configure SSH key pair authentication

What is SFTP / when to use SFTP

SFTP stands for

Leerdoelen

Na het lezen van dit artikel zul je in staat zijn om:

  • Wat SFTP is en wanneer het te gebruiken

  • Verbinding met SFTP-server instellen in WPM

  • SSH-sleutelpaarauthenticatie configureren


Wat is SFTP / wanneer gebruik je SFTP?

SFTP staat voor SSH File Transfer Protocol. This is a method of transferring files between two entities. It is literally nothing else than having one entity (system or user) transferring a file to a server, which in turn can be collected by another entity (system or user). Or to make it even more simple: image if you would put a file on a folder on your desktop, which would then be collected by another user. It is as simple as that.

SFTP is most commonly used in the following scenario’s:

  • Data should be shared in a common file format. As the file is placed on a server, most commonly files like CSV or XML are used. But PDF, Word or image files are also commonly used. As these are common files, users can more easily interact with them and understand what is happening.

  • Debugging needs to be easy. Seeing as there are two actions (entity > server, server > entity), it is quite easy to debug where the error is happening. If an expected file is not on the server, you know the delivering party made an error. If the file is on the server, but not (correctly) collected by the receiving entity, you know that something is going wrong with collection.

  • Large datasets need to be shared. A webservice is most commonly used for short transactions. Large datasets are not suited to directly be transferred between systems, as timeouts might occur. These limitations are less for SFTP. So when a large transferal of data is necessary, SFTP is the better option.

Considerations

 Please take note of the following considerations in regards to SFTP:

  • Next to SFTP, Workplace also has support for FTPs. Please do not use this unless there is no other option. Support for FTPs is becoming worse in the industry, so support will also take a decline. If FTPs is used, the other steps are similar, although you might need to specify the kind of FTPs in FileZilla (please refer to documentation online to set this up).

  • Workplace does not accept self-signed certificates. This is for our own and the client’s security.

  • Workplace supports certificate authentication. This possibility is still in early development and should only be conducted under the guidance of a Spacewell consultant. For that reason, it falls outside of the scope of this page (for now).

  • As is with any server, there might be firewalls in place (this only applies when the server is not hosted by Spacewell). This might mean that the IP address of your office as well as that of Workplace need to be whitelisted.

    • You can find the IP address of your office when searching “what is my IP” on Google

    • Contact you Spacewell consultant to request the SOURCE NAT ip

  • Import can only be run once every 15 minutes. If you set a higher frequency, this will be ignored

    Dit is een methode om bestanden over te dragen tussen twee entiteiten. Het is letterlijk niets anders dan dat de ene entiteit (systeem of gebruiker) een bestand overbrengt naar een server, dat op zijn beurt kan worden opgehaald door een andere entiteit (systeem of gebruiker). Of om het nog eenvoudiger te maken: stel je voor dat je een bestand in een map op je bureaublad zet, dat vervolgens door een andere gebruiker wordt opgehaald. Zo eenvoudig is het.

    SFTP wordt meestal gebruikt in de volgende scenario's:

    • Gegevens moeten worden gedeeld in een gemeenschappelijk bestandsformaat. Als het bestand op een server wordt geplaatst, worden meestal bestanden zoals CSV of XML gebruikt. Maar ook PDF-, Word- of afbeeldingsbestanden worden vaak gebruikt. Omdat dit gemeenschappelijke bestanden zijn, kunnen gebruikers er gemakkelijker mee werken en begrijpen wat er gebeurt.

    • Debuggen moet eenvoudig zijn. Aangezien er twee acties zijn (entiteit > server, server > entiteit), is het vrij eenvoudig om te debuggen waar de fout optreedt. Als een verwacht bestand niet op de server staat, weet je dat de aanleverende partij een fout heeft gemaakt. Als het bestand wel op de server staat, maar niet (correct) wordt opgehaald door de ontvangende entiteit, dan weet je dat er iets mis gaat bij het ophalen.

    • Grote datasets moeten worden gedeeld. Een webservice wordt meestal gebruikt voor korte transacties. Grote datasets zijn niet geschikt om rechtstreeks tussen systemen te worden overgedragen, omdat er time-outs kunnen optreden. Deze beperkingen zijn minder voor SFTP. Dus als een grote gegevensoverdracht nodig is, is SFTP de betere optie.

    Overwegingen

    Houd rekening met de volgende overwegingen met betrekking tot SFTP:

    • Naast SFTP ondersteunt Workplace ook FTP. Gebruik dit niet, tenzij er geen andere optie is. De ondersteuning voor FTP's wordt steeds slechter in de industrie, dus de ondersteuning zal ook afnemen. Als FTPs wordt gebruikt, zijn de andere stappen vergelijkbaar, hoewel je misschien het soort FTPs moet specificeren in FileZilla (raadpleeg de documentatie online om dit in te stellen).

    • Workplace accepteert geen zelfondertekende certificaten. Dit is voor onze eigen veiligheid en die van de klant.

    • Workplace ondersteunt certificaatverificatie. Deze mogelijkheid is nog in ontwikkeling en dient alleen te worden uitgevoerd onder begeleiding van een Spacewell consultant. Om die reden valt het (voorlopig) buiten het bereik van deze pagina.

    • Zoals bij elke server het geval is, kunnen er firewalls aanwezig zijn (dit geldt alleen als de server niet door Spacewell wordt gehost). Dit kan betekenen dat zowel het IP-adres van uw kantoor als dat van Workplace moet worden gewhitelist.

      • U kunt het IP-adres van uw kantoor vinden door op Google te zoeken naar "wat is mijn IP".

      • Neem contact op met uw Spacewell-adviseur om het SOURCE NAT ip aan te vragen.

    • Importeren kan slechts eenmaal per 15 minuten. Als je een hogere frequentie instelt, wordt dit genegeerd.


    Expand
    titleRetrieving SFTP server details
    Retrieving

    SFTP

    server details

    The first step for getting SFTP working is to have access to an SFTP server. There are two ways to get access:

    • The most common scenario is that the client has their own SFTP server

    • If a client does not have an SFTP server, or more likely, does not want to host their own server, Spacewell can provide the client with an SFTP server. There are licensing costs associated with this, so please contact your Spacewell account manager for more information.

    When the SFTP server is available, the following information is needed:

  • Username

  • Password

    -servergegevens ophalen

    De eerste stap om SFTP werkend te krijgen is toegang hebben tot een SFTP server. Er zijn twee manieren om toegang te krijgen:

    • Het meest voorkomende scenario is dat de cliënt zijn eigen SFTP-server heeft

    • Als een klant geen SFTP-server heeft, of waarschijnlijker, geen eigen server wil hosten, kan Spacewell de klant voorzien van een SFTP-server. Hier zijn licentiekosten aan verbonden, dus neem contact op met uw Spacewell accountmanager voor meer informatie.

    Wanneer de SFTP-server beschikbaar is, is de volgende informatie nodig:

    • Gebruikersnaam

    • Wachtwoord

    • Host (c.q. server URL)

    • PortHaven

    Expand
    titleTesting SFTP connection
    Testing

    SFTP

    connection

    Before setting up a connection from Workplace to an SFTP server, it is important to always test the SFTP connection. The easiest way to do this is by using FileZilla. FileZilla is an open source SFTP client software and is the industry standard to connect to SFTP server. You can download FileZilla from their website. If you want to know how to use FileZilla, please refer to their YouTube channel of any online resource on how to do this. This information is not shared here, as this information might be outdated in the future.

    When you have installed FileZilla, test the provided details from the previous section by setting up a connection. If an error occurs, you first need to make sure that that is resolved. Only when you have successfully created a connection, setup can take place inside Workplace.  

    -verbinding testen

    Voordat je een verbinding van Workplace naar een SFTP-server opzet, is het belangrijk om de SFTP-verbinding altijd te testen. De eenvoudigste manier om dit te doen is door FileZilla te gebruiken. FileZilla is een open source SFTP-clientsoftware en is de industriestandaard om verbinding te maken met een SFTP-server. Je kunt FileZilla downloaden van hun website. Als je wilt weten hoe je FileZilla gebruikt, raadpleeg hun YouTube-kanaal van een online bron over hoe dit te doen. Deze informatie wordt hier niet gedeeld, omdat deze informatie in de toekomst mogelijk verouderd zal zijn.

    Als je FileZilla hebt geïnstalleerd, test dan de verstrekte gegevens uit de vorige sectie door een verbinding op te zetten. Als er een fout optreedt, moet je eerst zorgen dat die is opgelost. Pas als je met succes een verbinding hebt gemaakt, kan de installatie in Workplace plaatsvinden.

    Optional settings

    With this value, a check is done to see if the previous file that was imported is different than the newest file. This is in seconds. With 0, the check is skipped.

    Be aware: this value is also important for file locking. Please refer to help text of the field for more information

    In some cases, performance might be an issue. This value can be set to “simplified” to prevent intensive access right checking

    Een automatische SFTP-import instellen

    Toepassingsgebied

    In de onderstaande voorbeelden gebruiken we de standaard importconnectoren van Workplace Management. Het automatiseren van eigen import (en export) is ook mogelijk. Als dit nodig is, moeten er aangepaste import/export mappings worden gemaakt waarvoor diepgaande kennis van het Workplace objectmodel nodig is. Neem contact op met uw Spacewell contactpersoon om de mogelijkheden te bespreken.

    Stappen

    1. Klik in het navigatiemenu op "Configuratie" > klik op "Importeren" (of gebruik de knop "Standaard importeren" op je startbord).

    2. Open de importen waarvoor je een automatische import wilt instellen.

      Image Added
    3. Als je geen sjabloonbestand hebt ontvangen, gebruik dan "Genereer importsjabloon" om een sjabloon te krijgen voor het importeren van gegevens. Als je het importbestand al hebt, kun je deze stap overslaan.

    4. Navigeer naar het tabblad 'Details'.

    5. Er zijn verplichte en optionele velden. Onderaan de lijst vind je beide velden. Volg deze voor het instellen.

    6. De SFTP-verbinding moet actief zijn na het invullen van alle verplichte velden.

      • Het is gebruikelijk om 'Actief = ja' in te stellen na het invullen van alle andere verplichte velden.

    7. De verbinding is nu actief en wordt uitgevoerd op de eerst geplande datum.

    Verplichte instellingen

    Expand
    titleSetting up an automated SFTP import

    Setting up an automated SFTP import

    Scope

    In the below examples, we’ll be using the default import connectors from Workplace Management. Automating custom imports (and exports) is also possible. If this is required, custom import/ export mappings need to be created for which in depth knowledge of the Workplace object model is needed. Please contact your Spacewell contact to discuss the possibilities.

    Steps

    1. In the navigationMenu click on “Configuration” > click on “Import” (or use the ‘Default import’ button on your startBoard).

    2. Open the imports for which you would like to setup an automated import.

      Image Removed
    3. If you have not been provided with a template file, please use “Generate import template” to get a template for the data import. If you already have the import file you can skip this step.

    4. Navigate to the ‘Details’ tab.

    5. There are obligatory and optional field. Below the list you can find both fields. Please follow those for the setup.

    6. The SFTP connection should be active after filling in all obligatory fields.

      • It is common practice to set 'Active = yes' after filling all the other obligatory fields.

    7. The connection is now active and will run at the first scheduled date.

    Obligatory settings

    Field

    Value

    Remark

    Name

    Choose a recognizable name

    Not obligatory per se, but highly recommended to fill in.

    Type

    Default: SFTP

    Choose FTPs if that applies, please see “Considerations”

    Server

    Server address

    This should have been received from the client

    Port

    Port address (only digits)

    This should have been received from the client

    Username

    Username which has been granted access to the SFTP

    This should have been received from the client

    Password

    Password for provided username

    This should have been received from the client

    Filename

    Name of the file to be collected

    Make sure you discuss this with the client. Preferably this is always the same to prevent problems

    Delete

    Default: yes

    Change this to “no” if you do not want the file to be deleted once Workplace has imported the file. Preferable for debugging

    Active

    Default: no

    Used to enable/disable the import. Set this to ‘yes’ to activate the connection.

    Start

    Date time value

    Start date and time for when the import should be started

    Cycle

    Set the interval with which data should be collected. The lowest minimum is 15 minutes, everything above that is a valid value

    Contact

    Contact in Workplace

    Set the contact that executes the import/ export. This contact should have the proper access right. Usually a system admin is selected here.

    Field

    Value

    Remark

    Directory

    Text which indicates the location of where the file is located on the SFTP server

    Can be any directory on the SFTP server, divided by / (i.e. invoices/imported)

    Zip password

    Password for the zip

    If the client is using a zip file using a password, the password can be added here

    Character set

    Default: empty

    If errors occur in regards to text characters, this could be due to the encoding of the file. Set to the encoding of the file (you can check this through notepad)

    Errors

    Specify Workplace user group

    When errors occur, the group that is filled in here receives an e-mail with the errors

    Notification

    Specify Workplace user group

    When the import is done, the notification group gets notified through e-mail

    Message

    Text

    A message can be added here for the notification

    Scheduling

    Day in the month

    See remark

    If you want a specific day in the month to import the file

    Day

    See remark

    If you want to specify a relative day in the month to import the file

    Next connector

    Select the next connector

    In some cases, you want to run multiple imports after each other, you can chain imports. You can select the next connector here. Be aware that if the first connector fails, the next one will not be started

    Template definition

    Template definition on how to handle data

    This only applies if the imported file adheres to a specific template which diverts from CSV or one level XML. Please contact Spacewell if more is necessary

    Time offset

    Default: 120, proposed: 0

    Log

    Default: yes

    Makes sure errors are logged

    Correct

    Default: no

    This allows the import to overwrite some values. Most of the cases, this is not necessary. Only change this in discussion with Spacewell contact

    Save documents

    Default: yes

    With this setting, imported files are saved inside Workplace Management. This is desirable for debugging. If there is sensitive data in the imported files, put this value to “no”. Documents will be maintained for a certain amount of months, which can be set in the client settings

    Save warnings

    Default: yes

    Saves warnings as files. Used for debugging. Set to “no” if debugging is not necessary.

    Access right checking

    Default: empty

    Veld

    Waarde

    Opmerking

    Naam

    Kies een herkenbare naam

    Niet per se verplicht, maar wel een aanrader om in te vullen.

    Type

    Standaard: SFTP

    Kies FTP's als dat van toepassing is, zie "Overwegingen".

    Server

    Adres server

    Dit moet zijn ontvangen van de klant

    Haven

    Poortadres (alleen cijfers)

    Dit moet zijn ontvangen van de klant

    Gebruikersnaam

    Gebruikersnaam die toegang heeft gekregen tot SFTP

    Dit moet zijn ontvangen van de klant

    Wachtwoord

    Wachtwoord voor opgegeven gebruikersnaam

    Dit moet zijn ontvangen van de klant

    Bestandsnaam

    Naam van het bestand dat moet worden opgehaald

    Zorg ervoor dat je dit bespreekt met de klant. Bij voorkeur is dit altijd hetzelfde om problemen te voorkomen.

    Verwijder

    Standaard: ja

    Verander dit in "no" als je niet wilt dat het bestand wordt verwijderd zodra Workplace het bestand heeft geïmporteerd. Bij voorkeur voor debuggen

    Actief

    Standaard: nee

    Wordt gebruikt om de import in/uit te schakelen. Stel dit in op 'ja' om de verbinding te activeren.

    Start

    Datum tijd waarde

    Startdatum en -tijd waarop de import moet worden gestart

    Fiets

    Stel het interval in waarmee gegevens moeten worden verzameld. Het laagste minimum is 15 minuten, alles daarboven is een geldige waarde.

    Neem contact op met

    Contact op de werkplek

    Stel de contactpersoon in die de import/export uitvoert. Deze contactpersoon moet de juiste toegangsrechten hebben. Meestal wordt hier een systeembeheerder geselecteerd.

    Optionele instellingen

    Veld

    Waarde

    Opmerking

    Directory

    Tekst die de locatie van het bestand op de SFTP-server aangeeft.

    Kan elke map op de SFTP-server zijn, gedeeld door / (bijv. facturen/geïmporteerd)

    Wachtwoord zippen

    Wachtwoord voor de zip

    Als de client een zipbestand met een wachtwoord gebruikt, kan het wachtwoord hier worden toegevoegd

    Tekenset

    Standaard: leeg

    Als er fouten optreden met betrekking tot tekstkarakters, kan dit te maken hebben met de codering van het bestand. Stel de codering van het bestand in (u kunt dit controleren met kladblok)

    Fouten

    Werkplek gebruikersgroep opgeven

    Als er fouten optreden, ontvangt de groep die hier is ingevuld een e-mail met de fouten

    Melding

    Werkplek gebruikersgroep opgeven

    Wanneer het importeren klaar is, krijgt de notificatiegroep een melding via e-mail

    Bericht

    Tekst

    Hier kan een bericht worden toegevoegd voor de melding

    Planning

    Dag in de maand

    Zie opmerking

    Als je een specifieke dag in de maand wilt om het bestand te importeren

    Dag

    Zie opmerking

    Als u een relatieve dag in de maand wilt opgeven om het bestand te importeren

    Volgende connector

    Selecteer de volgende connector

    In sommige gevallen wil je meerdere imports na elkaar uitvoeren, dan kun je de imports aan elkaar koppelen. Je kunt hier de volgende connector selecteren. Houd er rekening mee dat als de eerste connector mislukt, de volgende niet wordt gestart.

    Sjabloon definitie

    Sjabloondefinitie over hoe om te gaan met gegevens

    Dit is alleen van toepassing als het geïmporteerde bestand voldoet aan een specifiek sjabloon dat afwijkt van CSV of XML op één niveau. Neem contact op met Spacewell als er meer nodig is

    Tijdsverschil

    Standaard: 120, voorgesteld: 0

    Met deze waarde wordt gecontroleerd of het vorige bestand dat is geïmporteerd anders is dan het nieuwste bestand. Dit is in seconden. Met 0 wordt de controle overgeslagen.

    Let op: deze waarde is ook belangrijk voor het vergrendelen van bestanden. Raadpleeg de helptekst van het veld voor meer informatie.

    Log

    Standaard: ja

    Zorgt ervoor dat fouten worden gelogd

    Correct

    Standaard: nee

    Hierdoor kan de import sommige waarden overschrijven. In de meeste gevallen is dit niet nodig. Wijzig dit alleen in overleg met Spacewell

    Documenten opslaan

    Standaard: ja

    Met deze instelling worden geïmporteerde bestanden opgeslagen in Werkplekbeheer. Dit is wenselijk voor debugging. Als er gevoelige gegevens in de geïmporteerde bestanden staan, zet deze waarde dan op "nee". Documenten worden gedurende een bepaald aantal maanden bewaard, wat kan worden ingesteld in de clientinstellingen

    Waarschuwingen opslaan

    Standaard: ja

    Slaat waarschuwingen op als bestanden. Gebruikt voor foutopsporing. Stel in op "no" als debuggen niet nodig is.

    Toegangscontrole

    Standaard: leeg

    In sommige gevallen kan de prestatie een probleem zijn. Deze waarde kan worden ingesteld op "vereenvoudigd" om intensieve controle van toegangsrechten te voorkomen.

    This should have been received from the client

    Hoe bepalen welke gegevens worden geëxporteerd

    Er wordt altijd een rapport gebruikt om te bepalen welke gegevens worden geëxporteerd. Dit rapport wordt gekoppeld in het veld 'rapport' van de exportconnector.

    Stappen

    1. Klik in het navigatieMenu op "Configuratie" > klik op "Exporteren".

    2. Klik op 'Nieuw' om een exportconnector te maken

    3. Vul het verplichte veld in (zie onderstaande tabel)

    4. Klik op 'Uitvoeren' om de verbinding te testen. Het rapport wordt gemaild of geëxporteerd naar de FTP-server.

    Verplichte instellingen

    Expand
    titleSetting up SFTP export
    Setting up

    SFTP-export instellen

    Scope

    No default exports are available in Workplace Management. Creating an export connector is therefor by definition custom. The complexity of setting up an automated export mostly depends on the format of the file that is exported. In this article we describe how you can setup the connection, but we will not go into details regarding how to format the data (e.g. creating reports and XML templates).

    Transport types

    The files are always send via email or placed on an FTP server.

    Supported file types

    The following file are supported:

    HTML (e.g. data in email body

    Toepassingsgebied

    Er zijn geen standaard exports beschikbaar in Werkplekbeheer. Het maken van een exportconnector is daarom per definitie maatwerk. De complexiteit van het opzetten van een geautomatiseerde export hangt vooral af van het formaat van het bestand dat wordt geëxporteerd. In dit artikel beschrijven we hoe je de koppeling kunt opzetten, maar we gaan niet in op hoe je de gegevens kunt opmaken (bijvoorbeeld door rapporten en XML-sjablonen te maken).

    Typen transport

    De bestanden worden altijd via e-mail verstuurd of op een FTP-server geplaatst.

    Ondersteunde bestandstypen

    De volgende bestanden worden ondersteund:

    • HTML (bijv. gegevens in de e-mailtekst)

    • PDF

    • CSV

    • CVS dump

    • XML

    • XML-dump

    • XLS

    How to determine what data is exported

    A report is always used to determine what data is exported. This report is linked in the ‘report’ field of the export connector.

    Steps

    1. In the navigationMenu click on “Configuration” > click on “Export”

    2. Click ‘New’ to create an export connector

    3. Fill in the obligatory field (see table below)

    4. Click ‘Run’ to test you connection. The report will be emails or exported to the FTP server

    Obligatory settings

    Field

    Value

    Remark

    Name

    Choose a recognizable name

    Not obligatory per se, but highly recommended to fill in.

    Report

    Link a report here

    Use defaults/ initialization in the report filtering to configure the export results. For example: set a default category or a request filter on ‘create time’ with the initialization ‘now minus 7 days’ (export the REQs of last week).

    Execute as

    Set the contact that executes the export. This contact should have the proper access right.

    Export documents

    Default = formatted document only

    Use the help text of the field to view what the other options do.

    Active

    Default: no

    Used to enable/disable the import. Set this to ‘yes’ to activate the connection.

    Start

    Date time value

    Start date and time for when the import should be started

    Cycle

    Set the interval with which data should be collected. The lowest minimum is 15 minutes, everything above that is a valid value

    Format

    Fill in the required format

    Choose the file type in which the report should be exported.

    • CSV: when not alle data is exported because the dataset is to large, the type ‘CSV dump’ can be used. Using this option, more data can be exported, but you lose lose logic like formula’s and formatting.

    • XML: for this type the 'XML dump' variety exists, also with restrictions regarding lose of logic.

    Type

    Default: SFTP

    • Choose FTP type that applies.

    • Select ‘Email’ to send the report results attached in an email. The email will be send to the ‘Execute as’ contact, unless you fill in the field “Send to (if different)“.

    Server

    Server address

    This should have been received from the client

    Port

    Port address (only digits)

    This should have been received from the client

    Username

    Username which has been granted access to the SFTP

    This should have been received from the client

    Password

    Password for provided username

    Veld

    Waarde

    Opmerking

    Naam

    Kies een herkenbare naam

    Niet per se verplicht, maar wel een aanrader om in te vullen.

    Rapporteer

    Link hier een rapport

    Gebruik standaardinstellingen/ initialisatie in de rapportfiltering om de exportresultaten te configureren. Bijvoorbeeld: stel een standaardcategorie in of een verzoekfilter op 'create time' met de initialisatie 'now minus 7 days' (exporteer de REQ's van de afgelopen week).

    Uitvoeren als

    Stel de contactpersoon in die de export uitvoert. Deze contactpersoon moet de juiste toegangsrechten hebben.

    Documenten exporteren

    Standaard = alleen opgemaakt document

    Gebruik de helptekst van het veld om te zien wat de andere opties doen.

    Actief

    Standaard: nee

    Wordt gebruikt om de import in/uit te schakelen. Stel dit in op 'ja' om de verbinding te activeren.

    Start

    Datum tijd waarde

    Startdatum en -tijd waarop de import moet worden gestart

    Fiets

    Stel het interval in waarmee gegevens moeten worden verzameld. Het laagste minimum is 15 minuten, alles daarboven is een geldige waarde.

    Formaat

    Vul het vereiste formaat in

    Kies het bestandstype waarin het rapport moet worden geëxporteerd.

    • CSV: als niet alle gegevens worden geëxporteerd omdat de dataset te groot is, kan het type 'CSV dump' worden gebruikt. Met deze optie kunnen meer gegevens worden geëxporteerd, maar verlies je logica zoals formules en opmaak.

    • XML: voor dit type bestaat de variant 'XML dump', ook met beperkingen wat betreft het verlies van logica.

    Type

    Standaard: SFTP

    • Kies het FTP-type dat van toepassing is.

    • Selecteer 'E-mail' om de rapportresultaten als bijlage in een e-mail te verzenden. De e-mail wordt verzonden naar de contactpersoon 'Uitvoeren als', tenzij je het veld "Verzenden naar (indien anders)" invult.

    Server

    Adres server

    Dit moet zijn ontvangen van de klant

    Haven

    Poortadres (alleen cijfers)

    Dit moet zijn ontvangen van de klant

    Gebruikersnaam

    Gebruikersnaam die toegang heeft gekregen tot SFTP

    Dit moet zijn ontvangen van de klant

    Wachtwoord

    Wachtwoord voor opgegeven gebruikersnaam

    Dit moet zijn ontvangen van de klant


    Summary
    Expand
    titleSSH Key Pair authentication (for WPM)

    SSH

    Key Pair authentication (for

    -sleutelpaarverificatie (voor WPM)

    Workplace Management support authentication by means of ondersteunt authenticatie door middel van SSH Key Pair authenticationauthenticatie.

    • RSA keys are usedOPENSSH keys are currently -sleutels worden gebruikt

    • OPENSSH-sleutels worden momenteel (d.d. May 2023) not accepted and cannot be automatically converted. If you have an OPENSSH keys please first convert these to RSA.

    If this is the first import or export connector you are enabling SSH Key Pair authentication for, first execute these steps:

    1. Open you own user by clicking on your name in the top right of the screen > profile

    2. Click the button ‘Assign group’

    3. Search for and add the groep ‘License editor’ to your user. This group is needed to configure the authentication

      1. Note: if you are not able to add this group please contact your Spacewell contact.

    To configure SSH Key Pair authentication for a
    • mei 2023) niet geaccepteerd en kunnen niet automatisch worden geconverteerd. Als je OPENSSH-sleutels hebt, converteer deze dan eerst naar RSA.

    Als dit de eerste import of export connector is waarvoor je SSH Key Pair authenticatie inschakelt, voer dan eerst deze stappen uit:

    1. Open je eigen gebruiker door rechtsboven op je naam te klikken > profiel

    2. Klik op de knop 'Groep toewijzen

    3. Zoek naar de groep 'Licentie-editor' en voeg deze toe aan je gebruiker. Deze groep is nodig om de authenticatie te configureren

      1. Opmerking: als u deze groep niet kunt toevoegen, neem dan contact op met uw Spacewell-contactpersoon.

    Om SSH Key Pair authenticatie te configureren voor een import/export connector:

    1. Open the export or import connector

    2. Scroll down to the ‘Trust relations’ include. If the include is missing you need to add the include “FtpConnectorObjectTrustRelationList”)

    3. click on ‘Assign new RSA key’

    4. Click ’New’ to create a new Trust relation

    5. Fill in the fields:

      1. Name = give a name

      2. Description = give a description

      3. Type = RSA key pair

      4. Inheritance = merge

    6. Click ‘Generate key’

    7. Copy the RSA private key and the password (all the way at the bottom) from the field de export- of importconnector

    8. Scroll naar beneden naar de include 'Trust relations'. Als de include ontbreekt, moet je de include "FtpConnectorObjectTrustRelationList" toevoegen.)

    9. klik op 'Nieuwe RSA-sleutel toewijzen'.

    10. Klik op 'Nieuw' om een nieuwe vertrouwensrelatie aan te maken

    11. Vul de velden in:

      1. Naam = geef een naam

      2. Beschrijving = geef een beschrijving

      3. Type = RSA-sleutelpaar

      4. Overerving = samenvoegen

    12. Klik op 'Sleutel genereren

    13. Kopieer de RSA persoonlijke sleutel en het wachtwoord (helemaal onderaan) uit het veld 'Public certificate'.

      1. Note: do this immaterially. If you refresh the trust relation page (or leave it and come back) navigate back to this page, the public key will be displayed instead.

    14. If you forgot to copy the private key, you can click ‘Reveal secret key' > fill in the password of the user you’re logged in with (not the client password!)

    15. Now click ‘Ok’ to navigate back the the previous screen

    16. Select the trust relation you just created > click confirm on the top right of the page

      Image Removed
    17. After confirming, the details tab of the connector is opened. When you now scroll down to the ‘Trust relation’ include you will see that the trust relation is linked.

    18. Don't forget to configure the import/export connector as usual. So add the: server, port number, directory, etc .

    19. After setting up the connection on the client side, you can start testing.

    Troubleshooting checklist

    •  Were you able to connect to the SFTP server in FileZilla?
    •  Is there a firewall? If so, is our IP address whitelisted?
    •  Is there a self-signed certificate, or is this by a trusted party?
    •  In regards to incoming import: Did the received file change over time?

      1. Opmerking: doe dit onmiddellijk. Als u de vertrouwensrelatiepagina vernieuwt (of verlaat en terugkomt) en terugnavigeert naar deze pagina, wordt de openbare sleutel wordt in plaats daarvan weergegeven.

    1. Als je bent vergeten de privésleutel te kopiëren, kun je klikken op 'Geheime sleutel weergeven' > vul het wachtwoord in van de gebruiker waarmee je bent ingelogd (niet het wachtwoord van de client!).

    2. Klik nu op 'Ok' om terug te gaan naar het vorige scherm

    3. Selecteer de vertrouwensrelatie die u zojuist hebt aangemaakt > klik op bevestigen rechtsboven op de pagina

      Image Added
    4. Na het bevestigen wordt het tabblad 'Details' van de connector geopend. Als je nu naar beneden scrollt naar het onderdeel 'Vertrouwensrelatie' zie je dat de vertrouwensrelatie is gekoppeld.

    5. Vergeet niet om de import/export-connector zoals gebruikelijk te configureren. Dus voeg de: server, poortnummer, directory, enz. toe.

    6. Na het opzetten van de verbinding aan de kant van de client, kun je beginnen met testen.

    Controlelijst voor probleemoplossing

    •  Kon je verbinding maken met de SFTP-server in FileZilla?
    •  Is er een firewall? Zo ja, is ons IP-adres toegestaan?
    •  Is er sprake van een zelfondertekend certificaat of is dit van een vertrouwde partij?
    •  Met betrekking tot inkomende import: Is het ontvangen bestand in de loop van de tijd veranderd?

    Samenvatting

     
    Rw ui textbox macro
    • Connections can be scheduled to run with a Verbindingen kunnen worden ingepland met een minimum interval of van 15 minutes.

    • First step to setting up an automated import is always to manually test the login credentials (e.g. using FileZilla)

    • A report must always be linked to an export connector. Use default and initialization values to control what data is exported.

    Exercise

    •  N/A

    Search

    Live Search

    • minuten.

    • De eerste stap bij het opzetten van een geautomatiseerde import is altijd het handmatig testen van de inloggegevens (bijvoorbeeld met FileZilla)

    • Een rapport moet altijd gekoppeld zijn aan een exportconnector. Gebruik standaard- en initialisatiewaarden om te bepalen welke gegevens worden geëxporteerd.

    Oefening

    •  N.V.T.

    Zoek op

    Live Search