Public subgraphs become available for use in CloverDX Designer, where they can be added as components in server projects. For more information on the usage from the Designer perspecitve, refer here.

Subgraphs exported as Data Source or Data Target Connectors become available in the Data Catalog in CloverDX Wrangler. For more information on how to configure access to individual connectors for specific user groups, see Permissions Tab.

For more information on Data Source and Data Target Connectors from the Wrangler perspective, refer to our Data Source Connectors and Data Target Connectors sections in the Wrangler documentation.

When creating a new schedule or event listener in CloverDX Server, installed libraries are available in the Sandbox dropdown, and public graphs and jobflows from the libraries are available to be selected for scheduling.

Data Services from installed libraries can be deployed in CloverDX Server.

To load a single library for installation from a local directory click on the dropdown next to the Install library from repository button, and select the desired .clib file to be loaded.

Library repositories allow you to share your libraries. A repository is a local or remote directory with .clib archives, each containing one library. When browsing libraries in a repository, users can easily see additional information like the library version, library description, or its public elements on the Overview tab. If a library includes a documentation page, it will be displayed on a separate Documentation tab.

Some libraries might be incompatible with your current CloverDX Server version. These libraries will be marked with a warning icon to indicate potential issues. See Library incompability for more information.

Repositories can be local or remote. Currently, we support the following remote protocols: FTP, SFTP, Amazon S3, Azure Blob Storage, SMB, and SMB2.

In CloverDX Server, you can add one or more repositories by using the Add repository button and then browse through the repositories and install selected libraries.

When a library is selected to be installed, the following settings are available:

Note that the library Version is not editable; it comes up as specified during library export.

The Libraries module offers great variability when installing libraries, which allows you to:

This provides administrators with flexibility when managing libraries: libraries can be quickly installed, updated, or copied, and each installed library instance configured with different parameters or permissions.

Installing multiple instances of the same library can save you time if there is a need to handle the same data from multiple sources (e.g., when pulling the same data from different databases or different connection profiles), or when using the same data source but needing a way to limit the output based on user’s level of access (e.g., limit one group of users to see only a specific set of customer information).

To provide an example of how to use multiple library instances, let’s take our Xero library, which can pull information from the Xero accounting system. Let’s assume your company has two branches, one in the United Kingdom and one in the United States. You want to make the data source connectors from the Xero library available for use in the Data Catalog in CloverDX Wrangler and want users to access data from their branch only.

If a library has an initialization job (see Initialization job usage), it is indicated by a bullseye icon.

A library initialization job (a graph or jobflow) can be used after installation to CloverDX Server by server administrators. Users with the Libraries administration permission can run the initialization even when the library is disabled.

The initialization job will come up in the Library Initialization section. You can run the job by clicking on the Initialize library button, even when the library is disabled. Note that you can use any other method for executing the initialization job (REST API, scheduler, etc.).

If your library includes a Health Check job, which was enabled during library installation, a schedule is automatically created in the Schedules module. The schedule is set to run every 24 hours and its status defaults to the library status (i.e., the schedule is disabled if the library is installed as disabled). To quickly get to the schedule detail, click on the "Health Check Schedule for <library name>" link. You can adjust its scheduled time or set up alerts and notifications on the Alerts and Notification tab as needed. The schedule can also be added to a monitor to be tracked in the Monitoring module.

The schedule is automatically enabled if you enable the library, but you can disable it in the library Configuration tab by using the switch button next to the Health Check schedule. You can also run the Health Check job manually by clicking on Run Health Check.

To quickly display the job task or execution history, click on Show in Task History or Show in Execution History, respectively.

If you did not enable the Health Check job during library installation, you can create the schedule by clicking on Schedule Health Check.

If the Health Check job fails, an exclamation mark appears in the library record, and the library is highlighted in red.

If a library includes configurable parameters (see exporting a library for more information), it is indicated by a wrench icon.

The supported parameter types are String, Secure String, Boolean, Integer, Decimal, and Enumeration. The parameter’s description is shown as an “i” icon with a tooltip.

All such parameters are displayed in the Library Parameters section, where their values can also be populated.

If there is a parameter with an invalid value, the wrench icon will turn red to indicate that there is an issue and there will be an exclamation mark next to the affected parameter.

All implemented OAuth2 connections in a library appear on the Configuration tab, where they can be reviewed, updated, authorized, or re-authorized. Unused OAuth2 connections, i.e., connections present in a library project which are not used in any of the public or internal (sub)graphs, are not displayed.

Each OAUth2 connection appears in a separate section on the Configuration tab, and its title includes the filename of the related .cfg file, and the provider of the OAuth2 connection (e.g., Google, Azure, generic),

All connections that need to be authorized have the Authorize button under them, and a note stating that the connection is not authorized. You can review and modify the connection properties if needed. If any of the connection properties are changed, the Authorize button becomes disabled until the changes are saved.

By clicking on the Authorize button, you are redirected to the provider’s website to complete the authorization process. If the authorization process is successful, the button label changes to Re-authorize, and the note changes to indicate that the connection is authorized.

If there is a dependency on another library, the Configuration tab will show the dependencies in the Dependencies section. If there is a dependent library missing, a red icon is displayed in the library list to indicate that there is an unresolved dependency, a warning is displayed in the Configuration tab, and the missing dependency is highlighted in the Dependency section.

If the referenced library is installed under the same name, it is linked automatically; otherwise, you must resolve the dependency manually.

CloverDX libraries may have specific version compatibility requirements. During development process it is possible to specify the minimum and/or maximum CloverDX version with which the library is compatible. If your CloverDX Server version falls outside a library’s supported range, it might not function correctly. This could lead to unexpected behavior or errors. While you can still install the library, it’s highly recommended to use libraries that are compatible with your CloverDX Server version to ensure optimal performance and avoid potential issues. If your installed library is imcompatible with your CloverDX Server version, a warning appears in the Overview tab and a warning icon is displayed in the library list.

The library-level permissions allow the following permissions to be set:

Data source and data target connector permissions are set individually for each data connector by linking a user group to permission. To add a user group to a permission, click in the column to activate the edit mode, and select the desired user group from the list. To remove a group, click on the X button on the right side of the group.

The data connector permissions allow the following permissions to be set:

Users assigned to a user group that has the Unlimited access to sandboxes permission are automatically granted all the library-level and data connector permissions. For other user groups, it is important to set both the library-level permissions and data source or data target connector permissions in the same way. This is because data connectors run on CloverDX Server to generate and display data on the Wrangler side. Having the same permissions for the libraries in which they are installed, and for the data connectors themselves, will ensure that the data connectors will be able to generate and display data successfully.

To make the configuration easier, there is a check in place, which will display a warning if there is a discrepancy between the library-level and data connector permissions. The warning will state which permissions and for which user groups will be ignored, and a warning icon will be displayed next to the group. The configuration can still be saved even when warnings are present; however, it is strongly recommended to correct the permission setup and remove all such warnings to ensure that the data connector can run without an issue.