Documentation

No results
    gitHub

    User-defined custom properties

    For each object in Hackolade, we've defined a set of standard properties that appear in the properties pane.  But it is possible that your organization wants to define and track its own metadata properties for models, containers, entities, and attributes.  This could be for data governance reasons, and/or to leverage properties in code generation, etc... 

     

    Hackolade Studio provides a no-code approach: you can create and maintain custom properties simply by editing JSON configuration files. If desired, you can version those files in a version control system and share them across your organization. We recommend the use of Git as it is a lever for enabling team collaboration using the Workgroup edition of Hackolade Studio.

     

    The values you record in custom properties are stored in the model file and are naturally exposed in documentation, JSON Schema (in full and extended compliance), Excel exports.

     

    The location of the JSON configuration files depends on your environment:

    - If you use the browser application, you can download template files from Tools > Options > Custom Properties. You can then edit those files and (re-)load them into the application.

    - If you use the desktop application on Windows, you can find the JSON files in C:\Users\%username%\.hackolade\options. You can edit those files in-place.

    - If you use the desktop application on MacOS, you can find the JSON files in /Users/$USER/.hackolade/options. You can edit those files in-place.

     

    Warning: whatever your environment, you need to restart / reload the application for configuration changes to take effect!

    Note that native targets (aka JSON, Couchbase, DynamoDB, MongoDB, and Polyglot) can be customized without downloading additional plugins.  

     

    Access the target customization directory

    Desktop deployment

    To create and maintain custom properties for a given target, you access the folder structure from Help > Plugin Manager

     

    Plugin Manager menu new

     

    and choose the Installed tab:

    Plugin Manager Installed tab

     

    then click on the Show plugin customization directory link for the chosen target.  This link opens up a Windows Explorer or Mac Finder session in the corresponding folder.  If the folder does not yet exist, it will be automatically created, along with all the necessary configuration files.

     

    For each custom properties plugin, you will find a directory structure similar to this one:

     

    Plugin - Custom Prop - directory struc new

     

    Notes: 

    i)  it is always necessary to restart the application after having saved changes, and before you can see these changes reflected in the properties pane.

    ii) for field-level definitions, since data types have different property lists, it may be necessary to define custom properties for multiple data types.

     

    When you open a xLevelConfig.json file, it starts with a section showing examples of how different controls are structured.  Then at the end, you find the section where changes are made:

    Custom properties - empty config

     

    It is an array of objects, themselves containing and array of control objects.

     

    Adding control objects inside the structure array of Details would add custom properties at the bottom the of the Details tab in the Properties Pane.  If you want to define a custom tab, it would be by adding an object in the array:

    Custom properties - custom tab

     

    To add a control object, copy from one of the examples at the top of the file, and paste it in the right place, for example:

    Custom properties - custom tab custom control

     

    If you need to add a custom property to a data type, but not to all data types, you must do it under the data type specific to the technology target:

    Custom properties - field level control

     

    Browser deployment

    Given the security requirements browsers, the user experience is quite different.  In the browser application, go to Tools > Options > Custom Properties.

     

     

    Plugin - Custom Prop - template files

     

    You run both the Desktop and the Browser deployments of Hackolade Studio

    No need to download any template file if you want to share the same setup of custom properties with the Desktop application (recommended.)

     

    For each target technology, you must select the folder previously created with the Desktop application.  This will typically be:

    - on Windows: C:\Users\%username%\.hackolade\options\<target>\customProperties

    - on Mac: /Users/$USER/.hackolade/options/<target>/customProperties (note: use Cmd+. to display hidden folders)

     

    Each time you make changes to the custom properties config files, you must reload the browser page.

    You only run Hackolade Studio in the browser

    Download the template file (zip file) by clicking the link provided.  For each target, you must create a folder structure based on the zip file containing structure and templates.  You must unzip the archive, and we suggest to store it all under:

    - on Windows: C:\Users\%username%\.hackolade\options\<target>\customProperties

    - on Mac: /Users/$USER/.hackolade/options/<target>/customProperties (note: use Cmd+. to display hidden folders)

     

    You may then edit the files according the instructions below.  Once you are done editing those files, you need to load them in the application using the directory picker. Note that your configuration remains local to your machine: the JSON files are persisted in your browser and restored across sessions but they are never sent to a remote server.

     

     

    Image

    Levels

    As a reminder, terminology differs between the targets supported by Hackolade:

    - container means: dbs in MongoDB, region in DynamoDB, and bucket in Couchbase, namespace in Avro, keyspace in Cassandra, schema in RDBMS, etc...

    - entity means: collection in MongoDB, table in DynamoDB and Cassandra and RDBMS, and document type in Couchbase,e tc...

    - field means: field in MongoDB and Couchbase, and attribute in DynamoDB, column in Cassandra and RDBMS, etc...

     

    You need to edit the corresponding <object>LevelConfig.json file to add custom properties.

     

    Tabs

    Note: tabs in Properties Panes were originally placed at the bottom.  To make them more visible, they were subsequently moved to the top.  

     

    For each level, the Hackolade properties pane may have one or more lower tab:

    - MongoDB model tab:

    MongoDB model lower tab

    - MongoDB dbs tab:

    MongoDB dbs lower tab

    - MongoDB collection tab:

    MongoDB collection lower tab

    - MongoDB field  tab:

    MongoDB field lower tab

     

    If the level allows multiple tabs, you need to choose to which tab you want to add properties.

     

    Property types

    The following controls are possible for user-defined properties:

     

    Plugin - possible property types

    • simple text: one line of text
    • text area: popup for multi-line text entry
    • dropdown selection (unique) from a defined list of options
    • dropdown selection (multiple) from a defined list of options
    • numeric-only field
    • checkbox: for true/false entry
    • group: addition of a set of properties of given control type
    • field list: selection from list of fields
    • field list with attributes: selection from list of fields with attributes

     

    More information here.

     

    Property definition

    Examples are provided in the comments section of each config file.  Here's an overview of the schema:

    Plugin - property schema

    Here's another view, consolidated:

    Plugin - custom props consolidated schema

     

    - propertyName: mandatory, this is the property label that will appear in the Property Pane

    - propertyKeyword: mandatory, this is the unique key for the property

    - shouldValidate: optional, boolean true/false to define whether to validate the regular expression of the text input [default: false]

    - propertyTooltip: optional, in the case of input types textarea and select, it is possible to display a tooltip  defined here

    - propertyType: mandatory, this is the control definition, with possible values: text, details, select (i.e. dropdown), checkbox 

    - options: optional, this is the array of possible checkbox options

    - template: optional, this is needed in the case of propertyType = details, to define a popup multi-line text.  Possible value: textarea

    - valueType: optional, this is needed in to specify that a property is numberic only.  Possible values: numeric

     

    Share customization with team members

    it is recommended that you share customization using Git.  Store your changes in a Git remote repository, and have your team members clone it locally in C:\Users\%username%\.hackolade\options (on Mac in Users/$USER/.Hackolade/options)  That way, all that teams members need to do is to pull regularly, and they will get your latest changes.

     

    For the changes to take effect on each computer, it is required to exit Hackolade and restart it.