Storebrowse

Storebrowse is a command-line utility that interacts between the client and the server. It is used to authenticate all the operations within StoreFront and with Citrix Gateway.

For documentation on an older version of the Storebrowse utility for Citrix Receiver for Windows, see Storebrowse for Citrix Receiver for Windows documentation.

Using the Storebrowse utility, administrators can automate the following operations:

  • Add a store.
  • Enumerate the published apps and desktops from a configured store.
  • Generate an ICA file by selecting any published Citrix Virtual Apps and Desktops manually.
  • Generate an ICA file using the Storebrowse command line.
  • Launch the published application.

The Storebrowse utility is now part of the Authmanager component. After installing the Citrix Workspace app,the Storebrowse utility is located in the AuthManager installation folder.

To confirm that the Storebrowse utility is installed along with the Authmanager component, check the following registry path:

When Citrix Workspace app is installed by administrators:

   
On a 32-bit machine [HKEY_LOCAL_MACHINE\SOFTWARE\Citrix\AuthManager\Install]
On a 64-bit machine [HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Citrix\AuthManager\Install]

When Citrix Workspace app is installed by users (non-administrators):

   
On a 32-bit machine [HKEY_CURRENT_USER\SOFTWARE\Citrix\AuthManager\Install]
On a 64-bit machine [HKEY_CURRENT_USER\SOFTWARE\WOW6432Node\Citrix\AuthManager\Install]

Requirements

  • Citrix Workspace app Version 1808 for Windows or later.
  • Minimum of 530 MB of free disk space.
  • 2 GB RAM.

Compatibility Matrix

Storebrowse utility is compatible with the following Operating systems:

Operating system
Windows 10 32-bit and 64-bit editions
Windows 8.1, 32-bit and 64-bit editions
Windows 7 SP1, 32-bit and 64-bit editions
Windows Thin PC
Windows Server 2016
Windows Server 2012 R2, Standard, and, Datacenter editions
Windows Server 2012, Standard, and, Datacenter editions
Windows Server 2008 R2, 64-bit edition
Windows Server 2008 R2, 64-bit edition

Connections

Storebrowse utility supports the following types of connections:

  • HTTP store
  • HTTPS store
  • Citrix Gateway 11.0 and later

Note:

On an HTTP store, Storebrowse utility does not accept credentials using the command-line.

Authentication methods

StoreFront servers

StoreFront supports different authentication methods to access stores, however, not all are recommended. For security purposes, some of the authentication methods are disabled by default while creating a store.

  • Username and Password: Enter the credentials to be authenticated to access stores. By default, Explicit authentication is enabled when you create your first store.
  • Domain Pass-through: After authenticating to the domain-joined windows computers, you are automatically logged on to stores. To use this option, enable pass-through authentication when installing the Citrix Workspace app. For more information on domain pass-through, see Configuring Pass-through authentication.
  • HTTP Basic: Enable HTTP Basic authentication so that the Storebrowse utility can communicate with the StoreFront servers. This option is disabled by default on the StoreFront server. You must enable the HTTP Basic authentication method.

Storebrowse utility supports authentication methods in any of the following methods:

  • Using the AuthManager that is in-built along with the Storebrowse utility. Note: You must enable HTTP Basic authentication method on the StoreFront while working with the Storebrowse utility. This applies when user provides the credentials using the Storebrowse commands.
  • External Authmanager that can be included with Citrix Workspace app for Windows.

Single sign-on with Citrix Gateway

Additional to the newly added Citrix Gateway support, you can now use single sign-on with it. You can add a store and enumerate the published resources without having to provide your user credentials.

For more information about single sign-on support with Citrix Gateway, see Support for single sign-on with Citrix Gateway.

Note:

This feature is supported only on domain-joined machines where the Citrix Gateway is configured with the single sign-on authentication.

Launch published desktop or application

You can now launch a resource directly from the store without having to use an ICA file.

Command usage

The following section provides detailed information about the commands that you can use from Storebrowse utility.

-a, –addstore

Description:

Adds new store. Returns the full URL of the store. If return fails, an error is reported.

Note:

Multi-store configuration is supported on Storebrowse utility.

Command example on StoreFront:

