Metadata and documentation load

When configuring and loading information to Engrafo it is highly recommended to have a way to automate the creation of data catalogs and data usage documentation.

The goal is to minimize the manual efforts needed to document data and data usages.

So, we created an API in Engrafo that allows you to extract all kinds of information, place that in a folder and just let Engrafo import and store the information. In that way, you can just schedule your extracts and let Engrafo fetch, structure and storage all the information.

But, the extract you make and store must match the structure of the API. We have explained how this is done in this section.

On this page of the Engrafo Guide you will find information about:

If you have questions about alternative methods to automatically load metadata and information into Engrafo, please reach out to us at contact@engrafo.dk

The overall process for uploading metadata

Metadata load is the core of Engrafo making documentations and data catalogs automated

The process is Upload files → validate files → load files

For the Upload of metadata files, it can be done in 3 ways

1. Manually. You will have to select the file from your computer and upload it manually

2. Semi-automated. All metadata files placed in wwwroot\uploads_csv\,\ are automatically imported and are ready for validation. Note that the csv-delimiter that is used is the name of the folder. Here it is “,”

3. Fully-automated. All metadata placed in wwwroot\uploads_CSVAuto\;\ are automatically imported validated and loaded to Engrafo. Note that the csv-delimiter that is used is the name of the folder. Here it is “;” There is a check every 5 sec. on new files to import, validate and load. (If validation fails, and error messages on that metadata-file is produced and metadata is not imported)

Open

Important when placing metadata in a folder, is that the subfolder name identifies which delimiters that is used:

Open

So, if metadata is delimited with a “¤”, then place metadata in uploads_csv\¤\

In the following there is a description on how to create a metadata fil for Engrafo. It’s very important to hold the right syntax.

Generating Data Catalog via .csv load

Mandatory columns

Load a csv file which has the following mandatory columns:

• Kategori

• Database

• Skema

• Tabel

• Kolonne

In addition, the csv file can have the following optional columns:

If the columns are to be sorted other than alphabetically

• KolonneSortering

If importing to custom fields

• Database_[fieldname]

• Skema_[fieldname]

• Tabel_[fieldname]

• Kolonne_[fieldname]

IMPORTANT
The [fieldname] fields must exist as Custom fields before it is possible to load content into them.

Below is an example of how a CSV file might look with the ¤ character selected as the separator:

Updating Data Catalog via .csv load 

Mandatory columns

Load a csv file which has the following mandatory columns:

• KategoriID

• DatabaseID

• SkemaID

• TabelID

• KolonneID

In addition, the csv file can have the following optional columns:

If names should be updated

• Kategori

• Database

• Skema

• Tabel

• Kolonne

If the columns are to be sorted other than alphabetically

• KolonneSortering

If custom fields are to be updated

• Database_id_[fieldname]

• Database_[fieldname]

• Skema_id_[fieldname]

• Skema_[fieldname]

• Tabel_id_[fieldname]

• Tabel_[fieldname]

• Kolonne_id_[fieldname]

• Kolonne_[fieldname]

IMPORTANT
The [fieldname] fields must exist as Custom fields before it is possible to load content into them.

Below is an example of how a CSV file might look with the ¤ character selected as the separator:

Generating Data Usage documentation via .csv load 

Mandatory columns

Load a csv file which has the following mandatory columns:

• Kategorihierarki

• Skabelonnavn

• Unitnavn

• Ejer

• Dokumentationsnavn

In addition, the csv file can have the following optional columns for load of Text fields:

• Customfelt_text_name

• Customfelt_text_value

In addition, the csv file can have the following optional columns for load of links:

• Customfelt_link_name

• Customfelt_link_href

• Customfelt_link_description

In addition, the csv file can have the following optional columns for load of inputdata:

• Inputdata_customfelt_name

• Inputdata_kategori

• Inputdata_database

• Inputdata_skema

• Inputdata_tabel

• Inputdata_kolonne (* can be used if ALL columns are to be loaded)

In addition, the csv file can have the following optional columns for load of outputdata:

• Outputdata_customfelt_name

• Outputdata_kategori

• Outputdata_database

• Outputdata_skema

• Outputdata_tabel

• Outputdata_kolonne (* can be used if ALL columns are to be loaded)

Important

• The category hierarchy must already exist before it is possible to load into it

• The category elements must be specified with ¤ as a separator, for example: Level1¤Level2¤Level3

• The templates specified in [Skabelonnavn] must exist before loading to them is possible

• Units specified in [Unitnavn] must exist before loading to them is possible

• The fields specified in [Customfelt_text_name] must exist as Custom fields before it is possible to load content into them

• The fields specified in [Customfelt_link_name] must exist as Custom Fields before it is possible to load content into them

• The fields specified in [Inputdata_customfelt_name] must exist as Custom fields before it is possible to load content into them

• The fields specified in [Outputdata_customfelt_name] must exist as Custom fields before it is possible to load content into them

• The column specified in [Inputdata_kolonne] must exist before it can be loaded as input data

• The column specified in [Outputdata_kolonne] must exist before it can be loaded as output data

Below is an example of how a CSV file can look for loading both text fields and links, where the character ; is selected as separator:

Below is an example of how a CSV file can look for loading input data, where the character ; is selected as separator:

Generating Data Catalog SQL Server connection string 

See the video....

Generating sample space via .csv load 

Load a csv file that has the following required columns:

• Udfaldsrum

• Værdi

• Beskrivelse

The following is an example of what a CSV file might look like where the character ¤ is selected as the separator: