Using the Console

ManualWorks provides an administrator console. To use it, click the <1Consoleterminal> button in the sidebar.

To check the version, enter the following command in the console and press Enter.

version

Commands

Log

`get-log-level`

To check the current log level, enter the following command. The default is INFO.

get-log-level

`change-log-level`

To change the log level, enter the following command. Set the level with the -level option.

change-log-level -level INFO

You can set the following log levels.

ALL
SEVERE
WARNING
INFO
CONFIG
FINE
FINER
FINEST
OFF

The default log level is INFO. If you change it to a more detailed level than INFO, such as CONFIG, FINE, FINER, FINEST, or ALL, the logs grow and ManualWorks notifies the administrator when the server starts. Do not change the log level without a specific reason.

Web Cache

`enable-web-cache`

To use the web viewer cache, enter the following command.

enable-web-cache

The web cache is used by default.

`disable-web-cache`

To stop using the web viewer cache, enter the following command.

disable-web-cache

Unless you have a specific reason, we recommend using the web cache.

`clear-web-cache`

To clear the web viewer cache, enter the following command. All existing web cache is deleted and rebuilt.

clear-web-cache

Encrypting Database Connection Information

For details, see Encrypting Database Connection Information.

`get-encrypted-db-info`

To check the encrypted database connection information, enter the following command.

get-encrypted-db-info

`encrypt-db-info`

To encrypt the database connection information, enter the following command.

encrypt-db-info -url jdbc:h2:h2/database; -username USERNAME -password PASSWORD

The -url, -username, and -password options are the attribute values of the Resource tag in the 3RABBITZ_HOME/tomcat/conf/server.xml file.

Managing Document Search Index Files

These commands check and delete the index files used for document search.

`get-search-index`

To check the document search index files, enter the following command.

get-search-index -id DOCUMENT_OR_TAG_ID

`remove-search-index`

To delete the document search index files, enter the following command.

remove-search-index -id DOCUMENT_OR_TAG_ID

Restricting Uploadable File Extensions

These commands restrict the file extensions that can be uploaded.

`add-upload-file-extension`

To add an uploadable file extension, enter the following command.

add-upload-file-extension -extension FILE_EXTENSION

`remove-upload-file-extension`

To remove an uploadable file extension, enter the following command.

remove-upload-file-extension -extension FILE_EXTENSION

`list-upload-file-extension`

To check the uploadable file extensions, enter the following command.

list-upload-file-extension

Preferences

These commands check and change preference values.

`get-preference`

To check a preference value, enter the following command. Specify the preference name with the -name option.

get-preference -name LOG_LEVEL

`set-preference`

To change a preference value, enter the following command. Specify the preference name with the -name option and the value with the -value option.

set-preference -name BACKUP_KEEP_COUNT -value 5

Numeric preferences accept only numbers. Directory preferences determined by the data directory, such as UPLOAD_DIR, cannot be changed.

`remove-preference`

To remove a preference value, enter the following command. Only preferences that are allowed to be removed, such as APP_CSS, APP_JS, and DEFAULT_ROLE, can be removed.

remove-preference -name APP_CSS

Custom Menus

These commands add custom menus to the menu. Clicking a custom menu opens the specified address in a new window.

`add-menu`

To add a custom menu, enter the following command. Specify the menu ID with the -id option, the menu name with the -name option, and the address with the -url option. Menus are shown in ID order.

add-menu -id 1 -name Homepage -url https://example.com

`update-menu`

To change a custom menu, enter the following command. Specify the values to change with the -name and -url options.

update-menu -id 1 -url https://example.com/support

`remove-menu`

To delete a custom menu, enter the following command.

remove-menu -id 1

`list-menu`

To check the list of custom menus, enter the following command.

list-menu

`add-doc-ac`

Use this to add access permissions to all documents.

To undo it, you must change each document individually, so use it with care.

add-doc-ac -type [owner|collaborator|reviewer] -user [ALL_USERS|PROJECT_MEMBERS|userid|groupid]

Note the following.

Set the type option to one of owner (Owners), collaborator (Collaborators), or reviewer (Readers).
Set the user option to one of ALL_USERS (all users), PROJECT_MEMBERS (all project members), userid (username), or groupid (group identification).
The username and group identification mean the ID of the user or group, not the UUID.
You cannot set all users as owners of a document.
To set a user as an owner or collaborator, the user must have the “Write & Read” role.

For example, to make all users readers of all documents, run the following command.

add-doc-ac -type reviewer -user ALL_USERS

To make all project members collaborators of all documents, run the following command.

add-doc-ac -type collaborator -user PROJECT_MEMBERS

To make the user with the username admin an owner of all documents, run the following command.

add-doc-ac -type owner -user admin

`clear`

To clear the console window, enter the following command.

clear

`clear-preview-image`

To delete the preview image files used by PDF themes and PDF page layouts, enter the following command.

clear-preview-image

Preview files are recreated when they are missing, so this command has no effect on the system.

`generate-key`

To create a key for encrypting user names and email addresses, enter the following command. For details, see Encrypting User Names and Email Addresses in the Database.

generate-key

`java-gc`

To run Java garbage collection, enter the following command.

java-gc

`java-heap`

To check Java heap memory information, enter the following command.

java-heap

`java-version`

To check the Java version, enter the following command.

java-version

`monitor`

To check the status of Work and caches, enter the following command. It shows the number of Work items that can run at the same time, the number of remaining Work items, and the size of the web cache, document cache, and others.

monitor

`network-interface`

To check the server's network interfaces and the server ID for each interface, enter the following command. For details, see Setting the Network Interface.

network-interface

`optimize-doc`

To fix paragraph content that does not match its format across a whole document, enter the following command.

optimize-doc -b f26bac2cbacec04d

Specify the UUID of the ManualWorks document with the -b option.

`remove-all-export-files`

To delete all files created from books and short documents at once, enter the following command. Files created from tags and the latest file of each format created from the whole document are not deleted.

Deleted files cannot be recovered.

remove-all-export-files

`server-id`

To check the server ID, enter the following command.

server-id

`set-update-file`

In some environments, ManualWorks cannot reach the update server or you cannot upload the update file. In that case, specify the update file with the following command.

set-update-file -f '/home/rabbitz/3rabbitz-2025-0544.tar.gz'

Specify the absolute path of the ManualWorks installation file with the -f option. If the path has no spaces, you can omit the single quotes.

The ManualWorks installation file for the update must be on the server where ManualWorks is installed.

`version`

To check the ManualWorks version, enter the following command.

version

To check the Java version, enter the following command.

version -java

`uuid`

To generate a random UUID of 16 lowercase letters and numbers, enter the following command.

uuid