Documentation

No results
    gitHub

    Excel file

    The feature to exchange data with Excel provides the ability to export a data model, or parts of it, to Microsoft Excel so properties could be easily edited in a tabular format, to be re-imported back into the application.  It facilitates productive bulk actions for the maintenance of properties.  It also allows creation of a new model - or additions to an existing model - by team members that might not have access to the application.

     

    It includes the following capabilities: 

    (i) editing containers, entities, and attributes of an existing model; 

    (ii) selecting which properties of an attribute are exported in the Excel file, and hence which ones are filtered out and not exported; and 

    (iii) selecting custom attributes to be added in the various data types of the plugin.

     

    Note: in order to maintain integrity, when a reference to a definition is exported Excel, it is not resolved.  In other words, the sub-structure of the object is not exported.  Neither are the definitions themselves (currently - to be added soon.)

     

    When doing a roundtrip from Hackolade to Excel and back, it is important to maintain integrity of the model and avoid any corruption.  Microsoft Excel does not allow all the controls and validations of the Hackolade applications.  Additionally, the application supports a large number of different targets with differing terminology, structure, and characteristics.  

     

    Important note: it is critical that the template used to import is of the same target and plugin version issued by the export process.

     

    To import CSV files into Hackolade, it is advised to first export an Excel template, then import the CSV file into the Excel template, before importing back into Hackolade.

     

    Export model

    To start your export for a model, simply go to Tools > Forward-Engineer > Excel file...  In the Object selection dialog, you may deselect objects tht you do not wish to export.  

     

    Tools Options - FE Excel Export Objet Select

     

     

    With the Options button, you may also access a dialog to delect object properties that you do not wish to export:

    Tools Options - FE Excel Properties Selection

     

    The properties for each object are listed in the corresponding sections.  If you need to filter out a property, simply uncheck the corresponding box.

     

    Instructions for the import of an Excel file can be found in Excel reverse-engineering.

    Maintain configuration

    This configuration can also be maintained in Tools > Options > Forward-Engineering, and there's one configuration per target.  The configuration itself can be exported to a JSON file so it can be distributed in the organization, and imported on other instances of the application.

     

     

    Tools Options - FE Excel Export

     

     

    Known limitations

    Microsoft Excel (as well as LibreOffice) encounters memory limitations in the handling of validation lists, used to control in Excel boolean checkbox properties and for dropdown properties, and leading to this type of error message:

     

    Excel - Validation list limit

     

    If you click Yes, you should be aware that values are no longer validated against validation lists, which could lead to undesired inconsistencies.  It is suggested instead to:

    - increase RAM on the workstation,

    - reduce the number of validated properties exported (checkbox or dropdown)

    - reduce the number of entities (and hence attributes) exported