Installing And Deploying The Vim Connect Desktop Agent MSI - Vim

Installing And Deploying The Vim Connect Desktop Agent MSI

This guide provides instructions on deploying and installing Vim Connect’s Desktop Agent in various ways

  1. Manual installation – best for small organizations that plan to install the agent on a limited number of computers, as it can be faster to install the software manually than to automate it simply.
  2. Customizable Installation via command-line – a command line install is a great way to customize how the installation would look regarding UI and behavior. This way can also be used to deploy the agent via tools like GPO or any other deployment tools you might use.
  3. Deployment via GPO – deploy the agent via a Group Policy Object (GPO) with a scheduled task and a batch script that will contain the needed parameters the MSI file requires for installation, this method does not require restarting the endpoints.
  4. Troubleshooting Steps for GPO – Should you run into issues with GPO deployment, refer to these steps for troubleshooting.

Manual Installation

  1. Download the MSI file: https://vim.health/desktop_ecw
  2. Move the installation MSI file to a workstation machine and double-click the MSI to start the installation. You can also download the MSI on each workstation directly from the link above.
  3. The MSI will start installing, and you’ll be asked to enter your organization key and click Install.
  4. After clicking install, the agent will take a few seconds to finish installing.
  5. After the client finishes installing, you will see the Vim logo among the tray icons.

 

Customizable Installation via Command-Line

  1. Download the MSI file: https://vim.health/desktop_ecw
  2. In order to install the MSI via the command line, you will need to utilize these parameters:
    1) /qn → this flag ensures the installation will be quiet and non-interactable for the user.
    2) organiztion_key → your organization key.
    3) RUN_ON_STARTUP → whether the agent will run after a computer restart.
    *Note: this must be set to “true” unless eCW is published via Citrix, in which case it
    should be set to “false”.

    4) /L*V → this will generate an Installation log for troubleshooting purposes. You can change
    the path to whatever you want.
    Note: Setting the parameters correctly is crucial for a successful installation. Parameters can only be changed
    by uninstalling the agent and reinstalling it from scratch.
    Example usage:

    msiexec /i vim-connect-ecw-1.2.48.msi /qn PRODUCT_KEY=organization_key
    RUN_ON_STARTUP="true" /L*V "C:\vim-connect-msi-install.log"
  3. In order to run the script, open CMD as administrator and navigate to the folder containing the MSI.
  4. Paste the command and press enter.
  5. After the client finishes installing, you will see the Vim logo among the tray icons.

Deployment via GPO

  1. Download the MSI file: https://vim.health/desktop_ecw
  2. Create a shared folder on a network-accessible server.
    See this guide on how to create such a folder:
    Creating a Network Shared Distribution
  3. Create a .bat file with the following code and change the parameters according to your needs:
    if exist "C:\Program Files\Vim Connect\vim-ehr-agent.exe" (
    echo exists
    ) else (
    msiexec /i "\\path\to\msi" /qn PRODUCT_KEY=organization_key
    RUN_ON_STARTUP="true" /L*V "C:\vim-connect-msi-install.log"
    )

    Parameter Explanation:
    1) \\path\to\msi → UNC path (network path) to the MSI file
    (Do not use mapped drives, UNC only)
    2) /qn → this flag ensures the installation will be quiet and non-interactable for the user.
    3) ORGANIZATION_KEY → your organization key.
    4) RUN_ON_STARTUP → whether the agent will run after a computer restart.
    *Note: this must be set to “true” unless eCW is published via Citrix, in which case it
    should be set to “false
    ”.
    5) /L*V → this will generate an Installation log for troubleshooting purposes.
    You can change the path to whatever you want.

  4. Move the MSI and the .bat file you created to the network shared folder.
  5. Open the Start menu, search for Run, and press Enter
  6. Type gpmc.msc
  7. The group policy management windows will open
  8. Right-click your domain name and click Create a GPO in this domain and Link it
  9. Enter a name to your policy.
  10. Now right-click the policy you just created then click Edit.
  11. Go to Computer Configurations → Preferences → Control Panel Settings → Scheduled Tasks.
  12. Right-click Scheduled Tasks → New → Immediate Task (At least Windows 7)
  13. Type a name for the scheduled task.
  14. Click Change User or Group → type System then click enter, make sure that you see NT AUTHORITY\System after
    clicking enter.
  15. Check Run whether the user is logged in or not.
  16. Check Run with the highest privileges.
  17. Set Configure for Windows Vista or Windows Server 2008.
  18. Your configurations should resemble this window:
  19. Click the Action Tab
  20. Click New
  21. Set the following:
    A. Action → Start a Program
    B. Program/script → cmd.exe
    C. Add Arguments → /c start “” “\\path\to\bat_file”
    *Note: replace “\\path\to\.bat_file” with the UNC path to
    the batch script file and do not remove the quotes
    *Your configuration should resemble the following window:
  22. Make sure that in the Conditions, Settings, and Common tabs nothing is configured or enabled.
  23. Click OK to close the window.
  24. On a workstation, open CMD and type gpupdate /force to force the workstation to apply the group policy.
  25. Alternatively, you can wait around 90 minutes for the policy to apply automatically.
  26. After the client finishes installing, you will see the Vim logo among the tray icons.