Collaboration Server Command Line Administration Tool

MicroStrategy Collaboration server ships with its own command line administration tool called admintool.js. This administration tool allows users to search, view, and delete information in the Collaboration server repository without directly interacting with the database.

To invoke the Collaboration server admin tool, you need to run the Node.js executable and supply the file path for the admin tool and the Collaboration server configuration file.

The Node.js executable (node.exe) can be found here:

• Windows: <INSTALL_PATH>\Common Files\MicroStrategy\nodejs\node.exe
• Linux: <INSTALL_PATH>/NodeJS/<NODEJS_LINUX_VERSION>/bin/node

The admintool.js file can be found here:

• Windows: <INSTALL_PATH>\MicroStrategy\Collaboration Server\node_modules\mstr-collab-svc\admintool.js
• Linux: <INSTALL_PATH>/CollaborationServer/node_modules/mstr-collab-svc/admintool.js

The Collaboration server configuration file (config.json) can be found here:

• Windows: <INSTALL_PATH>\MicroStrategy\Collaboration Server\config.json
• Linux: <INSTALL_PATH>/CollaborationServer/config.json

Starting the Administration Tool

1. Open a terminal application.
2. Enter the three file locations in the following format:

   $ "<PATH_TO_NODE>" "<PATH_TO_ADMIN_TOOL_FILE>" "<PATH_TO_CONFIG_FILE>"

   You can add the Node.js executable to your PATH variable and change to the Collaboration Server directory. If so, you can enter:
   $ node node_modules/mstr-collab-svc/admintool.js config.json

The welcome page is shown in console after the tool starts.

Welcome to the Collaboration Server Administration Tool (v10.xx.x.xxx)
Type "help" to list the available commands.
cmd>

Command List

The Admin Tool recognizes the following commands: