Product documentation
Citrix Virtual Apps and Desktops
Service Current Release 2311 2308 2305 2303 2212 2209 2206 2203 LTSR 1912 LTSR
View PDF

Use Search in Studio

October 30, 2023
Contributed by: 
C C

Note:

You can manage your Citrix Virtual Apps and Desktops deployment using two management consoles: Web Studio (web-based) and Citrix Studio (Windows-based). This article covers only Web Studio. For information about Citrix Studio, see the equivalent article in Citrix Virtual Apps and Desktops 7 2212 or earlier.

Use the search feature to view information about specific machines, sessions, machine catalogs, applications, or delivery groups. After selecting Search in Web Studio, you have several options:

  • Use tabs to list machines by type (single-session or multi-session OS), or list all sessions.
  • Enter the name in the search box. As you type, filters are provided for a quick search.

  • Refine the search using filters.

    • By default, the following filters are pinned in the view: Name, Session State, and Fault State. Select a filter to build an expression. To customize your filters, click the ellipsis. In the window that appears, you can do the following:

      • Pin or unpin filters. Unpinned filters are for one-time use and are not saved.
      • Click a filter to add it to the view.
      • Clear filters to clear the current filtered search and to remove unpinned filters.
    • Click the operator to toggle between Match all (AND operator) or Match any (OR operator). When set to Match all, the search returns results that match all filter criteria. When set to Match any, the search returns results that match any of the filter criteria.
    • Save your filters in use by clicking the star symbol. The item saved is known as a filter set. Saved items appear in the Saved filter sets list. (To access the list, select the search box.) You can click a saved filter set to apply the filters against your search. To manage saved filter sets, select the search box and then select Manage.

Manage filter sets

Search without filters

As you type in a search box, a menu with prompts appears, providing different search options to help you quickly refine your search. Suppose the content that you typed is VM01. Select one of the following prompts:

  • VM01 Name. Searches by name.
  • VM01 Machine Catalog. Searches by name.
  • VM01 Delivery Group. Searches by delivery group name.

By performing a general search, Citrix Virtual Apps and Desktops searches for matches across the following criteria and provides relevant results:

  • Name. Searches by machine name or DNS name.
  • Machine Catalog. Searches by machine catalog name.
  • Delivery Group. Searches by delivery group name.
  • User. Searches by session user name.
  • Client. Searches by session client name.
  • VM. Searches by hosted machine name. It’s the friendly name of the hosted machine used by its hypervisor.
  • Hosting Server Name. Searches by hosting server name.

When you search for a particular item, such as user, desktop group, catalog, or machine, the general search provides a convenient way to find the information you need.

Search for machine catalogs or delivery groups

You can search and locate resources within the Machine Catalog and Delivery Group nodes. The search functionality in these nodes provides the same interface as the Search node, providing a seamless search experience across Citrix Virtual Apps and Desktops.

You can perform general searches and filter-based searches. In Machine Catalog, the following filters are available:

  • Catalog Name. Searches by the name of the machine catalog.
  • Allocation Type. Filters by static (dedicated) or random (pooled) allocation, or both.
  • Provisioning Type. Filters by manual or MCS provisioning method, or both.
  • Session Support. Filters by single-session or multi-session machine, or both.
  • Allocated Count. Filters by the number of allocated machines.
  • Persistence. Filters by non-persistent (discard) or persistent (on local disk) machine changes, or both.
  • Machine Type. Filters by physical or virtual machine type, or both.

In Delivery Groups, the following filters are available:

  • Group Name. Searches by the name of the delivery group.
  • Description. Filters by delivery group description specified during delivery group creation.
  • Session Support. Filters by single-session or multi-session machine, or both.
  • Machine Identity. Filters by the identity of the machine.
  • Remote PC Access. Filters by Remote PC Access machine.
  • Maintenance mode. Filters by machines in maintenance mode (on, or off, or both).
  • Group State. Filters by the state of the group. (The Enable delivery group option in Edit Delivery Group > User Settings controls whether to stop the delivery of applications and desktops.)
  • Allocation Type. Filters by static (dedicated) or random (pooled) type, or both.

By performing a general search, Citrix Virtual Apps and Desktops searches for items across the following criteria and provides relevant results:

  • Machine Catalogs:

    • Name: Searches for machine catalogs by name, including folder path.
    • Machine catalog: Searches for machine catalogs by name.
    • Description. Searches by machine catalog description specified during catalog creation.

  • Delivery Groups:

    • Delivery group name: Searches for delivery groups by name.
    • Description: Searches by delivery group description specified during delivery group creation.

Search for Application Group

You can perform general searches and filter-based searches for application groups. In the application group, the following filters are available:

  • Name. Filters by the name of the application group.
  • Tag. Filters by the tag of the application group.
  • Description. Filters by the application group description specified during the application group creation.
  • Delivery group. Filters by the delivery group of the application group.
  • State. Filters by the state of the application group.

Customize columns to display

When customizing columns, you can see columns marked with the Degrades performance label. Selecting those columns might degrade the performance of the console. After you complete your customization, the table refreshes to display the columns you select. Their presence might result in delays when you refresh the table.

If your customization contains columns that degrade performance, you are prompted to determine whether to preserve them. The prompt appears after you refresh the browser window or sign out of the console and then sign in. Be aware of the following considerations if you decide to preserve the columns:

  • To ensure console performance, you cannot refresh the table more than once a minute. This restriction applies to all tabs: Single-session OS Machines, Multi-session OS Machines, and Sessions. If you require more frequent refreshes, remove all columns that degrade performance.

Export search results to a CSV file

You can export your search results (up to 10,000 items) to a CSV file. The file is saved to the default download location of your browser.

This feature is available for both machines and sessions. To export your search results, click the export icon in the upper right corner. The export might take up to 1 minute to complete.

On each tab of the Search node, you cannot perform another export while an export is in progress.

Consider the following tips when using the Search feature:

  • On the Search node, select any column to sort items.

  • To show more characteristics to include in the display where you can search and sort, select Columns to Display or click any column and select Columns to Display. In the Columns to Display window, select the check box next to the items you want to display and select Save to exit.

    Note:

    Items that degrade performance are marked with the Degrades performance label.

  • To locate a user device connected to a machine, use Client (IP) and Is, and enter the device IP address.

  • To locate active sessions, use Session State, Is, and Connected.

  • To list all machines in a delivery group, select Delivery Groups in the left pane. Select the group, and then select View Machines from the action bar or from the context menu.

Keep the following considerations in mind when performing sort operations:

  • As long as the number of items does not exceed 5,000, you can click any column to sort the items in it. When the number exceeds 5,000, you can sort only by name or by current user (depending on which tab you are on). To enable sorting, use filters to reduce the number of items to 5,000 or fewer.

  • When the number of items is greater than 500 but no more than 5,000:

    • We cache all data locally to improve sort performance. On the Single-session OS Machines and Multi-session OS Machines tabs, we cache the data the first time you click a column (any column except the Name column) to sort. On the Sessions tab, we cache the data the first time you click a column (any column except the Current User column) to sort. As a result, the sort takes longer to complete. For faster performance, sort by name or current user, or use filters to reduce the number of items.
    • The following message under the table indicates that the data is cached: Last refreshed: <the time when you refreshed the table>. In that case, sort operations are based on items that were loaded previously. Those items might not be up to date. To bring them up to date, click the refresh icon.
Use Search in Studio
October 30, 2023
Contributed by: 
C C
October 30, 2023
Contributed by: 
C C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.