Command:

storebrowse.exe –U *username* -P *password* -D *domain* -a *URL of Storefront*

Example:

.\storebrowse.exe –U {Username} –P {Password} –D {Domain} –a [https://my.firstexamplestore.net](https://my.firstexamplestore.net)

Command example on Citrix Gateway:

Command:

storebrowse.exe –U *username* -P *password* -D *domain* -a *URL of CitrixGateway*

Example:

.\storebrowse.exe –U {Username} –P {Password} –D {Domain} –a <https://mysecondexample.com>

/?

Description:

Provides details on Storebrowse utility usage.

(-l), –liststore

Description:

Lists the stores that are added by the user.

Command Example on StoreFront:

.\storebrowse.exe –l

Command Example on Citrix Gateway:

.\storebrowse.exe –l

(-M 0x2000 -E)

Description:

Enumerates resources.

Command example on StoreFront:

.\storebrowse.exe –U {Username} –P {Password} –D {Domain} –M 0x2000 –E <https://my.firstexamplestore.net/Citrix/Store/discovery>

Command example on Citrix Gateway:

.\storebrowse.exe –U {Username} –P {Password} –D {Domain} –M 0x2000 –E <https://my.secondexample.net>

-q, –quicklaunch

Description:

Generates the ICA file for published apps and desktops using the Storebrowse utility. The quicklaunch option requires a launch URL as an input along with the Store URL. The launch URL which can either be the StoreFront server or Citrix Gateway URL. The ICA file is generated in the %LocalAppData%\Citrix\Storebrowse\cache directory.

You can get the launch URL for any published apps and desktops by running the following command:

.\storebrowse –M 0X2000 –E https://myfirstexamplestore.net/Citrix/Second/discovery

A typical launch URL looks like below:

'Controller.Calculator' 'Calculator' '\' '' http://abc-sf.xyz.com/Citrix/Stress/resources/v2/Q29udHJvbGxlci5DYWxjdWxhdG9y/launch/ica

Command example on StoreFront:

.\storebrowse.exe –U {Username} –P {Password}–D {Domain} –q {Launch_URL_of_published_ apps and desktops }<https://my.firstexamplestore.net/Citrix/Store/resources/v2/Q2hJkOlmNoPQrSTV9y/launch/ica> <https://my.firstexamplestore.net/Citrix/Store/discovery>

Command example on Citrix Gateway:

.\storebrowse.exe –U {Username} –P {Password} –D {Domain} –q {Launch_URL_of_published_ apps and desktops} <https://my.secondexmaplestore.com>

-L, –launch

Description:

Generates the required ICA file for published apps and desktops using the Storebrowse utility. The launch option requires the name of the resource along with the Store URL. The name which can either be the StoreFront server or the Citrix Gateway URL. The ICA file is generated in the %LocalAppData%\Citrix\Storebrowse\cache directory.

Run the below command to get the display name of the published apps and desktops:

.\storebrowse –M 0X2000 –E https://myfirstexamplestore.net/Citrix/Second/discovery

This command results in the following output:

'Controller.Calculator' 'Calculator' '\' '' http://abc-sf.xyz.com/Citrix/Stress/resources/v2/Q29udHJvbGxlci5DYWxjdWxhdG9y/launch/ica

The name that is in bold in the above output is used as an input parameter to the launch option.

Command example on StoreFront:

.\storebrowse.exe -U {Username} –P {Password} –D {Domain} –L “{Resource_Name} <https://my.firstexamplestore.net/Citrix/Store/discovery>

Command example on Citrix Gateway:

<.\storebrowse.exe –U {Username} –P {Password} –D {Domain} –L {Resource_Name} https://my.secondexamplestore.com>

-S, –sessionlaunch

Description:

With this command, ou can add a store, enumerate and launch the published resources. This option takes the following as parameters:

  • Username
  • Password
  • Domain
  • Name of the resource to be launched
  • Store URL

However, if the user does not provide the credentials, the AuthManager prompts to enter the credentials and then the resource is launched.

You can get the name of the resource of published apps and desktops by running the command below:

.\storebrowse –M 0X2000 –E https://myfirstexamplestore.net/Citrix/Second/discovery

This command results in the following output:

'Controller.Calculator' 'Calculator' '\' '' http://abc-sf.xyz.com/Citrix/Stress/resources/v2/Q29udHJvbGxlci5DYWxjdWxhdG9y/launch/ica

The name that is in bold in the above output will be used as input parameter to the -S option.

Command example on StoreFront:

.\storebrowse.exe -U {Username} –P {Password} –D {Domain} –S “{Friendly_Resource_Name} <https://my.firstexamplestore.net/Citrix/Store/discovery >

Command example on Citrix Gateway:

.\storebrowse.exe –U {Username} –P {Password} –D {Domain} –S {Friendly_Resource_Name} <https://my.secondexamplestore.com>

-f, –filefolder

Description:

Generates the ICA file in the custom path for a published apps and desktops.

The launch option requires a folder name and the name of the resource as the input with the Store URL. The Store URL can either be the StoreFront server or Citrix Gateway URL.

Command example on StoreFront:

.\storebrowse.exe –f “C:\Temp\Launch.ica” –L “Resource_Name” {Store}

Command example on Citrix Gateway:

.\storebrowse.exe –f “C:\Temp\Launch.ica” –L “Resource_Name” {NSG_URL}

-t, –traceauthentication

Description:

Generates logs for the AuthManager component. Logs are generated only if the Storebrowse utility is using an in-built AuthManager. Logs are generated in the localappdata%\Citrix\Storebrowse\logs directory.

Note:

This option must not be the last parameter listed in the user’s command line.

Command example on StoreFront:

.\storebrowse.exe –t –U {UserName} –P {Password} –D {Domain} –a {StoreURL}

Command example on Citrix Gateway:

.\storebrowse.exe –t –U {UserName} –P {Password} –D {Domain} –a {NSG_URL}

-d, –deletestore

Description:

Deletes existing StoreFront or Citrix Gateway store.

Command example on StoreFront:

.\storebrowse.exe –d https://my.firstexamplestore.net/Citrix/Store/discovery

Command example on Citrix Gateway:

.\storebrowse.exe –d https://my.secondexmaplestore.com

Single sign-on support with Citrix Gateway

Single sign-on lets you authenticate to a domain and use Citrix Virtual Apps and Desktops delivered by that domain without having to re-authenticate to each app or desktop. When you add a store, your credentials are passed through to the Citrix Gateway server, along with the enumerated Citrix Virtual Apps and Desktops, and your Start menu settings.

This feature is supported on Citrix Gateway Version 11 and later.

Prerequisites:

For the prerequisites on how to configure Single Sign-On for Citrix Gateway, see Configure domain pass-through authentication.

The single sign-on feature with Citrix Gateway can be enabled using the Group Policy Object (GPO) administrative template.

Note:

When you upgrade from Citrix Receiver to Citrix Workspace app or install Citrix Workspace app for the first time, you must add the latest template files to the local GPO. For more information on adding template files to the local GPO, see Configuring Group Policy Object administrative template. In an upgrade scenario, the existing settings are retained when the latest files are imported.

  1. Open the Citrix Workspace app GPO administrative template by running gpedit.msc
  2. Under the Computer Configuration node, go to Administrative Template > Citrix Component > Citrix Workspace > User Authentication > Single Sign-on for Citrix Gateway.
  3. Use the toggle options to Enable or Disable the Single Sign-On option.
  4. Click Apply and OK.
  5. Restart the Citrix Workspace app session for the changes to take effect.

Limitations:

  • Enable the HTTP Basic Authentication method on the StoreFront server for credential injection operations with the Storebrowse utility.
  • If you have a HTTP store, and when you try connecting to the store using the utility to enumerate or launch the published Citrix Virtual Apps and Desktops, the credential injection using the command-line option is unsupported. As a workaround, use the external AuthManager module if you do not provide credential using the command line.
  • Storebrowse utility currently supports only single store configured the Citrix Gateway on the StoreFront server.
  • Credential Injection in the Storebrowse utility works only if the Citrix Gateway is configured with Single-Factor Authentication.
  • The command-line options Username (-U), Password (-P) and Domain (-D) of the Storebrowse utility are case-sensitive and must be in upper case only.