PatientSecure Client - Command Line

You can also install the Imprivata PatientSecure client from the command line

NOTE:

The command line installation does not check for software prerequisites.

For more information on software prerequisites, see the Imprivata Environment Reference portal.

Syntax

Copy 
ImprivataPatientSecureWebClient.exe /s /v"/QN [/L*V \"<logFilePath>\"] PSWS_ADDRESS=<pswsFQDN> [PSWS_PORT=<pswsServerPort>] [INSTALLDIR=<InstallationDirectory>] [COMBO=<1-8>]] [TOOLBAR_UI_THEME=[XenApp|Default]] [SHOWAUTHENTICATE=[True|False]] [SHOWENROLL=[True|False]] [TOOLBARMODE=[OneSign|Dll]] [TOOLBAR_CUSTOM_DLL=[BJS|MMS|SMH|Wise]] [USE_VIRTUAL_CHANNEL=[True|False]] [VIRTUAL_CHANNEL_PROTOCOL=[[Unknown|Citrix|VMware]]"
IMPORTANT:

In your script, the command-line parameters must be typed in a single line.

Installation may take up to 30 seconds to begin.

Parameters

The following table describes the command-line parameters:

Parameter Required Function
/s Yes Runs the installer in silent mode.
/v Yes

Passes command-line options through to Msiexe.exe, which installs the embedded .MSI file.

NOTE: There is no space between /v and the first double quote, and the parameters being passed by /v that need to be quoted also need to have their double quotes escaped.

/QN No

Runs the embedded MSI in quiet mode with no UI.

TIP: If /s is used, you must use /QN to run the embedded MSI in silent mode.
/L*V Yes

Logs all output to a file and saves the log to the path specified in <logFilePath>.

NOTE: The path is quoted, and the quotes are escaped. The path must already exist and be accessible. The command line will not create the path.
PSWS_ADDRESS Yes

The fully qualified domain name (FQDN) of the Imprivata PatientSecure Web Services application server in your environment.

NOTE: The PSWS_ADDRESS variable should not include an https:// prefix.

PSWS_PORT No

The communication port for the Imprivata PatientSecure Web Services server.

The default port is 7002.
INSTALLDIR No

The base location for installing PatientSecure Client, PatientSecure Client Hub, PatientSecure Client Gateway, and PatientSecure Toolbar.

If not defined, defaults to the following location:

  • 32-bit: "C:\Program Files\Imprivata\PatientSecure\"

  • 64-bit:"C:\Program Files (x86)\Imprivata\PatientSecure\"

NOTE: If the path contains spaces, the INSTALLDIR value may need to be quoted and the quotes escaped.

<COMBO=<1-8>> No

Specifies one of the following pre-defined combinations of PatientSecure features to install, based on your integration.

Specify an integer between 1 and 7 for the groups of features.

Valid values:

1 - Client, Hub, Gateway

2 - Client, Hub, Gateway, Toolbar

NOTE: COMBO=2 includes the Toolbar, but should not be used if you are installing the group of features that support Citrix virtual channel communication. Use COMBO=5 or COMBO=6 for Epic Integration or Toolbar on the Citrix server in combination with USE_VIRTUAL_CHANNEL. For more information, see Configure PatientSecure Virtual Channel.

3 - Client, Hub, Gateway, Epic Integration (for Epic Integration installations)

4 - Epic Integration (for Epic Integration installations)

5 - Epic Integration, Toolbar (for Epic Integration installations)

6 - Toolbar

7 - Epic Kiosk, Hub (for Epic Kiosk installations).

8 - Hub, Gateway (for Windows Kiosk API v.2 integration)
Optional Arguments   Use the following arguments for PatientSecure toolbar or Epic Integration:
SHOWAUTHENTICATE  

Indicates that the Authenticate toolbar button should be visible.

The default is False.

Valid values: True or False.
SHOWENROLL  

Indicates that the Enroll toolbar button should be visible.

The default is True.

Valid values: True or False.
TOOLBAR_UI_THEME  

Indicates that the toolbar is being installed in a Windows (Default) or Citrix environment (XenApp).

Valid values: XenApp and Default.
TOOLBARMODE  

Indicates that the toolbar is being installed in a mode for integration with Imprivata OneSign Application Profile Generator (APG) or for an integration using a custom DLL.

The default is OneSign.

Valid values: OneSign and Dll.
TOOLBAR_CUSTOM_DLL  

IMPORTANT: Before using this parameter, contact your Imprivata Professional Services representative for assistance.

Sets the Custom DLL the Toolbar references, when TOOLBARMODE is set to Dll.

Only valid if the Toolbar is being installed and TOOLBARMODE is set to 'Dll'

The default is BJS.

Valid values: BJS, MMS, SMH, and Wise.
USE_VIRTUAL_CHANNEL  

Causes the Toolbar and Epic Integration components to use Imprivata Virtual Channel as the means of communication. Only valid if Citrix is detected on the server.

For more information, see Configure PatientSecure Virtual Channel

The default is False.

Valid values: True, False.
VIRTUAL_CHANNEL_PROTOCOL  

  • Indicates to the Toolbar which Virtual Channel protocol to use.

  • Has no effect when used with other PatientSecure features.

  • This parameter is set automatically by the installer.

    • The default is Unknown.

    • If Citrix is detected on the target machine, this parameter is set to Citrix.

    • If VMware is detected on the target machine, this parameter is set to VMware.

    • If both Citrix and VMware are detected on the target machine, the installer will favor VMware.

      The only scenario where VIRTUAL_CHANNEL_PROTOCOL is required is when both Citrix and VMware exist on the machine, and you prefer to use Virtual Channel for Citrix instead of VMware.

  • Valid values: Unknown, Citrix, VMware

Examples

IMPORTANT:

In your script, the command-line parameters must be typed in a single line.

Epic 2018 Integration on 64-bit
Copy 
ImprivataPatientSecureWebClient.exe /s /v"/QN /L*V \"C:\myInstallerLogs\PsInstallLog.txt\" PSWS_ADDRESS=myserver.example.com PSWS_PORT=7002 INSTALLDIR=\"C:\Program Files (x86)\Imprivata\" COMBO=3"
Epic Kiosk 2018 on 64-bit endpoint
Copy 
ImprivataPatientSecureWebClient.exe /s /v"/QN /L*V \"C:\myInstallerLogs\PsInstallLog.txt\" PSWS_ADDRESS=myserver.example.com PSWS_PORT=7002 INSTALLDIR=\"C:\Program Files (x86)\Imprivata\" COMBO=7"

Upgrade the Client from the Command Line

To upgrade the PatientSecure clients from the command line:

Copy 
ImprivataPatientSecureWebClient.exe /s /v"/QN /L*V \"<logFilePath>\""
IMPORTANT:

In your script, the command-line parameters must be typed in a single line.

Parameters

The following table describes the command-line parameters for upgrade:

Parameter Function
/s Runs the installer in silent mode.
/v

Passes command-line options through to Msiexe.exe (which installs the embedded .MSI file).

NOTE: There is no space between /v and the first double quote, and the parameters being passed by /v that need to be quoted also need to have their double quotes escaped.

/QN

Runs the embedded MSI in quiet mode with no UI.

TIP: To run PatientSecureClientSetup.exe in silent mode, you must run the embedded MSI in silent mode as well, so /QN must always be present if /s is present.
/L*V

Logs all output to the log and saves the log to the path specified in <logFilePath>.
<logFilePath>

The path for the installer log file.

NOTE: The path is quoted, and the quotes are escaped.