Docs
Search K

Appearance

MinuteView Controller License Management Guide ​

Overview ​

The MinuteView Controller uses a modern OAuth 2.0 Client Credentials authentication system that eliminates the need to deploy license files to individual workstations. Instead, license credentials are securely stored in the Vault database and automatically distributed to all users.

Key Benefits ​

  • Centralized Management: Upload credentials once to the Vault database
  • Automatic Distribution: All users automatically receive license updates
  • No File Deployment: Eliminates the need to deploy .lic files to thousands of PCs
  • Easy Updates: License renewals require only a single credential update

System Architecture ​

Pre-Login Phase ​

  1. Controller checks for cached menu configuration in Windows temp directory
  2. If no cache found, shows minimal interface with license upload option
  3. Vault login proceeds normally

Post-Login Phase ​

  1. Controller reads OAuth credentials from Vault database option Tentech.DocControl.License
  2. Authenticates with MinuteView server using Client Credentials flow
  3. Downloads current menu configuration and caches it locally
  4. Displays full Controller interface based on licensed features

Administrator Setup Guide ​

Initial License Upload ​

  1. Obtain Credentials File

    • Contact Tentech support to receive your JSON credentials file
    • File contains: Client ID, Client Secret, Server URL, Company Name, and Scope

  2. Upload to Vault

    • Login to Vault as administrator
    • Navigate to Help > Minute Controller Help > License Management
    • Click Select Credentials File...
    • Browse to your JSON credentials file
    • Verify file shows as "Valid" with green checkmark
    • Click Upload to Vault

  3. Verify Upload

    • Success message confirms upload completed
    • License status section shows company name and server details
    • Close and restart Vault to see full Controller menu

Sample Credentials File Format ​

json
{
  "ClientId": "your-client-id-here",
  "ClientSecret": "your-client-secret-here", 
  "ServerUrl": "https://your-minuteview-server.com",
  "CompanyName": "Your Company Name",
  "Scope": "api:powershell api:vault",
  "Features": ["CONTROLLER"],
  "Metadata": {
    "CreatedDate": "2025-09-01T00:00:00Z",
    "Version": "1.0",
    "IsTransferable": true
  }
}

License Updates/Renewals ​

  1. Receive New Credentials

    • Obtain updated JSON credentials file from Tentech
    • Typically required for license renewals or server changes

  2. Update Process

    • Navigate to Help > Minute Controller Help > License Management
    • Click Select Credentials File... to choose new file
    • Click Upload to Vault to replace existing credentials
    • Existing users will automatically receive updates after restarting Vault

License Removal ​

  1. Access License Management

    • Navigate to Help > Minute Controller Help > License Management

  2. Delete License

    • Click Delete License button (red button)
    • Confirm deletion in warning dialog
    • License credentials are removed from Vault database
    • All users will lose Controller access after restarting Vault

User Experience ​

First Time Users (No License) ​

  • Controller shows message after login: "Controller could not be loaded"
  • Help menu shows only "License Management" option
  • Contact administrator to upload license credentials

Licensed Users ​

  • Full Controller menu appears automatically after Vault login
  • No action required - credentials loaded from Vault database
  • Menu configuration cached locally for faster startup

After License Updates ​

  • Users may see notification: "Menu configuration has been updated from the server"
  • Restart Vault to see new menu options
  • Updated credentials automatically applied

Troubleshooting Guide ​

License Upload Issues ​

"Invalid credentials file" Error ​

Symptoms: File shows red "Invalid credentials file" message Causes:

  • JSON file format is incorrect
  • Missing required fields (ClientId, ClientSecret, ServerUrl)
  • Corrupted or truncated file

Solutions:

  1. Verify JSON file format matches sample above
  2. Ensure all required fields are present and not empty
  3. Re-download credentials file from MinuteView Server
  4. Test file in JSON validator tool

"Error saving credentials to vault" Error ​

Symptoms: Upload button clicked but save fails Causes:

  • Insufficient Vault permissions
  • Vault database connection issues
  • Vault options table locked

Solutions:

  1. Ensure user has administrative privileges in Vault
  2. Verify Vault connection is stable
  3. Try again after other users close Vault
  4. Contact Vault administrator if permissions issues persist

Authentication Issues ​

"Authentication failed" in Debug Logs ​

Symptoms: Controller loads but features don't work, debug logs show auth failure Causes:

  • Invalid Client ID or Secret
  • Server URL incorrect or unreachable
  • Network connectivity issues
  • Expired credentials

Solutions:

  1. Verify credentials are correct in License Management dialog
  2. Test server URL in web browser
  3. Check network connectivity and proxy settings
  4. Contact Tentech if credentials may be expired
  5. Re-upload credentials file from Tentech

"Request timed out" or Connection Hangs ​

