Overview - API Server - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Essential - Standard - Premier

API Server

Platform
OnBase
Product
API Server
Release
Foundation 22.1
License
Essential
Standard
Premier

This section explains how use the Hyland Application Settings Utility. For more information on how to acquire the utility, contact your first line of support.

To deploy the Hyland Application Settings Utility, unpackage the files in the release package by extracting them to a location in your environment. You can then use the command line from that location to execute the commands for the utility.

The following commands are available:

Command

Description

write

Writes a specified property value to a JSON configuration file. You can also encrypt the property value with this command.

See Writing a Value in a JSON File.

read

Reads a specified property value in a JSON configuration file and returns it in the command-line console output. You can also decrypt an encrypted property value with this command.

See Reading a Value in a JSON File.

help

Returns a list of available commands and a short description of each command. You can add a command after the help command to return a list of the parameters used by that command.

For example, the following command returns a list of the parameters for the write command:

Hyland.Application.Settings.Utility.exe help write

version

Returns the full name and version number of the Hyland Application Settings Utility.