Using Scriptable Configuration - API Server - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

API Server

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

Configuration of the storage system can also be completed using scripted commands. For most users, the configuration method described in Configuring a Storage System is recommended. Scriptable configuration does allow for automation of the process by more advanced users. The command for using scriptable configuration is storage-scriptable, so the very basic scripted command is:

\TempFileService.Configuration.exe storage-scriptable

Scriptable configuration recognizes the following commands:

  • Add: This command is used to create a storage system. For example: TempFileService.Configuration.exe storage-scriptable add --type S3 --url http://localhost:9000 --bucket user-bucket --access-key manager --secret-key password --force-http --force-path --tenant MyTenantNameHere --json-config M:\TEMPFS\5_tempfs.json
Note:

The returned and displayed ID is needed for the other commands.

  • Update: This command is used to update the settings of an existing storage system. For example: TempFileService.Configuration.exe storage-scriptable update --id 7 --type S3 --url http://localhost:9000 --bucket user-bucket --access-key manager --secret-key password --force-http --force-path --tenant MyTenantNameHere --json-config M:\TEMPFS\5_tempfs.json
  • Delete: This command is used to delete an existing storage system. For example: TempFileService.Configuration.exe storage-scriptable delete --id 6 --tenant MyTenantNameHere --json-config M:\TEMPFS\5_tempfs.json
  • Set Active: This command sets the specified storage system as the active system. For example: TempFileService.Configuration.exe storage-scriptable set-active --id 7 --short-term --mid-term --cache --tenant MyTenantNameHere --json-config M:\TEMPFS\5_tempfs.json

During configuration, scriptable configuration should be used to configure tenant storage methods using the Add command and set the active storage system using the Set Active command. For most other uses, scriptable configuration should only be used by advanced users. For additional guidance, contact your first line of support.