Symptoms: Authentication appears to hang or timeout Causes:

  • Network proxy blocking requests
  • Firewall restrictions
  • SSL certificate issues
  • Server unavailable

Solutions:

  1. Configure proxy settings if behind corporate firewall
  2. Check with IT department about firewall rules
  3. Verify server URL is accessible from corporate network
  4. Test connection using Postman or similar tool
  5. Check debug logs for specific error details

"SSL Certificate validation issue" in Debug Logs ​

Symptoms: Connection fails with SSL errors Causes:

  • Self-signed certificates on server
  • Certificate expired or invalid
  • Corporate proxy interfering with SSL

Solutions:

  1. Contact server administrator about SSL certificate
  2. Work with IT department to resolve proxy SSL issues
  3. For development environments, SSL validation can be bypassed (contact Tentech)

"No menu configuration found" Message ​

Symptoms: Controller shows limited interface after login Causes:

  • No cached configuration available
  • Credentials not uploaded to Vault
  • Network issues preventing configuration download

Solutions:

  1. Upload license credentials using License Management
  2. Restart Vault after credential upload
  3. Check network connectivity to server
  4. Verify server is responding to configuration requests

Symptoms: Some Controller features not visible Causes:

  • License renewal changed available features
  • Server configuration updated
  • Local cache needs refresh

Solutions:

  1. Restart Vault to refresh menu configuration
  2. Check with administrator if license features changed
  3. Clear local cache (delete VaultDocControl_MenuConfig_Cache.json from temp folder)
  4. Re-upload credentials if issues persist

General Troubleshooting ​

Debug Logging ​

Enable Debug Logs:

  1. Contact Tentech for debug logging instructions
  2. Debug logs written to Controller debug log file
  3. Look for entries containing "(AuthenticateAsync)" and "(TestConnectivity)"

Key Log Entries:

  • Starting authentication request to: [URL] - Shows attempted connection
  • Received response: [StatusCode] - Shows server response
  • Authentication successful - Confirms working authentication
  • Request timed out or exceptions - Indicates connection problems

Network Diagnostics ​

  1. Test Server Connectivity:

    ping your-minuteview-server.com
telnet your-minuteview-server.com 443

  2. Test API Endpoint (using Postman or curl):

    POST https://your-server.com/api/clientapptoken
Content-Type: application/json
Body: {
  "ClientId": "your-id",
  "ClientSecret": "your-secret", 
  "GrantType": "client_credentials",
  "Scope": "data:read data:write"
}

Cache Management ​

Clear Local Cache:

  1. Navigate to Windows temp folder: %TEMP%
  2. Delete file: VaultDocControl_MenuConfig_Cache.json
  3. Restart Vault to rebuild cache

Force Configuration Refresh:

  1. Clear cache as above
  2. Use License Management to re-upload credentials
  3. Restart Vault

Migration from Legacy License Files ​

For Administrators ​

  1. Keep existing .lic files during transition period
  2. Upload new OAuth credentials using License Management
  3. Test with pilot users before full deployment
  4. Remove .lic files after confirming OAuth system working

For Users ​

  • No action required - transition is automatic
  • Users will see updated menu after restarting Vault
  • Contact administrator if Controller stops working after transition

Fallback Process ​

If OAuth system has issues, Controller will attempt to fall back to legacy .lic file system temporarily. This ensures continuity during troubleshooting.

Best Practices ​

For Administrators ​

  • Test credentials in development environment first
  • Coordinate updates to minimize user disruption
  • Monitor debug logs during initial deployment
  • Keep backup of working credentials file
  • Document server URLs and credential details securely

For Organizations ​

  • Assign backup administrators who can manage licenses
  • Establish update procedures for license renewals
  • Test network connectivity from all user locations
  • Coordinate with IT for firewall and proxy configuration
  • Plan restart schedule for menu configuration updates

Contact Information ​

For technical support with licensing issues:

  • Tentech Support: Contact for credential files and server issues
  • Vault Administrator: For Vault database and permission issues
  • IT Department: For network, proxy, and firewall configuration

Appendix ​

File Locations ​

  • Credentials Storage: Vault database option Tentech.DocControl.License
  • Menu Cache: %TEMP%\VaultDocControl_MenuConfig_Cache.json
  • Sample Credentials: VaultDocControl\Resources\sample-credentials.json

API Endpoints ​

  • Token Endpoint: POST /api/clientapptoken
  • Configuration Endpoint: GET /api/GetDocControlFeatures (with Bearer token)

Security Notes ​

  • Client Secret is encrypted in Vault database
  • Bearer tokens automatically expire and refresh
  • Machine fingerprinting available for non-transferable licenses (not recommended for Controller)

Last Updated: September 2025
Version: 1.0

Tentech 2024