DifficultyMoeilijkheidsgraad: expert
Inhoud
| Table of Contents | ||||
|---|---|---|---|---|
|
Learning Objectives
After reading this article you will be able to:
Import data using default imports.
Leerdoelen
Na het lezen van dit artikel zul je in staat zijn om:
Importeer gegevens met behulp van standaardimporten.
Heb je gelezen: What are imports and exports in Workplace?? The article below repeats some of the information from that article and goes into further depth.
Basics
The import functionality allows for a quick upload of large datasets into Workplace. By using an import connector with import mappings, it is possible to specify in which data table the various data should be stored.
Default imports are available for importing master data when setting up an environment. This allows for filling the environment with for example: contacts, properties, and areas. Files are imported in csv-format.
Where to find imports
The default imports are explained in detail in the articles that describe how to set up a new Workplace environment using the Het onderstaande artikel herhaalt een deel van de informatie uit dat artikel en gaat er dieper op in.
Basis
Met de importfunctionaliteit kunnen grote datasets snel worden geüpload naar Workplace. Door gebruik te maken van een import connector met import mappings is het mogelijk om aan te geven in welke gegevenstabel de verschillende gegevens moeten worden opgeslagen.
Standaardimport is beschikbaar voor het importeren van stamgegevens bij het opzetten van een omgeving. Hiermee kun je de omgeving vullen met bijvoorbeeld: contactpersonen, eigenschappen en gebieden. Bestanden worden geïmporteerd in csv-formaat.
Waar vind ik import?
Steps to import data (and debug error messages)
To import data follow these steps:
Generate an import template by clicking “Generate import template”.
A file will become available in the include at the bottom with the name “Template import xxx”.
To download the file click the download icon.
This is the Excel file we send to the client and ask them to fill in.
After receiving the file back from the client, please verify the data:
Compare with the template if the client did not delete/ add columns, or change column headers;
Are all columns filled in;
Check if the data is valid, especially for fields that require making a selection (a number of value) or fixed format (dates). Deviating/ no values will NOT result in an error. The result will simply be that the value will not be imported;. For example:
if a column description asks “It it possible to reserve areas from this property (1 = yes)“ > make sure a '1’ is filled in.
if a column description asks “The construction date of the property (dd-mm-yyyy)” > make sure the date format is correct.
if a columns description asks “The status of the property, choose between: in use, negotiation, renovation, construction, sold“ > make sure the input exactly matches one of these value.
Now data save the file as CSV UTF-8.
Tip for converting your .xlsx to CSV: open in import file in Excel > File > Export > Change file type > select 'CSV '> Save as.
The field delimiter used in the CSV file (a comma or semicolon) should correspond with the field delimiter setting of the user that is importing the file.
To change the field delimiter setting of your user, you can navigate to: your profile (top right of your screen) > Settings > Settings tab > field “Field delimiter“.
Import the file by clicking import file.
Select file by clicking Select files.
Importing the files will continue in the background. When we click: Ok, we return to the import page.
In the right top corner the background task icon will show up, when clicking on it we can see the import status.
Tip: if the background task does not appear refresh the page by clicking the Spacewell logo on the top left of the page (of click F5 to refresh your browser).
When the import finishes, you can find the results by clicking the document icon in the top right corner.
On the document page select Advanced Search.
In the field Dates > “Linked from/until”, fill in today’s date or immediately press 'ok to find all documents belonging to this import.
Depending on the connector setting, you might find the following three document
(csv) file that you uploaded e.g. Files[]-Template import properties. The files are only saved when the import connector setting ‘Save documents = yes’;
De standaard imports worden in detail uitgelegd in de artikelen die beschrijven hoe je een nieuwe Workplace omgeving opzet met behulp van de Solution-Based Rollout (SBR) Step by step implementation guides (SBR). If you want to run an import, other than in the context of an SBR, imports can be accessed by:
Pressing the ‘Default imports’/ ‘Custom Imports’ button on the startBoard.
Open the import connector by clicking on the “reference”. After clicking the reference the general tab of the import will open;
If this import you are looking for is not yet available in the list, click: Generate default imports at the bottom of the import list.
guide. Als je een import wilt uitvoeren, anders dan in de context van een SBR, kunnen imports worden geopend door:
Druk op de knop 'Standaardimporten'/'Aangepaste importen' op het startpaneel.
Open de import connector door op de "referentie" te klikken. Nadat je op de referentie hebt geklikt, wordt het algemene tabblad van de import geopend;
Als de import die je zoekt nog niet beschikbaar is in de lijst, klik je op: Standaard import genereren onderaan de importlijst.
Stappen om gegevens te importeren (en foutmeldingen te debuggen)
Volg deze stappen om gegevens te importeren:
Genereer een importsjabloon door te klikken op "Genereer importsjabloon".
Er komt een bestand beschikbaar in de include onderaan met de naam "Template import xxx".
Klik op het downloadpictogram om het bestand te downloaden.
Dit is het Excel-bestand dat we naar de klant sturen en waarin we hem vragen het in te vullen.
Nadat u het bestand hebt teruggekregen van de klant, kunt u de gegevens verifiëren:
Vergelijk met de sjabloon als de klant geen kolommen heeft verwijderd/toegevoegd of kolomkoppen heeft gewijzigd;
Zijn alle kolommen ingevuld?
Controleer of de gegevens geldig zijn, vooral voor velden die een selectie vereisen (een aantal waarden) of een vast formaat (datums). Afwijkende/geen waarden zullen NIET resulteren in een fout. Het resultaat zal gewoon zijn dat de waarde niet geïmporteerd wordt;. Bijvoorbeeld:
als een kolombeschrijving vraagt "Is het mogelijk om gebieden van deze accommodatie te reserveren (1 = ja)" > zorg ervoor dat er een '1' wordt ingevuld.
als een kolombeschrijving vraagt "De bouwdatum van het pand (dd-mm-jjjj)" > controleer of de datumnotatie correct is.
als een kolombeschrijving vraagt "De status van het pand, kies tussen: in gebruik, onderhandeling, renovatie, bouw, verkocht" > zorg ervoor dat de invoer precies overeenkomt met een van deze waarden.
Sla het bestand nu op als CSV UTF-8.
Tip voor het omzetten van je .xlsx naar CSV: open het importbestand in Excel > Bestand > Exporteren > Bestandstype wijzigen > selecteer 'CSV'> Opslaan als.
Het veldscheidingsteken dat in het CSV-bestand wordt gebruikt (een komma of puntkomma) moet overeenkomen met de instelling voor het veldscheidingsteken van de gebruiker die het bestand importeert.
Om de instelling voor veldscheidingstekens van je gebruiker te wijzigen, kun je navigeren naar: je profiel (rechtsboven in je scherm) > Instellingen > tabblad Instellingen > veld "Veldscheidingsteken".
Importeer het bestand door op Bestand importeren te klikken.
Selecteer een bestand door op Bestanden selecteren te klikken.
Het importeren van de bestanden gaat door op de achtergrond. Wanneer we klikken op: Ok, keren we terug naar de importpagina.
In de rechterbovenhoek verschijnt het pictogram van de achtergrondtaak. Als je erop klikt, kunnen we de importstatus zien.
Tip: als de achtergrondtaak niet verschijnt, ververs dan de pagina door op het Spacewell-logo linksboven op de pagina te klikken (of klik op F5 om je browser te verversen).
Als het importeren klaar is, kun je de resultaten vinden door op het documentpictogram in de rechterbovenhoek te klikken.
Selecteer op de documentpagina Geavanceerd zoeken.
Vul in het veld Data > "Gekoppeld van/tot" de datum van vandaag in of druk meteen op 'ok' om alle documenten te vinden die bij deze import horen.
Afhankelijk van de connectorinstelling kun je de volgende drie documenten vinden
(csv) bestand dat je hebt geüpload, bijv. Bestanden[]-Template importeigenschappen. De bestanden worden alleen opgeslagen als de importconnector de instelling 'Documenten opslaan = ja' heeft;
Verwerkingslogboek - bijv. FMB-F-021-[Manual upload]-import. This shows which new record are created and if existing record have been updated;Processing errors - e.g. Dit laat zien welke nieuwe records zijn aangemaakt en of bestaande records zijn bijgewerkt;
Verwerkingsfouten - bijv. FMB-F-021-[Manual Handmatige upload]-error. A list of the blocking errors that occurred.
If the import file is filled in correctly and uploading in the correct format no errors will occur. When an error does occur it can be quite hard to find out that the exact problem of the import file is, below some tips and pointer are given on possible causesfout. Een lijst met blokkeerfouten die zijn opgetreden.
Als het importbestand correct is ingevuld en in het juiste formaat is geüpload, zullen er geen fouten optreden. Wanneer er toch een fout optreedt, kan het vrij lastig zijn om te achterhalen wat het exacte probleem van het importbestand is. Hieronder worden enkele tips en aanwijzingen gegeven over mogelijke oorzaken
| Expand | |||
|---|---|---|---|
| |||
General info
Common error message overview | |||
Message | Possible cause | Example of error message | Error Field does not exist |
| Info |
|---|
Opmerking: lees eerst de "Hoe wordt het importbestand in Workplace in kaart gebracht?". hoofdstuk van dit artikel. |
Overzicht van veelvoorkomende foutmeldingen
Bericht | Mogelijke oorzaak | Voorbeeld van foutmelding | |
|---|---|---|---|
Fout Veld bestaat niet |
| files[]-Template import properties_test.csv: Error Row Fout Rij 1 - Address with Adres met Letter : Field does not exist Veld bestaat niet: Street | |
Warning Cannot find referenced object | When we want to link an object field in an import and Workplace can’t find that object, the object can not be linked. A non-blocking warning is shown. For example: we want to link a contact with externalReference=4343453 in the ownerContactId field of a property. However, no contact with this external reference exists yet. In this case, the The solution would be to create the missing contact or link a contact that does existWaarschuwing Kan het object waarnaar verwezen wordt niet vinden |
| files[]-Template import properties_test.csv: Warning Row Waarschuwing Rij 3 - FMB Property : Warning cannot find referenced object-eigenschap : Waarschuwing kan object waarnaar verwezen wordt niet vinden: ownerContactId={externalReference=4343453} |
Warning Creating or looking up an object for this key combination has failed | Using key values, Workplace determines if an existing object should be updated or that a new object should be created. However, an import mapping can only create a new instance of the object it concerns. The import mapping ’Properties' can for example only create new properties, not addresses or contacts. Import mappings however, can use fields of other objects as key values. But, if an object containing these key values does not exist, the mapping cannot create the object resulting in this error. For example, the address fields: street, nr, and city, are key values in the property mapping. If a certain address does not exist, it cannot be created by the property mapping (this should be done by an address mapping or created manually). In the example error message an address with the key values “streetWaarschuwing Het maken of opzoeken van een object voor deze toetscombinatie is mislukt |
| files[]-Template import properties_test.csv: Error Row Fout rij 3 - FMB Property : Creating or looking up an object for this key combination has failed eigenschap : Het maken of opzoeken van een object voor deze toetscombinatie is mislukt {externalReference={=X100099998}, addressId={street=Retail streetRetailstraat, nr=18, postalReference=6666 MR, city=Arnhem} |
Voorbeeld screenshots
 |  |
| Warning |
|---|
Warning:
|
How is the import file mapped in Workplace?
Opening an import mapping
Press the ‘Default imports’/ ‘Custom Imports’ button on your startBoard;
Waarschuwing:
|
Hoe wordt het importbestand in Workplace in kaart gebracht?
Een importeermapping openen
Druk op de knop 'Standaardimporten'/'Aangepaste importen' op je startpaneel;
Open een ftp-connector, bijvoorbeeld FMB-F-021;
Navigate to the ‘Details’ tab (here you’ll find the general import settingsNavigeer naar het tabblad 'Details' (hier vind je de algemene importinstellingen);
Scroll down to the ‘Mapping’ includenaar beneden naar 'Mapping';
Open the mapping you want to view by pressing the magnifying glass behind the column ‘Mapping’ (not the blue magnifying glass at the beginning of the row!!).
When filling in the import files, there are a few things we need to keep in mind.
Every import file has different fields that have to be filled in. What these fields are depends on the configuration of the mappings that are linked to the import connector.
By opening a mapping we can see what object it concerns (field ‘Objects’) and what fields are involved ('Mapping' include).
Columns in a mapping
See screenshot above.
Order: determines in what order the mapping is handled.
de mapping die je wilt bekijken door op het vergrootglas achter de kolom 'Mapping' te drukken (niet op het blauwe vergrootglas aan het begin van de rij!!).
Bij het invullen van de importbestanden zijn er een paar dingen waar we rekening mee moeten houden.
Elk importbestand heeft verschillende velden die moeten worden ingevuld. Welke velden dat zijn, hangt af van de configuratie van de mappings die aan de importconnector zijn gekoppeld.
Door een mapping te openen kunnen we zien om welk object het gaat (veld 'Objecten') en welke velden erbij betrokken zijn ('Mapping' opnemen).
Kolommen in een mapping
Zie bovenstaande schermafbeelding.
Volgorde: bepaalt in welke volgorde de mapping wordt afgehandeld.
Naam: de naam komt hier overeen met een van de kolomkoppen in het importbestand (xlsx/ csv).
Type/ FieldVeld/ Lookup: these determine in which field in Workplace the imported value should be stored.
Example: look at line 80 of the screenshot above. With these setting, the value in the column ‘City’ of the import file will be stored in the field address.city (the object is Addressdeze bepalen in welk veld in Workplace de geïmporteerde waarde moet worden opgeslagen.
Voorbeeld: kijk naar regel 80 van de schermafbeelding hierboven. Met deze instelling wordt de waarde in de kolom 'Stad' van het importbestand wordt opgeslagen in het veld adres.stad (het object is Adres ) in Workplace.
Key values
The key values of a mapping are found in the column ‘Key’. The value ‘Yes’ means this field is a key value.
Key values are mandatory fields for an import to work. Meaning, the import will not run properly when Key values are missing.
Key values are used to determine if a new object needs to be created OR that an existing object is updated. To determine this, Workplace checks if an objects already exists that contains ALL the key values.
Belangrijke waarden
Automating an import or export
It is also possible to set up imports to be executed periodically from an FTP server.
Automated export can be set up to export date to: FTP servers and email.
Summary
| Rw ui textbox macro |
|---|
|
De sleutelwaarden van een mapping staan in de kolom 'Key'. De waarde 'Ja' betekent dat dit veld een sleutelwaarde is.
Sleutelwaarden zijn verplichte velden om een import te laten werken. Dit betekent dat het importeren niet goed verloopt als er sleutelwaarden ontbreken.
Sleutelwaarden worden gebruikt om te bepalen of een nieuw object moet worden gemaakt OF dat een bestaand object wordt bijgewerkt. Om dit te bepalen, controleert Workplace of er al een object bestaat dat ALLE sleutelwaarden bevat.
Hoe werkt dit? In de Adrestoewijzing (zie bovenstaande schermafbeelding) zijn de Straat, Nr en Postcode de sleutelwaarden. De waarden in het importbestand kunnen bijvoorbeeld zijn: Second Street, 55, 1234AB. The mapping will check if an address with these characteristics exist. One of the following actions will take place:
If the the address exists, the non-key values are updated.
If the address does not yet exist, a new address is created where the key and non-key values are stored.
| Info |
|---|
There are a lot of ways to configure mapping. Hover over the setting to see the help text. The case described above assumes that the setting “Create object = yes”; meaning a new object is created when no exact match is found for the key values. |
Import connectors and mappings background information
Almost all imports connectors that are available consist out of multiple import mappings. For every object that we want to import a separate mapping is needed. However, this is not the only reason we use different mappings. We could also use one specific mapping to only set the hierarchy of an object, so for properties this could be the hierarchy within the imported properties.
Running a mapping instead of the import connector
We are able to run mappings separately from their connector:
Open the import connector;
Navigate to the details tab;
Select a mapping by clicking on the magnifying glass next to the mapping name;
Click import;
Select your file.
The import will then run and display the results on the page.
Connector settings
Only partner users can change the settings of the connectors. Please note that if it concerns a default import, also Partner Users do not have access, because the import definition is inherited from the baseline. We will go over some important settings in the table below. Hover over a setting in Workplace to see the help text of other settings.
Setting
Description
Log
When set to ‘yes’, maintains a log of all actions
Save documents
When set to ‘yes’, stores all import/export documents. Document are usually removed after 1 month. This can be changed on the ‘Documents’ tab of the client settings by altering the “Cleanup documents after“ setting.
Save warnings
If set to ‘yes’, stores warnings when there are no errors. When set to ‘no’ the error document containing warnings/errors is only generated when there was at least one error.
De mapping controleert of er een adres met deze kenmerken bestaat. Een van de volgende acties zal plaatsvinden:
Als het adres bestaat, worden de niet-sleutelwaarden bijgewerkt.
Als het adres nog niet bestaat, wordt een nieuw adres aangemaakt waar de sleutel- en niet-sleutelwaarden worden opgeslagen.
| Info |
|---|
Er zijn veel manieren om mapping te configureren. Beweeg de muis over de instelling om de helptekst te zien. Het hierboven beschreven geval gaat ervan uit dat de instelling "Object maken = ja"; betekent dat een nieuw object wordt gemaakt als er geen exacte overeenkomst wordt gevonden voor de sleutelwaarden. |
Achtergrondinformatie over connectors en mappings importeren
Bijna alle beschikbare importconnectors bestaan uit meerdere importkoppelingen. Voor elk object dat we willen importeren is een aparte mapping nodig. Dit is echter niet de enige reden waarom we verschillende mappings gebruiken. We zouden ook één specifieke mapping kunnen gebruiken om alleen de hiërarchie van een object in te stellen, dus voor eigenschappen zou dit de hiërarchie binnen de geïmporteerde eigenschappen kunnen zijn.
Een mapping uitvoeren in plaats van de importconnector
We kunnen mappings afzonderlijk van hun connector uitvoeren:
Open de importconnector;
Navigeer naar het tabblad Details;
Selecteer een mapping door op het vergrootglas naast de naam van de mapping te klikken;
Klik op importeren;
Selecteer je bestand.
De import wordt dan uitgevoerd en de resultaten worden op de pagina weergegeven.
Connector-instellingen
Alleen partnergebruikers kunnen de instellingen van de connectors wijzigen. Houd er rekening mee dat als het om een standaardimport gaat, ook de partnergebruikers geen toegang hebben, omdat de importdefinitie wordt geërfd van de basislijn. In de tabel hieronder zullen we een aantal belangrijke instellingen bespreken. Beweeg met de muis over een instelling in Workplace om de helptekst van andere instellingen te zien.
Instelling | Beschrijving |
|---|---|
Log | Als dit is ingesteld op 'ja', wordt er een logboek bijgehouden van alle acties |
Documenten opslaan | Indien ingesteld op 'ja', worden alle import-/exportdocumenten opgeslagen. Documenten worden meestal na 1 maand verwijderd. Dit kan worden gewijzigd op het tabblad 'Documenten' van de clientinstellingen door de instelling "Documenten opruimen na" te wijzigen. |
Waarschuwingen opslaan | Als dit is ingesteld op 'ja', worden waarschuwingen opgeslagen als er geen fouten zijn. Als dit is ingesteld op 'nee', wordt het foutendocument met waarschuwingen/fouten alleen gegenereerd als er ten minste één fout was. |
Een import of export automatiseren
Het is ook mogelijk om imports zo in te stellen dat ze periodiek worden uitgevoerd vanaf een FTP-server.
Automatische export kan worden ingesteld om datum te exporteren naar: FTP-servers en e-mail.
Samenvatting
| Rw ui textbox macro |
|---|
|
Zoek op
| Live Search |
|---|