Views:

Description:
ClientSetupCMD is a command line tool that allows to install, uninstall and update the DocuWare Client Modules silently.

Important if you use a DocuWare Cloud Version:
If you are using a DocuWare Cloud version, the recommended installation files are not yet available on your System.
You can find and download the DocuWare.ClientSetupCmd.exe for DocuWare Cloud on the following URL:
https://<Your-DocuWare-Cloud-URL>/DocuWare/ClientSetupData/


You can find the DocuWare.ClientSetupCmd.exe on the (web) server in the following path:
"...\DocuWare\Web\ClientSetupData\ClientSetupCmd\DocuWare.ClientSetupCmd.exe"

To install DocuWare Client Modules only the DocuWare.ClientsetupCmd.exe is required. This application can be copied directly to the client or shared on the server and started from the client. The DocuWare.ClientSetupCmd.exe is also located on clients on which the DocuWare Client Modules were installed with the GUI based setup. There the application can be found as following: “%ProgramFiles(86)%\DocuWare\Client Setup\DocuWare.ClientSetupCmd.exe” (on 64 bit systems) or “%ProgramFiles%\DocuWare\Client Setup\DocuWare.ClientSetupCmd.exe” (on 32 Bit systems).

Commands:

  • install
    • --modules
      • C2Outlook
      • EditSend
      • Scanner
      • Printer
      • Import
      • SmartConnect
      • WEC
      • WorkflowDesigner
      • AdminTool
      • Update (not installed by default)
      • IndexCleaner
      • UrlCreator
    • --auto
      • All available apps will be installed. This can be configured in the file "...\DocuWare\Web\Platform\ClientSetup\ClientSetup.Settings.xml"
    • --server
      • Enter the base address to the Web Client here, e.g. --server=http://server01
    • --orgId
      • Enter the organizations ID here, e.g. --orgId=1
        You can find the OrgId in the DocuWare Administration > Organization > General
    • --logDebug
      • activates the detailed logging
  • uninstall
    • --all
    • --logDebug
      • activates the detailed logging
  • upgrade
    • --all
      • All available apps will be upgraded
    • --server
      • Enter the base address to the Web Client here, e.g. --server=http://server01
    • --orgId
      • Enter the organizations ID here, e.g. --orgId=1
      • This parameter is case sensitive. It must be "orgId"
      • You can find the OrgId in the DocuWare Administration > Organization > General
    • --logDebug
      • activates the detailed logging
  • help
    • Displays help for the commands
  • version
    • Returns the version of the „DocuWare.ClientSetupCmd.exe“.

Examples:

Install Desktop Apps:

  • DocuWare.ClientSetupCmd.exe install --auto --server=http://server01 --orgId=1
    All available apps will be installed. This can be configured in the file "...\DocuWare\Web\Platform\ClientSetup\ClientSetup.Settings.xml"
     
  • DocuWare.ClientSetupCmd.exe install --modules="Printer--server=http://server01 --orgId=1
    DocuWare Printer and all necessary modules (Desktop, CommonOCR) will be installed.
     
  • DocuWare.ClientSetupCmd.exe install --modules="Printer Scanner EditSend--server=http://server01 --orgId=1
    DocuWare Printer, Scan, Edit&Send and all necessary modules (Desktop, CommonOCR) will be installed. 

Uninstall Desktop Apps:

  • DocuWare.ClientSetupCmd.exe uninstall --all
    All apps will be uninstalled 

Upgrade Desktop Apps:

  • On-Premises: DocuWare.ClientSetupCmd.exe upgrade --all --server=http://server01 --orgId=1
  • Cloud: DocuWare.ClientSetupCmd.exe upgrade --all --server=https://<Your-DocuWare-Cloud-URL> --orgId=1
    All apps will be upgraded 

Notes:

  • To get help for the commands install/uninstall/upgrade use help. For example: DocuWare.ClientSetupCmd.exe help install
  • DocuWare.ClientSetupCmd.exe works exactly like the DocuWare Desktop Apps Setup but without any GUI.
  • The MSI files and all prerequisites except .NET Framework will be downloaded from the Server and installed automatically. Therefore .NET Framework 4.5 or higher must be preinstalled. 
    • It is not required to publish the MSI files in a network share separately.
    • Therefore the installation of Visual C++ Redistributable Packages is not necessary.

Return Values:

  • 0 - Success
  • 1 - Logout required
  • 2 - Restart required
  • 4 - Error
  • 5 - Restart required & Error
    Error could occur if you install e.g Windows Explorer Client which needs a restart/logout to complete the installation. Other modules which are not installed yet throws an error because of the mentioned behavior. You'll find more information in the log files.
  • 6 - Restart required & Error
    Same error like described in return value 5