MyQ Document Processor
MyQ Document Processor
Breadcrumbs

Installing MDP

This section explains how to install MyQ Document Processor (MDP).

The installer deploys MDP as a Windows Service, with each document processing worker as a child process. MDP communicates over HTTPS and you configure the listing port during the installation.

  • Service name: MyQ.DocumentProcessor.Api

  • Default install folder: C:\Program Files\MyQ Document Processor

  • Default data folder: C:\ProgramData\MyQ Document Processor

Before you Begin

Download DocumentProcessorSetup.exe from the MyQ Community portal.

Review the system requirements and ensure all prerequisites are met before starting the installation.

Required permissions

The installer must be able to restrict C:\ProgramData\MyQ Document Processor to SYSTEM, local administrators, and the service account. Installation fails if these permissions cannot be applied.

Install MDP

  1. Run DocumentProcessorSetup.exe and accept the UAC prompt.

  2. Choose the installation folder, or keep the default.

  3. On the Select Additional Tasks page, choose whether to Create a Start Menu shortcut (default: enabled). The selection is remembered for upgrades.

  4. On the Server Configuration page:

    • The protocol is fixed as HTTPS.

    • Enter the Port that MDP will listen on (default: 8080).

    • Open Windows Firewall for the selected port is enabled by default. Clear this option if you manage firewall rules separately.

  5. On the Service Account page, select the Windows identity that will run the service:

    • Virtual service account (default, recommended): uses NT SERVICE\<ServiceName>, and no password or manual account management is required. The identity is tied to the service name.

    • LocalSystem: runs with full system privileges. This option is less secure.

    • Existing account: uses a pre-created Windows user account. You must provide the username and password.

  6. Click Install. If the required .NET runtime is not found, the installer downloads and installs it automatically.

  7. Click Finish when the installation completes.

If Windows blocks the installer file, click Run or Allow when prompted, or right-click the file, select Properties, and check Unblock on the General tab before running it again. If you see a "Windows protected your PC" message, click More info, then Run anyway.

After installation, the Systray Agent runs automatically and starts each time a local administrator signs in. The MDP status appears in the Windows notification area.

After installation, open a browser and go to https://localhost:PORT/ to see a basic health response.

Modify an Existing MDP Installation

You can change the port, firewall opening option, or the service account later without re-installing the program.

  1. Go to Settings > Apps > Installed apps (or Control Panel > Programs)

  2. Find MyQ Document Processor and click Modify. Alternatively, re-run the same version of the installer.

  3. Adjust the settings on the Server Configuration or Service Account pages and continue.

  4. The installer writes changes to the registry and restarts the service so they take effect immediately.

Modify mode updates settings and restarts the service. It does not re-copy application files unless they were missing. In Modify mode, the installation path is locked and cannot be changed.

Warning: Changing the Service Account will cause the Root CA and HTTPS certificates to be regenerated. This is because the certificate password is encrypted using the service account's identity (DPAPI). You will need to redistribute the new CA certificate to all clients to maintain connection trust.

Silent Installation

Run the installer silently from an elevated PowerShell prompt.

PowerShell
# Install (HTTPS on 8443)
.\MyQDocumentProcessorSetup.exe /VERYSILENT /PORT=8443

# Install with non-interactive service account (Virtual Account)
.\MyQDocumentProcessorSetup.exe /VERYSILENT /PORT=8443 /SERVICEACCOUNT="NT SERVICE\MyQ.DocumentProcessor.Api"

# Disable installer-managed firewall rule creation
.\MyQDocumentProcessorSetup.exe /VERYSILENT /PORT=8443 /OPENFIREWALL=0

/OPENFIREWALL accepts 1|true|yes or 0|false|no. If omitted, the installer uses the last saved value from previous install/upgrade (default is enabled for first install).

Silent installations create the Start Menu shortcut by default. To prevent this, use /TASKS=""

.\MyQDocumentProcessorSetup.exe /VERYSILENT /PORT=8443 /TASKS=""

Troubleshooting Installation Issues

Installation fails with a service-installation error

  • Check install-service.log in the installation folder. Installation is aborted on purpose if the permissions on the data folder cannot be restricted – the product will not run with a private-key and credential store that local users can read.

The tray icon does not appear after logon

  • The account must be a member of the local Administrators group; the agent does not run for standard users.

  • Verify the scheduled task MyQ DocumentProcessor Systray exists and is enabled in Task Scheduler. You can always start the agent from the Start Menu shortcut.

Service won’t start with HTTPS

  • Check Windows Event Viewer > Windows Logs > Application for .NET runtime errors.

  • Verify the service account has permissions to read the Certificates folder in ProgramData. If the password decryption fails (e.g., account changed), the service will regenerate the password and certificates.

Port already in use

  • Pick a different port in Modify mode or stop the conflicting service.

How to test the API 

# HTTPS (ignore self-signed in dev)
Invoke-WebRequest https://localhost:8443/ -SkipCertificateCheck -UseBasicParsing

View Logs

  • You can view logs for the MDP service in %ProgramData%\MyQ Document Processor\logs\