Workiva Support Center

Within chains, a "shared library" is any external library or dependency required for the proper function of a connector. These shared libraries are maintained, updated, and distributed by Workiva directly (with a few exceptions). At this time, Java 21 is our only shared library, but additional dependencies may be added as necessary.

To disable shared libraries and substitute your own self-installed library, add a new configuration option to your GroundRunner.config file:

SHARED_LIBRARY_OVERRIDES=java-21=/path/to/java21/home,java-24=/path/to/java24/home

The path provided in this override must be valid, and it must contain a folder named "bin" that contains the relevant executables. However, the path itself should not include the bin directory.

Example

Consider the folder structure of a sample Java installation: 
~/.asdf/installs/java/corretto-21.0.6.10.1 ❯ tree -L 1

This structure will look like this: 

.
├── ADDITIONAL_LICENSE_INFO
├── ASSEMBLY_EXCEPTION
├── LICENSE
├── README.md
├── bin
├── commitId.txt
├── conf
├── include
├── jmods
├── legal
├── lib
├── man
├── release
└── version.txt

You'll notice the bin folder in this file structure. This folder is not included in our provided path.

Instead, the override in the GroundRunner.config file looks like this on a Mac: 
SHARED_LIBRARY_OVERRIDES=java-21=/Users/username/.asdf/installs/java/corretto-21.0.6.10.1

On a Windows machine, it would look something like this: 
SHARED_LIBRARY_OVERRIDES=java-21=C:\Program Files\Java\jre-21

Note: Make sure your Windows install uses backslashes (\) in the provided path.

JRE installation

A Java Runtime Environment (JRE) is not installed with the GroundRunner during the initial GroundRunner installation. After setup is completed and the GroundRunner is running, it will automatically download a JRE as needed to run commands that depend on Java. No installation or admin intervention is required, and the retrieved JRE will not affect existing JRE installations if they exist on the host. 
Learn more about GroundRunner requirements.

Excluded connectors

These connectors are not compatible with Workiva's shared libraries and must use the GroundRunner's system Java installation, as these connectors still use custom certificates read from the cacerts file:

• Oracle Essbase
• Oracle Hyperion Financial Management (HFM)

Note: When supported connectors are executed on the same GroundRunner as an excluded connector, the supported connectors will still use Workiva's shared libraries by default. You can override this by configuring the SHARED_LIBRARY_OVERRIDES option as detailed above.