Version

    56. Library File Structure

    The library .clib file is, in essence, a zip archive of a CloverDX project. As such, if you rename the file extension to .zip, you can extract the archive to gain access to the actual project contents and import the project directly into your CloverDX Designer.

    You can download a library from our CloverDX Marketplace and unzip it to explore the library design.

    By default, a library project includes the following library-specific files:

    • library.json

      • Library descriptor file, which is automatically created when exporting your project to a library.

      • It contains information about available public entities.

    • dependencies.prm (present if linking elements from other projects/libraries). See Library Dependencies for more information.

    Optional library-specific files or directories that can be used to enhance the look and feel of the library’s public elements or that can be used to specify customizable parameters or add custom documentation to make working with the libraries more user-friendly.

    • library.prm

    • README file

      • A documentation file; its contents are displayed in the Libraries module in CloverDX Server. See Job Documentation Tips for documentation best practices.

    • favicon.png

      • Main library icon for Data Source or Data Target connectors that comes up in the Data Catalog in CloverDX Wrangler. See Enhancing Library Look and Feel for more information.

    • icons directory

      • Directory dedicated to storing icons for Data Souce or Data Target Connector subgraphs that are displayed in the Data Catalog in CloverDX Wrangler. See Enhancing Library Look and Feel for more information.

    The rest of the project structure is the same as in any other CloverDX project.