Product Documentation

Hosted Apps and Desktops

Jun 05, 2015
Updated: 2014-03-18
The Hosted Apps and Desktops web service for Services Manager allows service providers to manage and delegate end-user administration of applications, desktops, and resources. This service comprises three components:
  • XenApp Web Service, which you install on a controller in your XenApp farm.
  • XenDesktop Web Service, which you install on a controller in your XenDesktop Site.
  • App Orchestration Configuration Tool, which you can install on your App Orchestration configuration server, when your XenApp and XenDesktop deployments are managed by App Orchestration.
Using this service, you can:
  • Support public and private offerings of applications, desktops, and other resources such as printers and file shares to customers and users.
  • Create offerings that are private for one customer.
  • Set default applications, desktops, and resources for customers and users.
  • Set price and cost controls per application, desktop, and resource.
  • Configure settings at several levels, thus allowing you to override one or more settings for a particular customer.
  • Use App Orchestration to manage offerings from multiple Citrix XenApp farms and XenDesktop sites in a single Active Directory console.
Note: This enhanced version of the Hosted Apps and Desktops web service offers expanded support and replaces the previous version of the service.

Service deployment overview

Deploying the Hosted Apps and Desktops web service includes the following tasks:
  1. Review and complete the requirements described in this topic.
  2. Install the service.
  3. Configure the service.
  4. Configure service offerings.
  5. Provision the service.

Supported versions

The Hosted Apps and Desktops web service is supported on servers running one of the following minimum versions:
  • Citrix XenApp 6.5 FP2
  • Citrix XenDesktop 7.1
  • Citrix App Orchestration 2.0
Note: If your environment includes earlier XenApp versions that you do not want to update to a supported version, install and use the Citrix web service for Services Manager. Also, use the Citrix web service if your environment requires application groups or server collections.

If you have an earlier version of the service installed

If you are currently using an earlier version of the Hosted Apps and Desktops service, you must remove it before importing the later service version. You must have the Service Schema Administrator role to remove the service.
  1. Ensure that the service is not provisioned to any customers.
  2. Ensure that no customers can resell the service (including the default Service Provider).
  3. From the Services Manager menu bar, click Configuration > System Manager > Service Deployment.
  4. Under Service Filter, select Active Directory Location Services and verify that the service is not enabled for any locations: if a checkmark appears next to the Hosted Apps and Desktops entry on the Services Overview page, select the entry and then click Delete.
  5. Under Service Filter, select Top Environment Services and verify that the service is not enabled at the top level: if a checkmark appears next to the Hosted Apps and Desktops entry on the Services Overview page, select the entry and then click Disable.
  6. From the Services Manager menu bar, click Configuration > System Manager > Service Schema.
  7. Expand the Hosted Apps and Desktops service. At the bottom of the pane that opens, click Delete.

The removal may take a few moments. You might be logged off of the web console; if so, log on again.

Requirements and considerations for all deployments

Before installing the Hosted Apps and Desktop web service, add the servers where you will install the service (XenApp controller, XenDesktop Controller, or App Orchestration configuration server) to the built-in CortexReadOnly group. Then, restart each server you added to the group.

When using Internet Explorer 11 to access the Services Manager control panel to configure and provision the service, ensure the following Compatibility View Settings are cleared:
  • Display intranet sites in Compatibility View
  • Use Microsoft compatibility lists

Requirements and considerations for deploying the web service on a XenApp or XenDesktop Controller

On the XenApp or XenDesktop controller, complete the following before installing the web service:
  • Ensure the XenApp or XenDesktop server has PowerShell remoting enabled and that the execution policy is set to RemoteSigned.
  • Ensure that XenApp or XenDesktop is fully installed and configured, and that the operating system has all recommended updates.
  • Create the applications and desktops that Services Manager will indicate are available for offerings.
    • For XenApp and App Orchestration, created applications are automatically picked up by the Hosted Apps and Desktops service.
    • For XenDesktop, you must add one of the following prefixes to the application and desktop names and the Delivery Groups that reference them, in order for them to be picked up by the Hosted Apps and Desktops service. (Use Citrix Studio to add the prefixes.)
      Prefix Description
      _Offer_ Will be offered in both shared and isolated isolation modes.
      _Offer_Shared_ Will be offered in only isolated mode.
      _Offer_Isolated_ Will be offered in only shared isolation mode.
  • You must be a full XenApp or XenDesktop administrator to configure the web service.
  • Ensure that the firewall on the server allows communications with the web service: the default is 8095. This must be the same port that you specify when configuring the web service.
The web service installer will install or enable the following on the XenApp or XenDesktop controller, if not already present:
  • .NET Framework 4.0
  • Remote Desktop Services
  • Web Server (IIS) 7 Role Services
    • ASP.NET
    • ASP.NET 4.5 (Windows Server 2012)
    • Windows Authentication
    • Management Scripts and Tools
    • Management Console
    • Hostable Web Core (Windows Server 2012)
    • IIS 6 Management Capability > IIS 6 Metabase Compatibility
  • SQL Server System CLR Types
  • SQL Server Shared Management Objects
  • WCF HTTP Activation 4.5 (Windows Server 2012)

You need a file server for activities such as creating file shares with permissions and storing profiles. You can use the same file server for deploying this service and File Sharing services.

Requirements and considerations for deploying the web service on an App Orchestration configuration server

Set up your App Orchestration deployment. For more information, refer to the Getting Started with Citrix App Orchestration 2.0 guide and App Orchestration Setup Checklist available on the App Orchestration web site.

During service provisioning, you choose an isolation level for each tenant's StoreFront that defines whether the StoreFront site is shared, private, or a private server group. You can also specify a private network name: a management network to which a customer's privately-allocated machines are connected. If a network is not specified, the configured shared management network is used.

When you provision a customer with this service, App Orchestration:
  • Creates the customer as a tenant.
  • Creates offering subscriptions for the tenant. When you enable a user plan for the customer, Services Manager creates an Active Directory user group and associates the group with the offering subscription.
  • Creates a StoreFront site for the tenant at the selected isolation level.

When you provision a user, App Orchestration adds the user to a group that corresponds to the selected user plans. (The group is a subscription member in App Orchestration, created during customer provisioning.)

When you delete a user plan, the following events occur in App Orchestration:
  • If the offerings in the user plan are unique to the plan, the Hosted Apps and Desktops service removes the subscriptions from App Orchestration that map to the user plan.
  • If an offering in the user plan is provisioned to the customer as part of another user plan, the Hosted Apps and Desktops service retains the subscription and removes from it the user group that corresponds to the deleted user plan.

After you provision the service in Services Manager, provisioning is complete after App Orchestration completes the workflows that create or update tenant information and subscriptions. Check the status of the workflows in the App Orchestration console.

Requirements for using the service with App Orchestration and the CloudPortal Services Manager API

To use the CloudPortal Services Manager API to access the Hosted Apps and Desktops service deployed on an App Orchestration configuration server, you need to configure a datacenter through the App Orchestration web console prior to configuring the service through Services Manager. This datacenter should correspond to the location where you are deploying the Hosted Apps and Desktops service. Specifying the datacenter is required because the API is not able to use the default datacenter that is registered in App Orchestration. You can specify the datacenter you want to use at the location level, in the Hosted Apps and Desktops service settings. For more information, see Configure the Hosted Apps and Desktops service.

If you do not specify a datacenter and then use the API to access the Hosted Apps and Desktops service, the following message is returned:

"There is no Datacenter in App Orchestration that matches the Datacenter ID stored in the database."