Product Documentation

Configure the Hosted Apps and Desktops service

Jun 05, 2015
Updated: 2014-08-10

Configure the Hosted Apps and Desktops service after you install it.

To import the service package, you must have the Service Schema Administrator security role. To configure the service, you must have the Service Provider Administrator security role.

If you intend to use the CloudPortal Services Manager API to access the service that is deployed with App Orchestration, ensure you have created the datacenter you want to use through the App Orchestration web management console before you configure the service. You can then specify the datacenter when you configure the service at the location level. This is required because the API cannot use the default datacenter registered in App Orchestration. For more information about this requirement, see Plan to deploy the Hosted Apps and Desktops service.

To configure the Hosted Apps and Desktops service

  1. Import the service package into the control panel:
    1. From the Services Manager menu bar, click Configuration > System Manager > Service Schema.
    2. Under Services Management, click Import a service.
    3. On the Service Import page, click Browse and locate the Hosted Apps and Desktops.package file. Click Open.
    4. Click Preview. Services Manager displays the contents of the file for your review.
    5. Click Import at the bottom of the page. Services Manager imports the file and reports Import Complete.
  2. On the Services Manager provisioning server, either restart the CortexQueueMonitor service or restart the machine.
  3. In the control panel, enable the service at the top level:
    1. From the Services Manager menu bar in the control panel, choose Configuration > System Manager > Service Deployment and then expand Hosted Apps and Desktops. Click Save
  4. Enable the service at the location level:
    1. Under Service Filter, select Active Directory Location Services and choose a Location Filter, if applicable.
    2. Click Apply Changes and then click Save.
  5. Verify credentials:
    1. From the Services Manager menu bar, choose Configuration > System Manager > Credentials.
    2. Create the administrative impersonation account for the Hosted Apps and Desktops service by clicking Add, and then entering a username, password, and domain (preferably in Fully Qualified Domain Name form).
      Note: When adding credentials, encryption is enabled by default. Citrix recommends encrypting credentials when Services Manager is deployed in a production environment. Use plain-text credentials only for debugging.
  6. Enable the server:
    1. From the Services Manager menu bar, choose Configuration > System Manager > Servers.
    2. If the server on which you installed the service is not listed, click Refresh Server List.
    3. Expand the entry for the server and verify that Server Enabled is selected.
  7. Assign server roles:
    1. From the Services Manager menu bar, choose Configuration > System Manager > Server Roles, and then expand the entry for the server.
    2. Under Server Connection Components, select Hosted Apps and Desktops, and then click Save.
  8. Add a server connection:
    1. From the Services Manager menu bar, choose Configuration > System Manager > Server Connections, select a Location Filter if applicable, click New Connection, and then select or type the following information for the web service.
      Server Role
      Select or type Hosted Apps and Desktops.
      Server
      Select the server where the web service is installed.
      Credentials
      Select or type the credentials for the server.
      URL Base
      Select or type /CSMXenAppWS/v1 for XenApp, /CSMXenDesktopWS/v1 for XenDesktop, and /cam/api for the App Orchestration Configuration Tool.
      Protocol
      Select http for XenApp and XenDesktop, https for App Orchestration.
      Port
      Type 8095 for XenApp or XenDesktop, 443 (default) for App Orchestration.
      Timeout
      Defaults to 200000 milliseconds.
      Version
      Select the installed service component: App Orchestration for the App Orchestration Configuration Tool, XenDesktop Direct for the XenDesktop web service, or XenApp Direct for the XenApp web service.
    2. Click Save.
    3. On the Server Connections page, click the icon in the Test column for the server. The icon turns green for a successful connection. A red icon indicates an unsuccessful connection. Mouse over it for information about the failed connection.
  9. If you intend to use the CloudPortal Services Manager API to access the service that is deployed with App Orchestration, then now you can go back and configure the default datacenter.
    1. From the Services Manager menu bar in the control panel, choose Configuration > System Manager > Service Deployment
    2. Under Service Filter, select Active Directory Location Services and choose a Location Filter, if applicable.
    3. Expand Hosted Apps and Desktops, click Service Settings, and then expand App Orchestration.
    4. Select the App Orchestration Datacenter check box and click Reload to populate the setting's list with the datacenters that are registered in App Orchestration. From the list, select the datacenter you want to use with the Hosted Apps and Desktops service. 
    5. Click Apply Changes and then click Save.

      You should now configure the rest of the properties associated with this service. The Service Settings properties all have appropriate 'default' values, but the Customer and User Plans will need attention.
  10. Configure the Customer Plan properties
    1. Expand Hosted Apps and Desktops again, and click Customer Plans, and expand the App Orchestration Customer Plan.
    2. Expand the App Orchestration section
    3. Select the App Orchestration Private Network Name checkbox, and enter a Network pattern if required. Note: this property now accepts {variable} notation seen in other areas of the CloudPortal Services Manager control panel. A sample value might be {CustomerShortName}  - Network.
    4. Select the App Orchestration Store Front Isolation check box and select a default isolation mode. NOTE:  this value, as well as the Private Network Name can be altered on a per tenant basis when provisioning the Service to the tenant.
    5. Click Apply Changes, and then click Save.
  11. Configure the User Plan properties:
    1. Expand Hosted Apps and Desktops again, and click User Plans, and expand the Default User Plan.
    2. User the following table as a guide to setting these values.

 

Property Example Value

Name of home drive share

{customershortname}_{username}_home

Name of the profile share

{customershortname}_{username}_profile

Path to share for the user profile

C:\Shares\home\{CustomerShortName}\{username}

Path to share for the user profile

C:\Shares\profile\{CustomerShortName}\{username}

Profile home folder drive letter

P:

Profile home folder drive path

\\fs\{customershortname}_{username}_home

Profile tab profile path

\\fs\{customershortname}_{username}_profile

Terminal services file server

Fs

 

Terminal services home drive letter

 

H:

 

Terminal services home drive path

\\fs\{customershortname}_{username}_home

Terminal services profile path

 

\\fs\{customershortname}_{username}_profile