Skip to main content
Version: 4

Custom libraries

Adeptia Connect enables you to upload different types of custom classes and jars using the application's UI. This section guides you on uploading the required classes and jars to different folders in the shared location based on your requirement. On the UI, these upload options are available under the CUSTOM LIBRARIES section as shown in the following screenshot.

InformationYou can use this feature only if the Base Role assigned to you is of Sys Admin type, and you have been authorized to use this feature.

You can upload the custom classes and jars to their designated folders listed below:

Uploading custom classes and jars to the customClasses folder​

 You can upload custom classes or jars to the customClasses folder by following the steps given below. 

Success
  • Uploading a jar that contains custom classes ensures better security.
  • Furthermore, if you want the system to read the custom classes only from the JAR files, set the value for the property customClasses.readMode.jarOnly to true. You can find this property by navigating to Account > Settings > Microservice Settings > WebRunner.
    • Setting this to true allows you to upload only the jar files.
    • The default value for this property is set to false which allows you to upload both the custom classes and jar files. 
  1. Click Configure.

  2. In the left panel, go to CUSTOM LIBRARIES > Custom Classes.

  3. Click Upload classes/jars.

  4. Browse to the required class or jar, and then click Open to upload it.

    WarningYou can browse and upload multiple files.
  5. Restart the webrunner and runtime microservices to bring the changes into effect.

  6. Restart the rest-api microservice if the file contains custom REST API endpoints. 

    WarningOnly a jar file can contain custom REST API endpoints.

Uploading custom jars to the ext folder​

To add custom functionality to the application, you can upload a custom jar to the ext folder by follwowing the steps given below:

  1. Click Configure.

  2. In the left panel, go to CUSTOM LIBRARIES > Ext.

  3. Click Upload jars.

  4. Browse to the required jar, and then click Open to upload it.

    WarningYou can browse and upload multiple files.
  5. Restart the webrunner and runtime microservices to bring the changes into effect.

  6. Restart the rest-api microservice if the file contains custom REST API endpoints.

    WarningOnly a jar file can contain custom REST API endpoints.

Uploading custom jars to the license folder​

The license folder contains license for the application. In an event of license expiry or any other license related changes, you may want to upload the licence jar to this folder.

To upload the license jar, follow the steps given below:

  1. Click Configure.

  2. In the left panel, go to CUSTOM LIBRARIES > License.

  3. Click Upload jars.

  4. Browse to the required license jar, and then click Open to upload it.

    WarningYou can browse and upload multiple files.
  5. Restart the license microservice to bring the changes into effect.

Uploading custom jars to the webapps folder​

Any custom Web Form (war) you create must be deployed to the webapps folder. Follow the steps given below to upload and deploy a war file.  

  1. Click Configure.

  2. In the left panel, go to CUSTOM LIBRARIES > Web Apps.

  3. Click Upload wars.

  4. Browse to the required war, and then click Open to uplaod it.

    WarningYou can browse and upload multiple files.
  5. Restart the portal microservice to bring the changes into effect.

Deleting and downloading the jars​

You can delete or download a custom class or jar that you have uploaded.

  • Delete - Click the  icon against the jar under ACTION .

    Error

    You cannot delete the following jars that are bundled with the application and placed in the customClasses folder:

    • DataInterfaceUtils.jar
    • EDIUtils.jar
    • MapperUtility.jar
    • DataSplitter.jar
  • Download - Click the  icon against the jar under ACTION.