This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
selected by default and you select Plan B, the resource limits for Plan B do not display in the control panel. Instead, the
resource limits for Plan A remain displayed. To work around this issue, select another plan and verify the correct resource
limits are displayed. Then, select the plan you intend to provision to the customer. [#376251]
Creating a customer through the control panel might fail if the complete customer name exceeds the Active Directory
limit of 64 characters. In Services Manager, by default, the customer's complete name follows the pattern
{CustomerFullName}({CustomerShortName}). If the combined number of characters in this pattern exceeds 64
characters, the customer OU cannot be created in Active Directory and the provisioning request in Services Manager fails
with the error "A constraint violation occurred." To avoid this issue when creating a new customer through the control
panel, ensure the entries in the Full Name and Code f ields (under Customer Details) do not exceed 64 characters.
[#378307]
If the application pool for a web service has been renamed, upgrading the web service fails. This issue occurs because the
renamed application pool is not recognized by the Configuration Tool when upgrading the service. To work around this
issue, prior to upgrading, rename the application pool with the default name and then upgrade the service. After upgrading
is complete, you can rename the application pool using the non-default name.
The following table lists the web services and the default names of their corresponding application pools in CloudPortalServices Manager 11:
CloudPort al Services CloudPort al Services Manager 11Manager 11
Web service nameWeb service name Def ault name of applicat ion poolDef ault name of applicat ion pool
Citrix Citrix Csm Citrix WS
Hosted Exchange Citrix Csm Exchange WS
Lync Enterprise Citrix Csm Lync WS
Lync 2010 for Hosting Citrix Csm LyncHosted WS
MySQL Citrix Csm MySQL WS
SharePoint 2010 Citrix Csm SharePoint 2010 WS
Virtual Machines Citrix Csm Hyper-V WS
Windows Web Hosting Citrix Csm Web Hosting WS
For reference, the following table lists the web services and default names of their corresponding application pools inCloudPortal Services Manager 10 that can be upgraded to Version 11:
Deploying Services Manager includes installing the platform components (server roles), configuring firewall ports for each
component, and installing the web services.
For system and f irewall requirements for platform components, refer to the following topics:System Requirements for Server Roles
Firewall requirements for Services Manager
For each requirement, the minimum version required is stated, as well as any later versions that are supported.
For requirements for specif ic services, refer to the topics in the Plan for deploying services section. This section containstopics for each service that Services Manager supports and includes additional planning information such as:
Service deployment overviews
Changes that occur in Active Directory when the service is deployed
Additional configuration details for specif ic deployment scenarios
For system requirements information for resource components such as Exchange servers, SharePoint farms, and so on,
refer to the component's product documentation.
Important: Before using Services Manager, check for and install any available security updates for the components youwant to deploy.
Updated: 2013-05-21The sections in this topic describe supported platforms, required software, and other information that will be used when
you install and configure the core components (server roles) that comprise the Services Manager platform. The Services
Manager server role installer (Setup Tool) handles many of the prerequisites, such as installing .NET Framework 4.0, enabling
Web Server roles, and enabling MSMQ features. (The .NET software is also available in the Support folder of the Services
Manager installation media.) See Plan for deploying the Services Manager platform for additional preparation information.
Services Manager supports Active Directory Domain Services on the following platforms:Windows Server 2012
Windows Server 2008 R2
Windows Server 2008
At a minimum, the domain functional level must be Windows Server 2008.
Before the Services Manager platform can be deployed, the Active Directory schema must be extended to include thestandard Exchange attributes and prepare the environment for multi-tenancy. You can extend the schema through one ofthe following methods:
Use the Schema Prep tool from the Microsoft Exchange installation media. This method applies if you do not plan to
deploy Exchange 2007 or 2010 and you do not intend to deploy the Exchange web service. In general, to deploy the
Schema Prep tool, you enter the following command in a Command Prompt window:
setup /p /on:OrganizationName
Deploy Exchange. This method applies if you plan on installing the Exchange web service in your Services Manager
deployment. Extending the Active Directory schema is part of the Exchange deployment process.
The domain user account used to extend the Active Directory schema or install the Services Manager platformcomponents must belong to the following groups:
Group NameGroup Name Required f or Services Manager plat f ormRequired f or Services Manager plat f orminst allat ioninst allat ion
Required f or ext ending Act ive Direct oryRequired f or ext ending Act ive Direct oryschemaschema
DomainAdmins
Yes Yes
EnterpriseAdmins
No Yes
SchemaAdmins
No Yes
If any server (including DNS) is not in the domain, the same user account should be set up as a local user on that server with
the same password, as a member of the local Administrators group.
To ensure your deployment is protected from external threats, consider creating an account lockout policy that disables a
user's account for a specified period when an incorrect password is entered a specified number of times. When this policy is
set each failed logon attempt is recorded on the primary domain controller.
Before implementing an account lockout policy, consider carefully the risks and benefits of implementation to your Services
Manager deployment. For more information about configuring this policy, see the Microsoft TechNet article, "Account
Lockout Policy Technical Overview."
Services Manager uses DNS aliases internally for the core components. Create CNAME records for the following roles andcomponents:
Plat f orm componentPlat f orm component AliasAlias
Database server CORTEXSQL
Provisioning server CORTEXPROVISIONING
Web server CORTEXWEB
Reporting Services CORTEXREPORTS
The database server hosts the system databases that are required for Services Manager to operate. When preparing thedatabase server, ensure the following requirements are met:
Hardwareconfiguration
Two or more server-class processors, 2.0 GHz or higher.
Minimum 4 GB RAM recommended
Minimum 10 GB free disk space available for f ile growth
Operatingsystem
Windows Server 2008 R2 (minimum) Standard, Enterprise, and Datacenter editions, with allrecommended updates installed.
User AccountControl (UAC)
Disabled.
Databaseserver
Microsoft SQL Server 2008 R2 or 2012, with all recommended updates installed.
Authentication Mixed mode enabled (SQL and Windows Authentication).
SQLconnectiontypes
Local and remote SQL connections enabled.
Installationaccount
Configure the account to be used during installation with the SysAdmin role. If you cannot do this inSQL, you can use an account with SysAdmin rights. You can remove this account after installation
Install the 64-bit variant of the Microsoft SQL Server 2008 Shared Management Objects (SMO).This software is included in the Support folder of the Services Manager installation media. TheServices Manager Setup Tool can also install this requirement when you install the Provisioningserver role.
Domainmembership andprivileges
Server must be a member of the domain.
Service must have full domain administrator privileges.
SMTP server Required. Depending on the notif ication, the Provisioning server also needs a temporary directoryfor assembling the email. The SMTP server can also be used by the Report Mailer server role. Whenconfiguring the Provisioning server role, you will need to provide the SMTP server address and portnumber.
In general, the Directory Web Service is installed on the same server that hosts the Provisioning server role. If you are
installing the Directory Web Service on a domain controller, give the CortexWSUsers and the Proxy Users groups the Allow
logon locally permission. However, for security reasons, Citrix recommends installing this role on a server that does not act
as a domain controller in your network environment.
When preparing a server to host the Directory Web Service, ensure the following server requirements are met:
Hardwareconfiguration
Two or more server-class processors, 2.0 GHz or higher.
Minimum 2 GB RAM recommended
Minimum 2 GB free disk space available
Operating system Windows Server 2008 R2 (minimum) Standard, Enterprise, and Datacenter editions, with allrecommended updates installed.
User AccountControl (UAC)
Disabled.
.NET Version .NET Framework 4.0 installed. This software is included in the Support folder of the ServicesManager installation media.
Firewall Windows Firewall must allow inbound TCP requests on port 8095.
Windows serverfeatures
Enable the following features:Web Server > Application Development > ASP.NET
Web Server > Security > Basic Authentication
Web Server > Security > Windows Authentication
Management Tools > IIS Management Console
Management Tools > IIS Management Scripts and Tools
When preparing a server to host the web server, ensure the following requirements are met:
Hardwareconfiguration
Two or more server-class processors, 2.0 GHz or higher.
Minimum 2 GB RAM recommended
Minimum 2 GB free disk space available
Operatingsystem
Windows Server 2008 R2 (minimum) Standard, Enterprise, and Datacenter editions, with allrecommended updates installed.
User AccountControl (UAC)
Disabled.
.NET Version .NET Framework 4.0 installed
Firewall Open port 80 from the web server to the SQL Reporting Services server.
Report Viewerversion
Microsoft Report Viewer 2008 SP1.
Windows serverroles
Enable the following roles:Web Server > Application Development > ASP.NET
Web Server > Security > Basic Authentication
Web Server > Security > Windows Authentication
Management Tools > IIS Management Console
Management Tools > IIS Management Scripts and Tools
SQL ServerManagementObjects
Install the 32-bit variant of the Microsoft SQL Server 2008 Shared Management Objects (SMO).This is available in the Support folder of the Services Manager installation media.
During platform configuration, you will need to know the host header required for the web site. This is the URL used to
access the Services Manager control panel. The Configuration Tool refers to this as the external address.
When you install the web server role, the following items are installed:CortexMgmt Application Pool: Runs the Management Site.
Cortex Management Site: Contains the CortexDotNet and CortexAPI web applications.
CortexDotNet is the service that runs the control panel. CortexAPI is the XML-based web service that automates
management tasks.
Accessing the web server is supported on the following web browsers:Internet Explorer 8, 9, and 10
Note: If you intend to access the web server with Internet Explorer 10, install the hotfix for .NET Framework 4.0 availablefrom Microsoft Knowledge Base article 2600088 (http://support.microsoft.com/kb/2600088) on the web server. This hotfixupdates the ASP.NET browser definitions which enables the control panel to function as expected with Internet Explorer10. If you do not want to install this hotfix, use Internet Explorer 8 or 9 or supported Firefox, Chrome, and Safari browsersto access the web server.The Autologin tool supports Windows XP SP3, Windows 7 SP1, and Windows Server 2008.
SQL Reporting Services is the engine for providing reporting capabilities in Services Manager. The Reporting service and datawarehouse are installed on the server hosting SQL Reporting Services. When preparing a server to for installing andconfiguring the Reporting service and data warehouse, ensure the following requirements are met:
Hardwareconfiguration
Two or more server-class processors, 2.0 GHz or higher.
Minimum 4 GB RAM recommended
Minimum 10 GB free disk space available for f ile growth
Operatingsystem
Windows Server 2008 R2 (minimum) Standard, Enterprise, and Datacenter editions, with allrecommended updates installed.
Firewall Open port 1433 between the Reporting server and the database server. Allow connections throughthe reporting port (default=80).
.NET version .NET Framework 4.0 installed. This software is included in the Support folder on the Services Managerinstallation media.
Databaseserver
Microsoft SQL Server 2008 R2 or 2012, with all recommended updates installed.
DatabaseAuthentication
Windows Authentication enabled.
SSRS Serviceaccount
Set the SQL Server Reporting Services service account to Network Service.
SQLconnectiontypes
Local and remote SQL connections enabled.
SSRSAdministratoraccount
In SQL Server Reporting Services, create a dedicated user with the System Administrator role; domainadministrator rights are not required. Use this account when deploying the Reporting server role.
SQL ServerManagementObjects (SMO)
Services Manager setup installs Microsoft SQL Server Shared Management Objects automaticallywhen the Reporting server role is deployed. SMO is also available in the Support folder of the ServicesManager installation media.
Report Serverconfigurationfile
Verify that the Report Server configuration f ile (C:Program FilesMicrosoft SQLServerMSRS10.MSSQLSERVERReporting ServicesReportServerrsreportserver.config) contains theentry "<AuthenticationTypes><RSWindowsNTLM/> <RSWindowsNegotiate/>
SMTP server Required for the data warehouse. You can specify the SMTP server used with the Provisioning server;however, it must allow relays from the data warehouse server.
OCSMonitoring
If you intend to use the OCS Monitoring service in your Services Manager environment, install andenable this service on the OCS 2007 server.
Services Manager requires specif ic f irewall ports be open to support communication between platform components. Thefollowing diagram illustrates the required ports and the platform components that use each port in an environment thatincludes a primary location and a remote location.
The following table lists the default connectivity configuration between the Services Manager roles. Configure thesebefore installing the roles.
T raf f ic/PortT raf f ic/Port FromFrom T oT o PurposePurpose
TCP 8095 Web Server Provisioning Engine Authenticate users and read-time ActiveDirectory lookups
MSMQ*, HTTP, orHTTPS
Web Server Provisioning Engine Provisioning request
TCP 1433** ProvisioningEngine
SQL Server Access to provisioning rules, write statistics
TCP 1433** Web Server SQL Server Access to customer and user information
TCP 80 Web Server SQL Reporting Servicesserver
Access to SQL Reporting Services
* MSMQ comprises several ports, as specified by Microsoft.
** The supported SQL versions use TCP 1433 only for the default instance; other named instances use a dynamically
assigned port. If your installation is not the default instance and a firewall separates the SQL server from the other
Services Manager roles, you must override the dynamic behavior by allocating a specific port.
RoleRole PagePage Descript ionDescript ion5. On the Summary page, review the configuration information for the server role. If you want to change anything, return
to the appropriate configuration page. When the summary contains the settings you want, click Commit. The Applying
Configuration page displays the configuration progress.
6. After the configuration is completed, click Finish to return to the Deploy Server Roles & Primary Location page.
After you configure the server roles on each server in the deployment, you can configure the primary location.
Updated: 2013-04-18Before installing Services Manager platform server roles, you perform the following tasks:1. Check environment prerequisites
2. Create system databases
Before installing any server roles, verify the following items:Your Active Directory schema has been extended to accommodate Services Manager. This is performed using the
Microsoft Exchange installation tools.
The required DNS aliases have been configured. Services Manager uses DNS aliases to locate the servers where the
platform components will be deployed.
Use the Services Manager Setup Tool to verify these items. The tool queries your environment and, if successful, displays a
green check mark next to each verified item. If the queries cannot be completed, the Setup Tool displays a Verify button so
you can perform the checks again.
For more information about Active Directory and DNS requirements for Services Manager, review the topic System
Requirements for Server Roles.
1. From the installation media, double-click Setup.exe.
2. From the CloudPortal Services Manager splash page, click Get Started.
3. On the Select Deployment Task page, select Install CloudPortal Services Manager.
4. On the Install CloudPortal Services Manager page, select Check Environment Prerequisites. The Prepare Environment
page displays the status of the verif ied items. Successfully verif ied items are displayed with green check marks.
5. Click Back to return to the Install CloudPortal Services Manager page.
Perform this task after you have deployed SQL Server and SQL Server Reporting Services.
The system databases are created using the Services Manager Configuration Tool, which is installed as a part of this
process.
1. From the installation media, double-click Setup.exe.
2. From the CloudPortal Services Manager splash page, click Get Started.
3. On the Select Deployment Task page, select Install CloudPortal Services Manager.
4. On the Install CloudPortal Services Manager page, select Deploy Server Roles & Primary Location.
5. On the Deploy Server Roles & Primary Location page, select Create System Databases.
6. Install the Services Manager Configuration Tool:
1. When prompted, click Install to install the Configuration Tool.
2. On the License Agreement page, accept the license agreement and then click Next.
3. On the Ready to Install page, click Install. The Setup Tool installs the Configuration Tool and any prerequisites that
Updated: 2013-03-04Perform this task on the server that will be hosting the server role you want to install. For example, install the Provisioningserver role on the server that you have designated as the Provisioning server. Likewise, install the Web server role on theweb server.Note: Install and configure the Reporting server role after the primary location has been configured. If you install theReporting service before the primary location has been configured, configuration of the Reporting service fails.1. From the installation media, double-click Setup.exe.
2. On the Setup Tool splash page, click Get Started.
3. On the Select Deployment Task page, select Install CloudPortal Services Manager.
4. On the Install CloudPortal Services Manager page, select Deploy Server Roles & Primary Location.
5. On the Deploy Server Roles & Primary Location page, select Install Server Roles.
6. On the License Agreement page, accept the license agreement and then click Next.
7. On the Select Server Roles page, select one or more roles to install and then click Next. The Configuration Tool check
box always remains selected.
8. On the Review Prerequisites page, review the prerequisite items that will be installed and then click Next.
9. On the Ready to Install page, review the selected roles and prerequisites that will be installed. Click Install. The Deploying
Server Roles page indicates the progress of installing prerequisites and the selected roles, and the result.
10. On the Deployment Complete page, click Finish. The installer returns to the Deploy Server Roles & Primary Location page.
After you have installed the selected server role(s), run the Configuration Tool to configure the server role. For more
information, see To configure server roles using the graphical interface.
Updated: 2014-10-09This topic assumes that you have installed the Services Manager Configuration Tool on the platform servers you want to configure and on the server where you want to configure the primary
location or a remote location. When you install a platform server role, the Configuration Tool is installed automatically. To install the Configuration Tool only, see To install server roles from the
command line.
This topic includes the following sections:Command Conventions
Return Codes
Syntax
Databases options
Provisioning options
Directory Web Service options
Web options
Location options
Reporting options for deploying the Reporting service
Reporting options for deploying reports
Reporting (Data Warehouse) options
Report mailer options
Example: Configure the Provisioning and Directory Web Service server roles
Example: Configure the primary location
Example: Configure a remote location
Several options use Boolean values (true or false).If you omit an option that requires a Boolean value, the default value is used. For example, if you do not include the /UseCortexSql:True | False option in the command, the default value (false) is
used; that is, the reporting database will not use the settings configured for the main system database.
If you specify an option that requires a Boolean value but you omit the value, the option value is true. For example, if you specify only /UseCortexSql (with no True or False value), the option is true;
that is, the reporting database will use the settings configured for the main system database.
You can use environment variables to represent one or more command-line options or option values (for example, /ReportingDBServer:%currentServer%, where currentServer is defined as an
environment variable).
Enclose option values that contain spaces in quotation marks (for example, /LocationName:"Southeast Hub").
The configuration command supports the following return codes:
ValueValue MeaningMeaning
1 Another instance is already running.
0 Success.
-1, -2, -3 Command-line error.
-4 General failure during configuration. To debug further, review the log in %WINDIR%Temp.
To configure the server roles and create the primary location from the command line, you execute the Services Manager Configuration Tool by typing the following at a command prompt:
/Conf igFile:conf ig-f ile/Conf igFile:conf ig-f ile
Location of XML configuration f ile with read-write access for the current user. If this f ile already exists, its content will be overwritten during the configuration.
/Conf igure:t asks/Conf igure:t asks
Configures specif ied installed Services Manager roles and a location. Valid values are:
Databases – Creates the main Services Manager system databases.
Provisioning – Configures the Provisioning Engine.
DirectoryService - Configures the Directory Web Service.
Web – Configures the Web Server.
Location – Initializes the Services Manager instance. A location is the main unit of isolation between tenants, and usually corresponds to an Active Directory domain or forest.
Reporting – Creates the reporting database and configures the Data Warehouse feature.
ReportMailer – Configures the email environment for sending usage reports to the Citrix license monitor. Configuring the Report Mailer is required.
Password for the user name specif ied with the /CortexSqlUsername option. This is optional if you specify /CortexSqlAuthMode:Windows and you are using integrated security.
/Cort exSqlPort :/Cort exSqlPort :portport
SQL Server port. Default = 1433 if this is the default SQL Server instance.
/Generat eCort exSqlCredent ials:T rue | False/Generat eCort exSqlCredent ials:T rue | False
If true, passwords for the CortexProp, ExchangeLogs, OLMReports, and OLMUser system database users are automatically generated.
Required. Address of SMTP server from which email messages are sent, including system updates for administrators and account notif ications for end users.
/Smt pServerPort :/Smt pServerPort :portport
Port on SMTP server to be used for sending email messages about system updates for administrators and account notif ications for end users. Default = 25
/Smt pOut Folder:/Smt pOut Folder:f olderf older
Folder that serves as an outbox for the control panel when sending emails. Default = %WINDIR%TempCortexEmail
/Generat eQueueMonit orCredent ials (or GenQMonCreds):T rue | False/Generat eQueueMonit orCredent ials (or GenQMonCreds):T rue | False
If true, user credentials are automatically generated for the Queue Monitor service, which processes administrative requests from the Web Server and automates other services. Default = False
User name for a domain account to be used by the Queue Monitor service (default = cortex_qmon_svc). The user must have full domain administrator permissions. This is optional if you specify
Password for the user name specif ied with the /QueueMonitorUserName option. This is optional if you specify /GenerateQueueMonitorCredentials:True.
/Aut oCreat eQueueMonit orCredent ials:T rue | False (or /Aut oCreat eQueueMonit orCredent ials:T rue | False (or /Aut oCreat eQMon:T rue | False)/Aut oCreat eQMon:T rue | False)
If true, the domain user account to be used by the Queue Monitor service is created if it does not already exist. Default = True
/Generat eDirect oryMonit oringCredent ials:T rue | False (or /Generat eDirect oryMonit oringCredent ials:T rue | False (or GenDirMonCreds:T rue | False)GenDirMonCreds:T rue | False)
If true, user credentials for the Directory Monitoring service are generated automatically. This service monitors Active Directory, keeping account information current and sending email
notif ications for key events such as password expiry. Default = False
User name for the account to be used by the Directory Monitoring service (default = cortex_dirmon_svc). This is optional if you specify /GenerateDirectoryMonitorCredentials:True.
Password for the user name specif ied with the /DirectoryMonitoringUserName option. This is optional if you specify /GenerateDirectoryMonitorCredentials:True.
/Aut oCreat eDirect oryMonit oringCredent ials:T rue | False (or /Aut oCreat eDirect oryMonit oringCredent ials:T rue | False (or /Aut oCreat eDirMon:T rue | False)/Aut oCreat eDirMon:T rue | False)
If True, the user account to be used by the Directory Monitor service is created if it does not already exist. Default = True
Externally-resolvable address by which the Web Server can be reached. Default = cortexweb
/UseSsl:T rue | False/UseSsl:T rue | False
If true, an SSL binding is created for the management portal. Default = True (recommended)
/SslCert if icat e:/SslCert if icat e:namename
Friendly name of the SSL certif icate to use. This is required if you specify /UseSSsl:True.
/BindingIp/BindingIpip-addressip-address
IP address to use for the new site binding. Default = "*" (all unassigned)
When configuring locations, consider the following items:Run all configuration steps as a domain administrator.
Ensure user account settings conform to any domain policies, such as minimum password complexity, and are valid.
Ensure the required f irewall ports are configured for each server in the deployment.
/PrimaryLocat ion:T rue | /PrimaryLocat ion:T rue | FalseFalse
Required. If True, the /Locationx configuration option values are for the f irst Services Manager administrator. This is the top-level administrative account in the control panel; it can add customers,
assign services, and manage delegated administration.
/Locat ionName:/Locat ionName:namename
Required. Name of the location. Default = Top Location
/Locat ionDescript ion:/Locat ionDescript ion:descript iondescript ion
Description of the location. Default = Top-level Service Provider Location
Password for the user name specif ied with the /CspAdminUserName option. This is optional if you are configuring a secondary location (/PrimaryLocation:False).
/CspCont act :/CspCont act :namename
Contact name of the service provider. This is optional if you are configuring a secondary location (/PrimaryLocation:False).
User name for an administrator account to be used to create the reporting database, plus create and configure the service account specif ied with the /OlmReporting* options. This is optional if
you specify /UseCortexSql:True and /ReportingDBServerAuthMode:Windows.
Password for the user name specif ied with the /ReportingDBServerUserName option. This is optional if you specify /UseCortexSql:True and /ReportingDBServerAuthMode:Windows.
Comma-separated list of reports to deploy. Valid values are: AD Sync, Billing, Citrix, Communicator, DNS, Exchange, File Sharing, FTP, Mail Archiving, Microsoft CRM, MySQL, SharePoint, SQL Server,
Windows Web Hosting.
To publish all reports, use the /PublishAllReports option.
/PublishAllReport s:T rue | /PublishAllReport s:T rue | FalseFalse
If true, all available reports are published (Default = False). To publish a subset of the available reports, set this option to False, and use the /PublishReports option to specify the reports.
Password for the user name specif ied with the /ReportMailerEmailUserName option.
The following command configures the Provisioning and Directory Web Service server roles and uses default values for most options:CortexConfigConsole.exe /ConfigFile:\server-nameconfig-file.xml /Configure:Provisioning,DirectoryWebService /SmtpServer:mail.takahepubs.com /DirectoryServiceUsername:cortex_dirws_svc /DirectoryServicePassword:password
The following command configures the primary location and uses default values for most options:CortexConfigConsole.exe /ConfigFile:\server-nameconfig-file.xml /Configure:Location /PrimaryLocation:True /LocationName:My First Location /LocationOU:Organization-Name /LocationOULabel:My Organization /CspAdminPassword:password /CspContact:CSP-Name /CspContactEmail:[email protected] /CspUPN:my-org.com
The following command configures a remote location and uses default values for most options:CortexConfigConsole.exe /ConfigFile:\server-nameconfig-file.xml /Configure:Location /PrimaryLocation:False /LocationName:My Second Location /LocationOU:Organization-Name /LocationOULabel:My Organization
Updated: 2013-04-18When deploying Services Manager, you have many choices of deployment designs and features which you can tailor to theneeds of the services you want to offer and the customers you serve. A typical process of planning a Services Managerdeployment includes:
Becoming familiar with Services Manager setup by creating a one-server or two-server test deployment.
Determining the number of servers you need for your deployment, deciding which roles each server will perform, and
evaluating hardware requirements.
Deciding which services you want to offer customers and resellers, and determining the deployment requirements for
each service.
Creating the network infrastructure design.
Defining the installation processes.
Creating and testing a pre-production pilot deployment based on your design.
Releasing the deployment into production.
A typical Services Manager deployment process includes:Phase 1: Services Manager platform
Phase 2: Services deployment
Phase 3: Customer and user provisioning
The Services Manager platform represents a series of servers that perform provisioning tasks, authenticate and manageusers, host the control panel interface and API services, store and process data from the main database, and manage billingand usage. These servers must be fully configured before services are deployed. A Services Manager deployment includesthe following core components (or server roles) that you install and configure:Web serverWeb server
The web server hosts the control panel’s web interface and API services. The control panel is the primary user interface for
service providers, resellers and end-customer users. The customer administrator can manage the organization’s users and
associated services within the same system. Users can perform administrative and self-service tasks that have been
delegated to them. Provisioning requests are sent from the web server to the Provisioning Engine through a Microsoft
Message Queue.
Dat abasesDat abases
The main system databases are the Microsoft SQL Server repositories for user, customer, and configuration information.
Several system databases are automatically created when you install and configure the server roles. The Services Manager
Reporting Service uses Microsoft SQL Server Reporting Services.
Provisioning Provisioning EngineEngine
The Provisioning Engine performs all provisioning tasks. It expedites requests from the web server and automates managed
services and resources.
Direct ory web Direct ory web serviceservice
The Directory web service provides the web server with function calls related to Active Directory, such as user
authentication, user account status inquiries, user enabling and disabling, and security group management.
The data warehouse performs scheduled storage of historical data from the main system database, and manages the
creation and sending of usage and billing reports.
Report MailerReport Mailer
The Report Mailer gathers anonymous usage data and emails usage reports to the Citrix license monitor. Customer and
user information is not transferred, only the number of customers and users-per-service.
To prepare your environment for these components, you perform the following tasks:Review the system requirements for each server role and perform any initial server configuration required.
Determine whether you will install and configure these server roles using the graphical user interface or the command
line.
Determine which server will host each server role. For example, the Directory web service is typically installed on the same
server as the Provisioning Engine. However, for a large deployment, you might consider using separate SQL servers for
hosting the reporting and billing databases.
Deploying the Services Manager platform also includes creating the first administrator user for the deployment. This user
represents the top-level administrator account and has permission to perform all control panel tasks.
Deploying services includes installing and configuring services for resources such as Microsoft Exchange, Citrix Apps and
Desktops, and Microsoft SharePoint. Before deploying any service, you must ensure the resources supporting the service
are fully deployed in your network environment. For example, to deploy the Hosted Exchange service, Services Manager
requires you have a working Exchange deployment in your environment. The Deploy services section of the Services
Manager documentation describes the configurations required to enable these resources to function successfully with the
Services Manager control panel. However, for details about deploying specific resources, you will need to refer to the
product documentation for these resources.
Provisioning customers and users represents a series of tasks for enabling resellers to sell specif ic services, making servicesavailable to end-customers, enabling customers' users to access services, and assigning security roles. To provisioncustomers and users, you perform the following tasks:1. Create the customer profile.
2. Create the customer administrator user. Some customers might require additional administrator users to manage specif ic
services. When you create these additional users, you can assign appropriate security roles.
3. Enable and configure the services that you are providing to the customer.
4. Create users for the customer and assign appropriate security roles.
includes standard reports to support provisioned services and communicates directly with SQL Server Reporting Services.
The Reporting service generates reports by accessing the data stored in the data warehouse.
The data warehouse stores historical provisioning data (OLMReporting) that is used for reporting. This history consists of
snapshots of the provisioning data stored in the OLM database, which are created once per day and subsequently
transferred to the data warehouse. The data warehouse is created when you install and configure the Reporting service. As
well, the server connections required for both the Reporting service and the data warehouse are created.
The Report Mailer is a required role for sending notifications to administrators and end users, and license reporting
information to Citrix. Typically, the Report Mailer role is installed on the same server as the Reporting service. The email
server you specify for the Report Mailer can be specified for the Provisioning server, which also requires email capabilities.
The Report Mailer role is installed and configured once for the entire Services Manager deployment, typically on a server in
the primary location.
Depending on your needs, you can deploy the system databases, reporting, and data warehouse in one of the followingways:
A single SQL Server hosts the system databases, the Reporting service (SQL Reporting Services) and data warehouse.
This is best for proof-of-concept deployments where server load is not a concern.
A SQL Server hosts the system databases while a separate SQL Server hosts the Reporting service and data warehouse.
This avoids taxing the primary database with reporting and data storage loads.
If you are using clustered SQL servers in your Services Manager deployment, separating each server role is not required.
Reports are deployed by importing service packages. These services packages contain report definition f iles that are linkedto the OLM and OLMReporting databases, and configuration f iles for the data transfer process and the data warehouse.You can deploy reports using the following methods:
During Report service configuration, use the Configuration Tool to import the reports from selected service packages.
Using the control panel, import the reports manually using the service import feature.
Service packages for all supported services are located in the Services folder on the Services Manager installation media.
The Provisioning engine runs as a Windows service, monitoring queues for provisioning requests. When a request is received,
it passes through a set of provisioning rules that determine which actions are required to complete the provisioning process.
These rules are designed to be easily customized using the Provisioning Manager graphical interface (Start > All Programs >
All provisioning processes in Services Manager are built using provisioning actions. This gives the service provider somevisibility into the processes that are executed within the deployment. Examples of provisioning actions include:
Directory User Create: Creates an Active Directory user
Directory Group Create: Creates a security group in Active Directory
FileSystem Create Folder: Creates a folder in a f ile system
Exchange Address List Create: Creates an address list in Microsoft Exchange
Run Command: Runs an executable within a command shell
Run Script: Runs a Visual Basic script
Services Manager includes over 100 provisioning actions.
The Provisioning engine is installed on a separate server in your Services Manager deployment. Additionally, configuration of
the Provisioning server includes specifying an email server for sending messages such as system updates to administrators,
account notifications to end users, and usage reporting to Citrix. The email server you specify for the Provisioning server can
be specified for the Report Mailer, which also requires email capabilities.
The Directory web service provides an interface to Active Directory. The Services Manager control panel uses this service to
perform real time tasks such as user authentication and retrieving password expiration data.
In general, the Directory web service is installed on the same server that hosts the Provisioning engine. However, if you areinstalling the Directory web service on a domain controller, add the CortexWSUsers and Proxy USERS groups to the Allowlog on locally security policy setting.Important: For production environments, Citrix recommends installing the Directory web service on a server other than adomain controller.When the Directory web service platform role is installed, the Citrix Csm Directory WS application pool is created as well as
the CortexServices web site which hosts the Directory application. The files for the web site and applications are located at
C:inetpubCortexServices.
Services Manager provides a web-based control panel for performing system administration tasks and delegating certainadministration tasks to resellers and customers. The control panel is a web application (CortexWeb) that is hosted on aWeb server, separate from the other servers in your deployment. The control panel interacts with other platformcomponents as follows:
SQL databases: When the system is configured, customers and users are provisioned, or auditing and reporting
performed, the control panel sends data to be stored in the system databases.
Web services: for real-time interaction with Active Directory and other hosted services.
Provisioning engine: When any provisioning transaction is performed, the control panel sends each request through
MSMQ.
Because the control panel has no dependency on Active Directory, it can operate outside of the managed domain. The
control panel's web site can be locked down and run with minimal administrative permissions without interfering with
administration tasks.
When the Web server platform role is installed, the CortexMgmt application pool is created as well as the Cortex
Management web site which hosts the CortexAPI and CortexDotNet applications. The files for the web site and
applications are located at C:inetpubCortex Management.
The following list describes the required tasks for deploying the platform servers and creating the primary location.Depending on your requirements, your deployment might include additional tasks.1. Prepare the deployment environment. This includes the following tasks:
Provision the platform servers that will be designated as the domain controller, database server, reporting server,
Provisioning server, and web server.
Extend the Active Directory schema using the Exchange installation media.
Create DNS aliases for the Provisioning, database, reporting, and web servers.
Open the required f irewall ports on all platform servers.
Install .NET Framework on all platform servers. If this component is not present, the Setup Tool installs it
automatically, prior to installing the server roles.
2. Perf orm environment Perf orm environment readiness checks.readiness checks. You can verify the extended Active Directory schema and DNS aliases. This
procedure is available in the Setup Tool graphical interface; you can also perform the verif ications manually. You can run
this task from anywhere in the domain.
3. Creat e syst em Creat e syst em dat abases.dat abases. Run this task on the server where Microsoft SQL Server is installed. In the Configuration
Tool's graphical interface, you specify database information before you install the server roles. In the command line
interface, you specify database information when you configure the server roles and location. All databases should be
backed up and synchronized daily.
4. Inst all and conf igure Inst all and conf igure server roles.server roles. Using the Setup Tool, you install the platform server roles on the servers you
designate. With the Configuration Tool, you specify the configuration settings for the installed roles.
5. Creat e t he primary Creat e t he primary locat ion.locat ion. Use the Configuration Tool to specify the settings for the primary location. You
configure the location from the server hosting the Provisioning engine or the web server.
An XML configuration file is used to maintain context across the Services Manager deployment. As you configure the
server roles, information is read and written to the configuration file. For example, the Provisioning engine writes its own
configuration information and reads where to reach the database. When you configure the primary location, the
configuration file will already have information needed about the Provisioning server.
There is one configuration file per location, although all locations can share a single database server. You configure the
primary location first, then optionally, remote locations. For example, a new customer with an existing infrastructure and
domain might be integrated as a remote location in the control panel. When you configure remote locations, you specify
connection details, which are used to generate a new configuration file. After that, configuring a remote location is
similar to configuring the primary location.
The following list describes the required tasks for deploying the platform servers that comprise a remote location.1. Prepare the deployment environment. This includes the following tasks:
Provision the servers that will be designated as the domain controller and Provisioning server. The remote location
uses the web server and the database server in the primary location for control panel administration and reporting,
respectively.
Extend the Active Directory schema using the Exchange installation media.
Create DNS aliases for the Provisioning, database, and web servers.
Open the required f irewall ports on all servers to enable communication with the database server and web server in
the primary location.
Install .NET Framework on the platform servers, to avoid interruption when installing server roles. The Setup Tool also
installs this component automatically, if it is not present, when installing the server roles.
2. Perf orm environment Perf orm environment readiness checks.readiness checks. You can verify the extended Active Directory schema and DNS aliases. This
procedure is available in the Setup Tool graphical interface; you can also perform the verif ications manually. You can run
this task from anywhere in the domain.
3. Inst all and conf igure Inst all and conf igure server roles.server roles. Using the Setup Tool, you select the server roles to be installed on each server.
With the Configuration Tool, you specify the configuration settings for the installed roles. As with the primary location,
you can install the Provisioning and Directory web service roles on the same server.
4. Creat e t he remot e Creat e t he remot e locat ion.locat ion. Use the Configuration Tool to specify the settings for the primary location. You
configure the location from the server hosting the Provisioning engine or the web server. Afterward, continue
configuring the remote location using the Services Manager control panel in the primary location.
Updated: 2013-02-27Before you begin the process of deploying services for Services Manager, create a deployment plan that includes thefollowing information:
The types of services you will offer through Services Manager. For example, hosted email, virtual machines, web hosting,
and so on.
The number of customers and users that each service will need to support. For some services, this has a signif icant
impact on the size of the resource deployment required.
The network and server resources that are required to support your service offerings. For example, if you offer Citrix
services, you will need to deploy a XenApp farm.
The location where each service will be deployed.
The topology of the deployment including f irewalls, required ports and protocols, and the servers hosting each service
offering.
Test plans for verifying the integrity and performance of resource deployments before and after deploying services.
Review the installation and configuration topics for each service carefully and make note of the information you will
need to supply for each task.
In general, deploying a service includes the following tasks:
St ep 1: Deploy t he net work and applicat ion resources t hat are required t o support your service of f erings.St ep 1: Deploy t he net work and applicat ion resources t hat are required t o support your service of f erings.
All services are based on the network and server resources in your environment. Therefore, these resources need to be fully
configured and operational prior to integration with Services Manager. For example, if you intend to offer the Hosted
Exchange service, you must first deploy Exchange with multi-tenant support in your environment. Likewise, if you intend to
offer Virtual Machines or Windows Web Hosting services, you must first deploy the network resources -- for example,
virtual networks, DNS, and web servers -- that are required for customers to use these services.
St ep 2: Inst all t he web service.St ep 2: Inst all t he web service.
Some services require the installation of a web service for integration with the Services Manager platform. Web services are
installed on the server that will be hosting the service, using the Services Manager Setup Tool or the command line. For
example, the Citrix web service is installed on a XenApp server in your environment. Web services are executed with specific
parameters which are explained in the installation topic for each service. After the web service is installed, you can configure
the service. For services that do not require a web service, you can skip the installation step and configure the service right
away. For more information about which services require web service installation, see Deploy services.
St ep 3: Conf igure t he service using t he cont rol panel.St ep 3: Conf igure t he service using t he cont rol panel.
All services require configuration through the Services Manager control panel. Configuration includes enabling the service,
specifying server resources, adding credentials, and configuring service settings. During the configuration process, you create
the customer and user plans you want to offer, assign cost values, and specify resource limits for customers and users.
After you configure the service, you can provision the service to customers.
St ep 4 : Provision t he service t o cust omers.St ep 4 : Provision t he service t o cust omers.
Updated: 2013-04-18The Office Communication Server 2007 (OCS) service for Services Manager delivers unified communication services from the
cloud. Using the Office Communicator client software, users enjoy an array of communication options, including group
chats, status updates, and video conferencing.
The OCS service uses a WMI connection to the Office Communications Server in your environment. The service requires no
web service to be installed. You need only to configure the service through the Services Manager control panel.
The OCS service supports the following OCS versions:Office Communication Server 2007
Office Communication Server 2007 R2
Before you deploy the OCS service, you must have a supported version of OCS deployed in your environment.
To allow provisioned users to connect to Communicator, perform the following actions:If needed, change the scope of the CortexAdmins group from global to universal.
Include the RTCUniversalAdmins and RTCUniversalReadOnlyAdmins groups in the CortexAdmins group.
On the OCS server, restart all services that use RTC credentials.
To enable OCS reporting, configure and enable the OCS Monitoring Service on the OCS server. During configuration,perform the following actions on the OCS server:
Use both TCP/IP and named pipes for local and remote connections.
Allow SQL Server mode and Windows Authentication mode.
Add a SQL Server logon that has been granted db_datareader and db_owner permissions to the following OCS
databases: RTC, RTCDYN, and LCSCDR (this database is present only when OCS Monitoring is enabled).
Deploying the OCS service involves the following tasks:1. Configure the service using the control panel.
2. If using in a multi-tenanted environment, partition the address book by OU.
3. If OCS 2007 R2 is installed in the Configuration container instead of System, update the location on the Services
Manager Provisioning server. By default, Services Manager looks for OCS settings in the System container.
4. Provision the service to customers.
For deployment instructions, see Deploy the Office Communication Server 2007 service.
Updated: 2014-09-16The AD Sync service for Services Manager synchronizes customer OUs in the hosted domain controller with user changes in
the external domain controllers. The service enables users to connect to hosted services with the same credentials they use
for their local domain. Additionally, Services Manager includes a server monitor that reports the connectivity status of
domain controllers on which the AD Sync client is installed.
The AD Sync service requires no installation on the hosted environment and uses the CloudPortal Services Manager API to
perform the synchronization. An AD Sync client installed on each external domain controller communicates with the API.
This interface is a one-way connection that can be customized to synchronize specific Active Directory information.
API requests are encrypted using a combination of a public/private key and a symmetric key (RSA and AES) to securely
transfer data and credentials. The data in the request is also hashed (SHA1) to prevent unauthorized changes.
The following diagram shows a typical installation scenario.
The AD Sync service is a customer-only service; by default, the service is unavailable for provisioning to users. Once
provisioned to a customer, the customer's administrator has access to download and configure the AD Sync tool to their
existing domain controller. To download the tool, the customer must be configured with the Allow passwords to Never
Expire option set to Yes. If this option is set to No, errors are recorded in the customer's event log and no users appear in
the control panel.
The AD Sync service monitors the connectivity status of external domain controllers on which the AD Sync client is installed
and displays a list of all monitored servers on the AD Sync Server Monitor page in the control panel.
The AD Sync client sends requests to the Services Manager API at specified intervals that are recorded in a monitoring
table. This table includes the server name, time of the last request made, and expected time interval between requests.
When the difference between the current time and the time of the last request exceeds the expected interval, the Server
Monitor page displays a red dot next to the affected server, indicating connectivity has been disrupted. When a request is
received within the expected time interval, the Server Monitor page displays a green dot next to the server, indicating
connectivity is uninterrupted.
When configuring each domain controller in the external domain, perform the following tasks:If SSL is enabled for Services Manager, edit the CortexDotnetweb.config f ile to set the UserSyncAPISSL value to True.
Ensure the password complexity of the external domain controllers matches or exceeds the password complexity of the
domain controllers in the Services Manager deployment.
Disable User Account Control (UAC) on each external domain controller that will run the AD Sync client.
Obtain a list of the user groups to include in AD Sync operations.
On applicable f irewalls, perform one of the following tasks, depending on your network configuration:Open HTTP and HTTPS ports (80 and 443) bi-directionally between the server hosting the Services Manager API and
each domain controller in the external domain.
Open HTTP and HTTPS ports (80 and 443) bi-directionally between the server hosting the Services Manager API and the
proxy server used in the external domain.
Typically, deploying the AD Sync service involves the following tasks:1. Configure the AD Sync service using the control panel.
2. If required, customize the AD Sync client installer, such as default settings and logo images, for your Services Manager
deployment.
3. Install and test the AD Sync client on external domain controllers. If necessary, add or modify the Active Directory
attributes included in API requests by editing the request f ile on the external domain controller.
4. Provision the service to customers so they can download the AD Sync client software.
For deployment instructions, see Deploy the AD Sync service.
An Active Directory security group is added to Hyper-V servers to enable remote connections. Yourenvironment must allow security groups to be added to the host from the domain containing theServices Manager components.
In SCVMM, a Self Service user role is required for integration with Services Manager. Create this role with the followingsettings:
User role name: SelfService
User role profile: Self-Service User
Role member: CortexWSUser
Select the VM host groups that Services Manager will manage
Grant permissions: All actions
Allow users to create new VMs
Do not allow users to store VMs in a library
Open inbound TCP port 8095 on the server hosting the Virtual Machines web service. Additionally, open the followingfirewall ports, by role:
RoleRole PortPort Descript ionDescript ion
SCVMM servers 8100 VMM - Administrator Console to VMM server
Asinstalled
RDP - self-service portal website port
If using a remote VMMdatabase
1433 TDS - SQL Server
Virtual server 5900 VMRC - VMRC connection to virtual server host
Hyper-V hosts 80 WinRM - VMM server to VMM agent on Windows Server-based host(control)
443 BITS - Library server > hosts
445 SMB - VMM server to VMM agent on Windows Server-based host (data)
Remove the following folders or executables from real-time scanning by security software:The default virtual machine configuration folder (for example, C:ProgramDataMicrosoftWindowsHyper-V) and any
custom virtual machine configuration folders
The default virtual machine hard disk drive folder (for example, C:UsersPublicDocumentsHyper-VVirtual Hard Disks) and
any custom virtual machine hard disk drive folders
Snapshot folders
VMMS.EXE - Virtual Machine Management Service
VMWP.EXE - Virtual Machine Worker Process
If you use Hyper-V Live Migration with Cluster Shared Volumes, remove the Cluster Storage folder (for example,
C:Clusterstorage) and all subfolders.
For each Hyper-V host, use SCVMM to set up network access:Configure network adaptors.
Configure VLAN ranges for VLAN trunking.
Hyper-V hosts can be stand-alone or clustered. Services Manager supports Cluster Shared Volumes for provisioning highly
available VMs.
For each Hyper-V host Services Manager is to manage, refer to article CTX129850, "How to Add a Hyper-V Host to
Cortex," in the Citrix Knowledge Center.
Deploying the Virtual Machines service involves the following tasks:1. Install the web service on the SCVMM server.
2. Configure the service using the control panel.
3. Verify the connection to SCVMM and synchronize resources.
4. Add Hyper-V hosts to Services Manager. See article CTX129850, "How to Add a Hyper-V Host to Cortex," in the Citrix
Knowledge Center.
5. Create virtual servers and networks using the control panel.
6. Establish remote connectivity to virtual servers so that customers can access them when they are provisioned the
service. See article CTX129846, "How to Connect to a Virtual Machine," in the Citrix Knowledge Center.
Updated: 2013-10-31To migrate customers' SharePoint 2010 sites to SharePoint 2013, you perform the following tasks:1. Upgrade your SharePoint 2010 deployment to SharePoint 2013 as described in the article "Overview of the upgrade
process to SharePoint 2013" on the Microsoft TechNet web site.
2. In the Services Manager control panel, remove customers' SharePoint 2010 sites. This step removes sites from the
control panel, but does not delete them from the SharePoint farm.
3. Import customers' upgraded SharePoint 2013 sites into the control panel for management.
Removing a SharePoint site removes the site listing from the Services Manager control panel only. The site remains intact in
the SharePoint farm.
1. From the Services Manager menu bar, choose Services > SharePoint 2013 > Site Removal.
2. Under Farm Selection, select the SharePoint Version, Location, and Farm server where the site you want to remove
resides.
3. In the site table, select the SharePoint site you want to remove.
4. Click Delete Sites. The site table no longer displays the site entry.
Before you import an existing SharePoint site, ensure you have the following items:The customer to whom you want to assign the imported site has been added to Services Manager
The user designated as the site's Primary Administrator has been added to the customer
When you import a site, Services Manager automatically assigns it to the customer based on the user designated as the
site's Primary Administrator. If Services Manager detects that the user does not belong to a customer, you cannot import
the site.
1. From the Services Manager menu bar, choose Services > SharePoint 2013 > Site Import.
2. Under Farm Selection, select a Location and Farm where the site you want to import resides. Services Manager
automatically detects the sites in the farm and displays them in a list.
3. From the site list, select the unassigned site you want to import and then click Import.
Before provisioning the SharePoint 2013 service to a customer, at least one SharePoint farm and feature pack must be
configured (see Configure the SharePoint 2013 service). Feature packs determine the functionality that is available to
provisioned users.
Additionally, to enable Services Manager to provision DNS records to the customer when provisioning SharePoint 2013 sites,
ensure the DNS service is configured. For domains that are owned by the customer, ensure the DNS service is configured
and provisioned to the customer.
Provisioning the SharePoint 2013 service to a customer consists of the following actions:Conf igure SharePoint Conf igure SharePoint resources:resources: This action creates a subscription for the customer to the SharePoint farm you
specify. You can specify multiple, different farms with companion feature packs. However, you cannot specify multiple
instances of the same farm.
Conf igure SharePoint Conf igure SharePoint sit es:sit es: This action deploys a SharePoint site for the customer using the customer plan, site
template, SSL certif icate, and URL you specify.
Customer plans determine how the site is configured and saved on the SharePoint 2013 server. Service providers configurethe availability of the following plans when they provision the service to customers. All plans support SSL and anonymousauthentication.Cust omer Cust omer Sit eSit e
This site is attached to a Web application that is configured specif ically for the customer. If additional sites are configured
with the same package, these sites are assigned to the same Web application. This site uses a dedicated content database.
Shared Shared Sit eSit e
This site is attached to a shared Web application where other customers' SharePoint sites reside. This site uses a dedicated
content database.
Dedicat ed Dedicat ed Sit eSit e
This site is attached to its own Web application. No other SharePoint sites are configure for the Web application pool
unless the Web application is manually overridden with the Web application's name. This site uses a dedicated content
database.
1. From the Services Manager menu bar, click Customers > Customer Services.
2. In Customer Search, f ind the customer for whom you want to provision the SharePoint 2013 service.
3. In the services list, click SharePoint 2013 configure resources.
4. In the SharePoint farm table, click Add and select the farm and companion feature pack to allocate to the customer.
Note: Changing the companion feature pack affects the features of all sites that are provisioned to a customer. This
change can affect the customer's billing for those sites. For example, if a customer has several sites provisioned in a farm
with the Foundation feature pack, changing the feature pack to Enterprise will cause the customer to be billed at the
Enterprise level for all provisioned sites.
5. Click Update and then click Save.
6. In the services list, click SharePoint 2013 create an instance.
7. Type an instance name that contains no spaces or special characters and click Create. The Instance Setup page appears.
Install the Lync Enterprise 2013 and Lync Hosted 2013 webservices
Jun 05, 2015
Updated: 2014-01-06Before you install the Lync 2013 web services, ensure you have the following items in your environment:
You have a working deployment of Lync Server 2013 Enterprise Edition or Lync Server 2013 Multitenant Hosting Pack with a published
topology.
You have a working deployment of Services Manager 11.0.1.
Note: Services Manager 11 is not supported for use with Lync 2013 services.
You have deployed the Lync 2013 Distributor Report f ix according to the instructions in article CTX139274, in the Citrix Knowledge Center.
Install the Lync Enterprise 2013 or Lync Hosted 2013 web services on the Lync Front-End servers in your environment.
You can install the Lync 2013 web services using the graphical interface of the Services Manager Setup Tool or through the command line.
The Setup Tool installs the web service, any prerequisites needed, and the Configuration Tool. After installing the web service, you launch the
Configuration Tool to perform the preliminary configuration. You then continue the configuration through the control panel.
1. On the installation media, double-click Setup.exe. The Services Manager Setup Tool appears.
2. On the License Agreement page, click I accept the terms of this license agreement and then click Next.
3. On the Select Web Services page, select Lync Enterprise 2013 Web Service or Lync Hosted 2013 Web Service. Click Next.
4. On the Review Prerequisites page, review the required items the Setup Tool will install. Click Next.
5. On the Ready to Install page, review your selections and then click Install. The Setup Tool installs the required f iles and displays the
installation progress.
6. When the installation is f inished, click Next.
7. On the Configure Installed Components page, click Configure next to the Lync service you installed.
8. On the Configure IIS page, enter the following information and then click Next:
Auto-generate credentials: Select this check box to allow the Configuration Tool to generate service account credentials automatically.
User name: Enter a user name for the Lync web service account. The default user name is csm_lync_svc. This f ield is unavailable when
you elect to auto-generate credentials.
Password: Enter a password for the Lync web service account. This f ield is unavailable when you elect to auto-generate credentials.
Create if doesn't exist: Leave this check box selected to allow the web service account to be created if it does not already exist in
Active Directory.
Service port: Enter the port used by the Lync web service. The default port is 8095.
9. On the Summary page, review the configuration information. If you want to change anything, return to the appropriate configuration
page. When the summary contains the settings you want, click Next. The Configuration Tool configures the Lync web service and displays
progress.
10. Click Finish and then click Exit to close the Configuration Tool.
After you install the web service, continue the configuration using the Services Manager control panel. For more information, see To configure
the Lync Enterprise 2013 service or To configure the Lync Hosted 2013 service.
Before installing the Lync web services, ensure the following pre-requisites are met:You have installed .NET Framework 4, located in the Support folder of the Services Manager installation media, on the Lync Front-End
server.
The Lync Front-End server allows inbound connections from the Services Manager web server on the appropriate port. By default, this port
is 8095.
When you install the Lync web service from the command line, you perform two actions:Install the web service and create the required Services Manager directory where the web service resides.
The Setup Tool installs the web service and returns the command prompt.
4. At the command prompt, enter install-locationServicesLyncWSConfigurationLyncServiceConfigConsole.exe and specify the following
properties:
Propert yPropert y Descript ionDescript ion
/UserName:username User name for the Lync service account. This parameter is optional if you are using /GenerateCredentials.
/Password:password Password for the Lync service account. This parameter is optional if you are using /GenerateCredentials.
/ServicePort:port Inbound port to be used and added to the CortexServices web site. Default = 8095
/AutoCreateUser:True |
False
Optional. Create the service account in Active Directory.
/GenerateCredentials:True
| False
Optional. Generate a password for the service account.
/SqlServer:server-address The SQL database server that hosts the Services Manager system databases.
/UseSqlAuthentication:True
| False
Whether or not to use SQL authentication to access the SQL Server. Default = Integrated
authentication which authenticates as the user running the configuration
/SqlUserName:user-name If /UseSqlAuthentication:True, the username of the SQL logon to use.
/SqlPassword:password If /UseSqlAuthentication:True, the password of the SQL logon to use.
Install-location denotes the web service installation directory on the local computer. The default directory is C:Program Files
(x86)CitrixCortex.
The Configuration Tool performs initial configuration of the web service and returns the command prompt.
Sample command string
The following command performs the initial configuration of the web service.install-locationServicesLyncWSConfigurationLyncServiceConfigConsole.exe /UserName:lync_svc_acct /Password:password /ServicePort:8095
When the installation process is finished, log on to the control panel and configure the web service. For instructions, see To configure the Lync
Enterprise 2013 service or To configure the Lync Hosted 2013 service.
Updated: 2013-02-11For information about requirements for deploying the Citrix service, refer to Plan to deploy the Citrix service.
Deploying the Citrix service to customers includes the following tasks:1. Install the Citrix web service
2. Configure the Citrix service
3. Provision the Citrix service to resellers
4. Provision the Citrix service to customers
After deploying the Citrix service, use the following topics to provide access to resources through the control panel:Create or remove Citrix application groups
To enable Services Manager to discover the hosted applications in your environment, you configure a server collection thatincludes the XenApp servers where the applications reside. After the server collection is created, you can use the CitrixApplications page to configure the global settings for each application.1. From the Services Manager menu bar, click Services > Citrix > Configuration > Citrix Applications.
2. Under Citrix Server Filter, select the location and server collection you want to use. All hosted applications configured for
the server collection appear.
Note: Click Refresh to ensure you are viewing all available hosted applications.
3. Under Configured Applications, select the hosted application whose settings you want to configure.
4. Under Manage Application Settings, select one of the following options to create an Active Directory group:
Generate creates and names a security group automatically (e.g., CitrixApp 3).
Custom enables you to create a new security group with a unique name you specify.
5. In Allocation, select the Default Application check box to include the hosted application in the Citrix services package
that is provisioned to customers.
6. In Access, configure the hosted application's availability by performing one of the following actions:
To make the hosted application available to all customers, select the Public Application check box.
To make the resource available to one specif ic customer, clear the Public Application check box and enter the name
of the customer you want to assign.
Note: If you make the hosted application available to one specif ic customer, the application can be added only to
application groups that belong to the same customer.
7. In Publish, select Enabled to make the hosted application visible to customers.
8. Click Save to create the Active Directory group and save your selections.
With Citrix application access, you can provision an application, resource, or application group to multiple users with a singleprovisioning request.To use application access, the Citrix service must be provisioned to the customer to whom the users belong. Additionally,
resellers who want to provision multiple users of sub-customers must have the Citrix service provisioned.
1. From the Services Manager menu bar, click Customers and select a customer for whom you want to provision
applications.
2. In Customer Functions, click Services. This ensures the customer is selected.
3. From the Services Manager menu bar, click Services > Citrix > Application Access.
4. In Type, select the type of application or resource you want to provision.
5. Select the application or resource you want to provision.
6. Under Citrix Application Management, select the users you want to provision.
7. Click Provision to send provisioning requests for all users selected. The selected users are added to the Active Directory
Updated: 2013-02-15The Citrix web service is installed on all XenApp servers in your environment that you want to make available for provisioning
hosted apps and desktops to users. You can install the Citrix web service using either the graphical interface of the Services
Manager Setup Tool or through the command line. After the installation process finishes, you can enable the service and
continue configuration through the control panel.
The installation process includes preliminary configuration to create the web service account and IIS application pool, and
define the service port.
This task assumes the Services Manager installer is running and the Select Deployment Task page is displayed.
1. On the Select Deployment Task page, select Add Services & Locations.
2. On the Add Services & Locations page, select Install Services.
3. Accept the License Agreement and then click Next.
4. On the Select Web Services page, select Citrix Web Service and then click Next.
5. On the Ready to Install page, review your selection and then click Install.
6. After the installation f inishes, click Finish.
7. On the Installed Services page, click Configure next to the Citrix web service list item.
8. On the Configure IIS page, enter the following information and then click Next:
Auto-generate credentials: Select this check box to allow the Configuration Tool to generate service account
credentials automatically.
User name: Enter a user name for the Citrix web service account. The default user name is csm_citrix_svc. This f ield is
unavailable when you elect to auto-generate credentials.
Password: Enter a password for the Citrix web service account. This f ield is unavailable when you elect to auto-
generate credentials.
Create if doesn't exist: Leave this check box selected to allow the web service account to be created if it does not
already exist in Active Directory.
Service port: Enter the port used by the Citrix web service. The default port is 8095.
9. On the Summary page, review the configuration information. If you want to change anything, return to the appropriate
configuration page. When the summary contains the settings you want, click Next. The Configuration Tool configures
the Citrix web service and displays progress.
10. Click Finish and then click Exit to close the Configuration Tool.
Before installing the Citrix web service, ensure the following pre-requisites are met:You have installed .NET Framework 4, located in the Support folder of the Services Manager installation media, on the
XenApp server.
The XenApp servers are running supported versions of Citrix XenApp.
You have created the Citrix web service account in Active Directory.
The Citrix web service account is a Citrix administrator with Full Administration permissions on the XenApp servers where
you install the Citrix web service.
The XenApp server allows inbound connections from the Web platform server on the appropriate port. The default port
When you install the Citrix service from the command line, you perform two actions:Install the web service and create the required Services Manager directory where the web service resides.
Perform initial configuration of the web service using the Configuration Tool.
1. On the XenApp server, log on as an administrator.
2. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
3. At the command prompt, enter CortexSetupConsole.exe /Install:Citrix. The Setup Tool installs the web service and
returns the command prompt.
4. At the command prompt, enter install-locationServicesCitrixWSConfigurationCitrixServiceConfigConsole.exe and specify
the following properties:
Propert yPropert y Descript ionDescript ion
/UserName:ctx_svc_acct Impersonation account for the Citrix service. This account must be a Citrix administrator.
/Password:password Password for the Citrix service account.
/ServicePort:port Inbound port to be used/added to the CortexServices web site. Default = 8095
Install-location denotes the web service installation directory on the local computer. The default directory is C:Program
Files (x86)CitrixCortex.
The Configuration Tool performs initial configuration of the web service and returns the command prompt.
Sample command string
The following command performs the initial configuration of the web service.install-locationServicesCitrixWSConfigurationCitrixServiceConfigConsole.exe /UserName:ctx_svc_acct /Password:password /ServicePort:8095
When the installation process is finished, log on to the control panel and configure the web service. For instructions, see
An application group is a collection of hosted applications, other application groups, and resources. With application groups,you can provision multiple applications and resources to customers quickly and eff iciently.You can also enable customers to create their own application groups that include the applications and resources that are
available to them. To use this feature, the customer must have a user with Citrix Service Administrator permissions, at a
minimum.
Before you create application groups, ensure there is a server collection configured that hosts the applications and
resources you want to include in the group.
When creating an application group, you have the option to make the group available to all customers (public group) or
make the group available to a specific customer (private group). If you choose to make the group private, be sure to click
Save & Reload. When you click Save & Reload, the group is assigned to the customer and all of the customer's private
applications and resources are available for inclusion. To modify this assignment, you first deprovision the Citrix service for
the customer through the Customer Services page. Then, you can modify the application group to assign it to a different
customer or make the group public. After you modify the application group, you can reprovision the Citrix service for the
customer.
When you assign an application group to a specific customer, you can include the group only in other application groups
that are assigned to the same customer.
1. From the Services Manager menu bar, click Services > Citrix > Configuration > Application Groups.
2. Under Citrix Server Filter, select the location and server collection you want to use for the application group. Any existing
application groups configured for the server collection appear.
3. Under Group Management, click New Application Group.
4. Type the name and description of the new group.
5. In Allocation, select the Default Group check box to include the application group in the Citrix services package that is
provisioned to customers.
6. In Access, configure the application group's availability by performing one of the following actions:
To make the application group available to all customers, select the Public Group check box.
To make the application group available to one specif ic customer, clear the Public Group check box and enter the
name of the customer you want to assign.
Note: If you make the application group private, click Save & Reload to create the group and view the customer's
other private application groups or resources. You can then include these items in the group.
7. In Directory Resource, choose one of the following options:
Generate creates and names a security group automatically (e.g., CitrixGrp 3).
Search enables you to f ind and select an existing security group within the domain.
Custom enables you to create a new security group with a unique name you specify.
8. Under Applications, select the hosted applications you want to include in the group.
9. Under Groups, select other available application groups you want to include.
10. Under Resources, select the network resources you want to include in the group.
11. In Publish, select Enabled to make the application group visible to customers.
Updated: 2014-11-20Deploying Lync 2010 services involves the following tasks:
Install the web service for Lync Enterprise or Lync 2010 for Hosting
To configure the Microsoft Lync Enterprise service
To configure the Lync 2010 for Hosting service
Provision the Lync Enterprise service
Provision the Lync 2010 for Hosting service
The Lync Enterprise and Lync 2010 for Hosting web services are installed on the Lync Front-End servers in your environment that you want to
make available for provisioning unified communication services to customers. You can install the Lync web services using the graphical
interface of the Services Manager installer or through the command line. After the installation process finishes, you can enable the service
and continue configuration through the control panel.
For more information about requirements for deploying the Lync Enterprise 2010 and Lync Hosted 2010 services, refer to Plan to deploy Lync
Enterprise and Lync Hosted services.
The Services Manager installer enables you to install the Lync Enterprise web service. The installation process includes preliminary
configuration to create the web service account and IIS application pool, and define the service port.
This task assumes the Services Manager installer is running and the Select Deployment Task page is displayed.
1. On the Select Deployment Task page, select Install CloudPortal Services Manager.
2. On the Install CloudPortal Services Manager page, select Add Services.
3. On the Add Services page, select Install Services.
4. Accept the License Agreement and then click Next.
5. On the Select Web Services page, select Lync Web Service or Lync Hosted Web Service, and then click Next.
6. On the Review Prerequisites page, review the list of software that will be installed to support the web service and then click Next.
7. On the Ready to Install page, review your selection and then click Install.
8. After the installation f inishes, click Finish.
9. On the Installed Services page, click Configure next to the Lync web service list item.
10. On the Configure IIS page, enter the following information and then click Next:
Auto-generate credentials: Select this check box to allow the Configuration Tool to generate service account credentials automatically.
User name: Enter a user name for the Lync web service account. The default user name is csm_lync_svc. This f ield is unavailable when
you elect to auto-generate credentials.
Password: Enter a password for the Lync web service account. This f ield is unavailable when you elect to auto-generate credentials.
Create if doesn't exist: Leave this check box selected to allow the web service account to be created if it does not already exist in
Active Directory.
Service port: Enter the port used by the Lync web service. The default port is 8095.
11. On the Summary page, review the configuration information. If you want to change anything, return to the appropriate configuration
page. When the summary contains the settings you want, click Next. The Configuration Tool configures the Lync web service and displays
progress.
12. Click Finish and then click Exit to close the Configuration Tool.
Before installing the Lync web services, ensure the following pre-requisites are met:You have installed .NET Framework 4, located in the Support folder of the Services Manager installation media, on the Lync Front-End
server.
You have created the Lync web service account in Active Directory.
The Lync Front-End server allows inbound connections from the Services Manager Web server on the appropriate port. By default, this
When you install the Lync web service from the command line, you perform two actions:Install the web service and create the required Services Manager directory where the web service resides.
Perform initial configuration of the web service using the Configuration Tool.
1. On the Lync Front-End server, log on as an administrator.
2. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
3. At the command prompt, enter one of the following commands:
CortexSetupConsole.exe /Install:LyncEnterprise
CortexSetupConsole.exe /Install:LyncHosted
The Setup Tool installs the web service and returns the command prompt.
4. At the command prompt, enter install-locationServicesLyncWSConfigurationLyncServiceConfigConsole.exe and specify the following
properties:
Propert yPropert y Descript ionDescript ion
/UserName:username User name for the Lync service account. This parameter is optional if you are using
/GenerateCredentials.
/Password:password Password for the Lync service account. This parameter is optional if you are using
/GenerateCredentials.
/ServicePort:port Inbound port to be used and added to the CortexServices web site. Default = 8095
/AutoCreateUser:True | False Optional. Create the service account in Active Directory.
/GenerateCredentials:True |
False
Optional. Generate a password for the service account.
Install-location denotes the web service installation directory on the local computer. The default directory is C:Program Files
(x86)CitrixCortex.
The Configuration Tool performs initial configuration of the web service and returns the command prompt.
Sample command string
The following command performs the initial configuration of the web service.install-locationServicesLyncWSConfigurationLyncServiceConfigConsole.exe /UserName:lync_svc_acct /Password:password /ServicePort:8095
When the installation process is finished, log on to the control panel and configure the web service. For instructions, see To configure the
Microsoft Lync Enterprise service or To configure the Lync 2010 for Hosting service.
/ServicePort:port Inbound port to be used and added to the CortexServices web site. Default = 8095
Install-location denotes the web service installation directory on the local computer. The default directory is C:Program
Files (x86)CitrixCortex.
The Configuration Tool performs initial configuration of the web service and returns the command prompt.
Sample command string
The following command performs the initial configuration of the web service.install-locationServicesMySQLWSConfigurationMySQLConfigConsole.exe /ServicePort:8095
This web service does not require any additional properties to be passed for installation.
After installation is finished, you can configure the MySQL service. For instructions, see To configure the MySQL service.
Updated: 2013-02-11For information about the requirements for deploying the Windows Web Hosting service, refer to Plan to deploy the
Windows Web Hosting service.
Deploying the Windows Web Hosting service involves the following tasks:Install the Windows Web Hosting web service
Configure the Windows Web Hosting service
To provision Windows Web Hosting services to resellers
Provision the Windows Web Hosting service to customers
After deploying the Windows Web Hosting service, use the following the topics to add and import web sites, manage website directories and subdomains, and install web applications:
The following command performs the initial configuration of the web service.install-locationServicesCitrixWSConfigurationIISConfigConsole.exe /UserName:iis_svc_acct /Password:password /ServicePort:8095
Updated: 2013-02-25The Web Site Import tool enables service providers to import and configure IIS 7 web sites for customers. After provisioning,
the customer's administrator can manage the site using the IIS Manager.
Before importing web sites, the following prerequisites must be met:The user performing the import must have Service Provider Administrator privileges.
The web server currently hosting the sites is configured with the Windows Web-Hosting server role (Configuration >
System Manager > Server Roles).
The web server currently hosting the sites is included in an applicable server collection (Configuration > System Manager
> Server Collections).
A server connection has been set up for the web server currently hosting the sites (Configuration > System Manager >
Server Connections).
The customer for whom the web sites are imported has a Services Manager account. However, the Windows Web-
Hosting service does not need to be provisioned to the customer. When the f irst web site is migrated, Services Manager
provisions the Windows Web-Hosting service and enables the server hosting the site.
1. From the Services Manager menu bar, click Services > Windows Web Hosting > Web Site Import.
2. Under Server Connection, perform the following actions:
1. In Location, select the location where the server resides.
2. In Web Service, select the server that is configured with the Windows Web-Hosting service. In Server, select the server
that is hosting the web site you want to import.
3. Click Load. A list of all the web sites that are present on the server appears.
4. From the site list, select the web site you want to import. The Site Import Manager page appears.
5. In Customer Search, type the name of the customer for whom you want to import the site.
6. Click Load. The page refreshes and displays the customer's name and primary domain.
7. Under Service Setup, in Instance Name, type the name of the instance that does not contain spaces. This name appears
as an instance in the customer's services list.
8. In Customer Plan, select the package template to which the server is assigned.
Updated: 2013-02-25In IIS, default documents are files that are automatically served when a user accesses the customer's web site but does
not request a specific file. A default document might be the customer's home page or a file list (if directory browsing is
enabled).
When a customer is provisioned with an instance of Windows Web Hosting, the following default documents are createdin the web site's root directory:
Index.htm
Index.html (IIS 7 only)
Index.cfm (IIS 7 only)
Default.asp
Default.aspx (IIS 7 only)
Default.htm
iisstart.htm (IIS 7 only)
Note: Index.php is created only when the Web Hosting instance is configured with PHP Framework settings.The default documents that are created in the web site root directory are automatically passed to any subdirectories that
are created.
Default documents can be modified at the root web site level or at the subdirectory level. If a document is added at the
root level, it is applied to all subdirectories.
1. From the Services Manager menu bar, click Services > Windows Web Hosting > IIS Site Manager. The IIS Site Manager
displays the customer's available web sites.
2. From the Site drop-down box, select the Web site for which you want to create the subdirectory. The site's folder
structure appears in the Web Site pane.
3. In the Web Site pane, click the folder where you want to add the new default document.
4. On the Settings tab, under Default Documents, enter the new document name in the text box.
Note: The document names in this box appear in ranked order. If you want the new document to be the f irst one IIS
Customers can add or remove subdomains, or host headers, that are bound to their Web site. This allows the customer toconfigure multiple Web sites using a single Windows Web Hosting instance.1. From the Services Manager menu bar, click Services > Windows Web Hosting > IIS Site Manager.
2. From the Site drop-down box, select the Web site for which you want to create the subdomain. The site's folder
structure appears in the Web Site pane.
3. On the Domains tab, under Add Site Bindings, enter the new subdomain name and then click Add. The subdomain is
added to the list of identities for the root Web site.
4. To delete a subdomain, under Remove Site Bindings, select the subdomain from the drop-down box and then click
Updated: 2013-02-25If a customer's web site involves serving dynamically-generated content, the subdirectories containing that content can bepublished as web applications.1. From the Services Manager menu bar, click Services > Windows Web Hosting > IIS Site Manager.
2. In the Web Site pane, select the folder you want to publish as a web application.
3. On the Settings tab, under Install Application, click Install. The IIS Site Manager page refreshes and the selected folder is
Updated: 2013-02-05Exchange distribution groups are collections of users, contacts, and other distribution groups that are represented with asingle email address in the Global Address List. When a user sends an email to the group email address, all members of thegroup receive the email.When the Hosted Exchange service is provisioned to customers, users can view distribution groups through the Global
Address List using Outlook, as well as create and manage distribution groups.
Users who create distribution groups are known as owners. Additionally, group ownership can be assigned to a group of
Exchange users or a security group. Group owners can add and remove members through Outlook.
Full Customer Service Administrators can create and delete groups, manage group members, and configure group email alias
permissions and member email restrictions.
To create distribution groups
1. From the Services Manager menu bar, click Services > Exchange > Distribution Groups.
2. Under Group Management, type a name for the group you want to create and ensure the Distribution option is
selected.
3. Click New Group. The distribution group is created and the group properties screen appears.
4. Click Save.
To add members to a distribution group
1. From the Services Manager menu bar, click Services > Exchange > Distribution Groups.
2. Select the group to which you want to add members.
3. Click the Members tab.
4. In Member Search, type the name of the contact you want to add and click Find.
5. Select the contact's checkbox and click Add.
6. Click Save.
To create an email alias for a distribution group
1. From the Services Manager menu bar, click Services > Exchange > Distribution Groups.
2. Select the group for which you want to create an email alias.
3. Click the Email tab.
4. In the Group Email Addresses table, click Add. A blank alias table entry appears.
5. Under Name, type the email alias you want users to specify when sending emails to the group.
6. Click Update to save your entries.
7. Click Save.
To restrict incoming email to distribution groups
To prevent external "spam" emails from flooding the group, you can configure distribution groups to accept email only from
users within the customer's organization.
1. From the Services Manager menu bar, click Services > Exchange > Distribution Groups.
2. Select the group to which you want to restrict email.
Updated: 2013-05-13The Hosted Exchange web service is installed on a server in your environment that hosts the Exchange Management Console. You can install the Exchange web service using
either the graphical interface of the Services Manager installer or through the command line.
To install the Exchange web service using the graphical interface
The installation process includes preliminary configuration to create the web service account and IIS application pool, define the Exchange deployment environment, and add
multi-tenancy permissions to Active Directory. After installation, you can enable the service and continue configuration through the control panel.
This task assumes the Services Manager installer is running and the Select Deployment Task page is displayed.
1. On the Select Deployment Task page, select Add Services & Locations.
2. On the Add Services & Locations page, select Install Services.
3. Accept the License Agreement and then click Next.
4. On the Select Web Services page, select Exchange Web Service and then click Next.
5. On the Ready to Install page, click Install. The Deploying Server Roles page displays the installation progress.
6. After the installation f inishes, click Finish.
7. On the Installed Services page, click Configure next to the Exchange web service list item.
8. On the Configure IIS page, enter the following information and then click Next:
Auto-generate credentials: Select this check box to allow the Configuration Tool to generate service account credentials automatically.
User name: Enter a user name for the Exchange web service account. The default user name is csm_exchange_svc. This f ield is unavailable when you elect to auto-
generate credentials.
Password: Enter a password for the Exchange web service account. This f ield is unavailable when you elect to auto-generate credentials.
Create if doesn't exist: Leave this check box selected to allow the web service account to be created if it does not already exist in Active Directory.
Service port: Enter the port used by the Exchange web service. The default port is 8095.
9. On the Exchange Deployment Details page, enter the following information and then click Next:
Exchange version: Select the version of Exchange that is deployed in your environment.
Mixed-mode deployment: Select this check box if your Exchange deployment includes servers running different versions of Exchange. For example, your deployment
includes Exchange 2010 servers as well as Exchange 2007 servers.
Preferred domain controller: Enter the FQDN of the domain controller you want to use with the web service.
10. On the Configure Exchange for Multi-Tenancy page, select Apply multi-tenancy permissions to ensure customers will be isolated appropriately when the Exchange service is
provisioned to them. Click Next.
11. On the Summary page, review the configuration information. If you want to change anything, return to the appropriate configuration page. When the summary contains the
settings you want, click Next. The Configuration Tool configures the Exchange web service and displays progress.
12. Click Finish and then click Exit to close the Configuration Tool.
To install the Exchange web service from the command line
Before installing the Exchange web service, ensure the following pre-requisites are met:The server on which you are installing the web service has the Exchange Management Console installed.
The Exchange servers are running supported versions of Microsoft Exchange.
You have installed .NET Framework 4, located in the Support folder of the Services Manager installation media, on the server hosting the Exchange web service.
You have created the Exchange web service account in Active Directory.
The Exchange server allows inbound connections from the web server on the appropriate port. The default port is 8095.
1. On the Exchange server, log on as an administrator.
2. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
3. At the command prompt, enter CortexSetupConsole.exe /Install:Exchange. The Setup Tool installs the web service and returns the command prompt.
4. At the command prompt, enter install-locationServicesExchangeWSConfigurationExchangeConfigConsole.exe and specify the following properties:
Property Description
/UserName:username Impersonation account for the Exchange service. This parameter is optional if you are using /GenerateCredentials.
/Password:password The application pool password. This parameter is optional if you are using /GenerateCredentials.
/ServicePort=port Inbound port to be used and added to the CortexServices web site. Default = 8095
/ExchangeOrganization:org-
name
Optional. The name of the Exchange organization.
/AutoCreateUser:True |
False
Optional. Create the service account in Active Directory.
/GenerateCredentials:True | Optional. Generate password for the service account.
Optional. The version of Exchange to use with Services Manager. Supported versions: 2007, 2010, or 2013
Property Description
Install-location denotes the web service installation directory on the local computer. The default directory is C:Program Files (x86)CitrixCortex.
The Configuration Tool performs initial configuration of the web service and returns the command prompt.
Sample installation command string
The following command performs the initial configuration of the web service.install-locationServicesExchangeWSConfigurationExchangeConfigConsole.exe /UserName:exch_svc_acct /ExchangePassword:password /ServicePort:8095 /TargetVersion:2010
When the installation process is finished, log on to the control panel and configure the web service. For instructions, see To configure the Hosted Exchange service.
Updated: 2013-02-05Importing and exporting mailboxes are important tasks for managing the Hosted Exchange service. Exporting mailboxesfacilitates disaster recovery and compliance efforts. Importing mailboxes helps with migrating users from old versions ofExchange and enabling users to add off line mail archives to their Exchange mailbox.
To export a mailbox
1. From the Services Manager menu bar, click Services > Exchange > Mailbox Import/Export.
2. Click Export Mailboxes. A table of available mailbox f iles appears.
3. Select the Export checkbox for each user's mailbox you want to export.
4. Click Export Mailboxes. The export process begins. To view the status of the export, click Refresh Status.
The exporting process creates .PST files and places them on the customer's FTP server, in a folder called MailboxExport. To
view these files, log on to the FTP server using the information that appears under FTP Login Details on the Mailbox Import
and Export Overview screen and navigate to the MailboxExport folder. Depending on the customer's configuration, mailbox
files might appear as zipped archives.
To import a mailbox
1. From the Services Manager menu bar, click Services > Exchange > Mailbox Import/Export.
2. Click Import Mailboxes. A table of users that are provisioned with an Exchange mailbox appears.
3. Click Edit for the user whose mailbox you want to update with the imported mailbox f ile.
4. Select the mailbox f ile you want to import and then click Update.
5. Click Import Mailboxes. The import process begins. To view the status of the import, click Refresh Status.
To create mailboxes for managing meeting resources
Jun 05, 2015
Resources consist of spaces or equipment that are used for holding meetings and need to be reserved when a meeting isorganized. Exchange provides mailboxes for these resources so that users can include them in meeting requests madethrough Outlook.Exchange Service Administrators can create, modify, and remove resources from the customer's organizational unit.
1. From the Services Manager menu bar, click Services > Exchange > Resource Mailboxes.
2. Under Resource Management, click New resource mailbox.
3. Type a name for the resource and select whether it is a meeting room or equipment (e.g., projector, f lip chart, etc.).
Note: Resource types cannot be amended after the resource mailbox has been provisioned. To change the resource
Updated: 2013-02-05When the Hosted Exchange service is provisioned to customers, users can view their company's Global Address Lists, sendemail to contacts in the list from Microsoft Outlook, add and modify contacts, and assign contacts to distribution groups.Full Customer Service Administrators can add, modify, and delete contacts as well as prevent contacts from displaying in the
Global Address List.
To add new contacts
1. From the Services Manager menu bar, click Services > Exchange > Contacts.
2. Under Contact Management, click New Contact. A blank Contact Details form appears.
3. Enter the details of the contact. Fields marked with an asterisk (*) are required.
4. Click Save.
To prevent contacts from appearing in the Global Address List
1. From the Services Manager menu bar, click Services > Exchange > Contacts.
2. Select the contact you want to hide.
3. On the Contact Details form, select the Hide From Address List checkbox.
Updated: 2014-02-04Configure PST file import and export to enable Services Manager to import and export Exchange personal store mailboxes
using a network share or an FTP server.
To store the PST f iles, use one of the following methods:Create a shared folder called "WebHosting" on a f ile server in your environment. Security for the shared folder is
described in Steps 2b-2d of To configure the FTP server for PST import and export.
Set up an FTP server to enable customers to upload PST f iles without service provider assistance. Access to a customer's
folder on the FTP server is limited to the customer's users who have the Hosted Exchange Service Administrator security
role.
If you choose to set up an FTP server, install the following items:FTP Server role service components
Exchange Management Tools
Microsoft Outlook
.NET Framework 4
To configure the FTP server for PST import and export
1. In Active Directory, perform the following actions:
1. Create a new user account in the Services Manager system OU called servername_pst.
2. Grant Full Control permissions of the servername_pst account to the Customers OU.
3. Add the servername_pst account to the CortexAdmins group.
2. For the FTP server, perform the following actions:
1. On the FTP server, create a new folder for use by Services Manager. The default path is C:CortexFTP.
2. Share the folder as Webhosting and grant Full Control of the share to Everyone.
3. In the folder properties, on the Security tab, verify that inheritance is disabled and, when prompted, click Add to copy
the current permissions to the folder.
4. Add the domain security group ServiceAdmins HE to the ACL of the folder and grant List Folder Contents permissions.
5. Add the servername_pst account to the ACL of the folder and grant it Full Control.
3. Add and configure the FTP site in IIS:
1. On the FTP server, open the IIS Management Console and then navigate to the Sites container.
2. Right-click the Sites container, choose Add FTP Site, and configure it.
FTP site name: A name such as "CloudPortal Services Manager PST FTP Site"
Physical path: The path configured in step 2a above
Binding IP Address: An IP address and port or All Unassigned
SSL: Allow SSL
Authentication: Basic
Authorization: Allow access to: Specif ied roles or user groups
Authorization (credentials):domainServiceAdmins HE
Authorization: Permissions: Read and Write
3. Select the FTP site node in the console's left pane and, in the Features view, perform the following actions:
1. Double-click FTP User Isolation and choose FTP home directory configured in Active Directory.
2. Click Set to specify the credentials in DomainUsername format for the new AD user account set up in Step 1a.
4. Select the FTP site node in the console's left pane and, in the Features view, perform the following actions:
1. Double-click FTP Authentication.
2. Disable Anonymous Authentication and enable Basic Authentication.
3. With Basic Authentication selected, click Edit and set the Default domain to the fully-qualif ied domain name.
4. Restart the FTP site.
5. Restart the Microsoft FTP Service.
To configure PST file import and export in Services Manager
Important: For Exchange 2007, use all steps in this procedure to configure PST f ile import and export through the ServicesManager control panel. For Exchange 2010, use only Steps 3 and 4 in this procedure.1. Assign server roles:
1. From the Services Manager menu bar, choose Configuration > System Manager > Server Roles and then expand the
server to be used for PST import and export. If the server is not listed, go to Configuration > System Manager >
Servers and refresh the list.
2. Under Server Connection Components select Hosted Exchange.
2. Add a server connection:
1. From the Services Manager menu bar, choose Configuration > System Manager > Server Connections and select a
Location Filter if applicable.
2. Click New Connection and then specify the following information for the Exchange web service:
Server Role
Choose Hosted Exchange.
Server
Choose the server where the Exchange web service is installed.
Credentials
Choose the impersonation account for the Exchange service.
URL Base
Defaults to /ExchangeWS/HostedExchange.asmx.
Protocol
Select http.
Port
Defaults to 8095. If you change the port here, change it also in the Services Manager Web Service.
Updated: 2013-04-03Personal archives are a feature of Exchange 2010 and Exchange 2013 that allows users to store older messages in a server-
side mailbox instead of in a .pst file that is stored locally. Users can access their personal archive mailbox through Outlook
2010 or the Outlook Web App.
Enabling personal archives includes the following tasks:Enable support in Services Manager. Because support for personal archives is not enabled by default, you must enable it
for each applicable Hosted Exchange user plan you intend to provision. If support is not enabled, personal archives are
not available to the user when the Hosted Exchange service is provisioned.
Enable personal archives for each user in Exchange. If personal archives are not enabled in Exchange for the user when
the Hosted Exchange service is provisioned, Services Manager enables the feature automatically. If no mailbox database
is specif ied when the user plan is configured, Services Manager selects the appropriate mailbox database automatically
when the user is provisioned.
To configure mail archiving for Exchange 2007, refer to the topic To configure the Mail Archiving service.
To enable support for personal archives
1. From the Services Manager menu bar, click Configuration > System Manager > Service Deployment.
2. Expand Hosted Exchange and then click User Plans.
3. Create a new user plan or select the existing user plan for which you want enable support for personal archives.
4. Expand the Exchange 2010 Mail Archiving category and select the Enabled checkbox.
5. In Mailbox Database, select the mailbox database that Services Manager will use for personal archives. If no database is
selected, Services Manager chooses one automatically when the user is provisioned.
Mail disclaimers are legal notices or warnings that are automatically attached to all outgoing email. The Exchange ServiceAdministrator can create, modify, and remove the company's mail disclaimer.Note: Mail disclaimers are available to customers with Exchange 2007 or 2010 only.1. From the Services Manager menu bar, click Services > Exchange > Configuration > Mail Disclaimer.
2. Type a name for the mail disclaimer and then type the body of the message.
3. Choose whether to append or prepend the disclaimer to outgoing email messages.
4. Choose whether email to which the disclaimer cannot be directly attached is ignored, rejected, or wrapped in an
Exchange envelope before sending.
5. Choose whether the disclaimer is attached to email sent to external contacts only.
Updated: 2013-02-11Services Manager enables service providers to create bulk provisioning requests for existing customers and users. Serviceproviders can use this feature to apply service updates to existing customers in one operation. Service providers can use thefollowing options:
Bulk Reprovisioning creates requests for users and services of a single customer.
Bulk System Provisioning creates requests for all users and all customers
When a provisioning request is created, it is sent to the provisioning engine and a confirmation message is displayed. Any
errors in the actual provisioning transaction appear on the Customer Services page of the control panel.
To create requests for users and services of a single customer
1. From the Services Manager menu bar, click Configuration > Provisioning & Debug Tools > Bulk Reprovisioning.
2. Under Customer Search, enter the name of the customer whose users you want to reprovision and click Search.
3. Select one of the following options:
Re-provision all users creates a request to reprovision all users of the specif ied customer.
Re-provision all customer services creates a request to reprovision all the services originally provisioned to the specif ied
customer.
Re-provision all user services creates a request to reprovision all the services originally provisioned to the specif ied
customer's users.
Re-provision a specif ic service to all users creates a request to reprovision a selected service to all users of the
specif ied customer, regardless of whether or not the service was originally provisioned to all users.
4. Click Provision. The provisioning request is created and sent to the provisioning engine. To view the status of the request,
Install the AD Sync client on every domain controller in the external domain. For more information on preparing thesedomain controllers for AD Sync, see Plan to deploy the AD Sync service.Important: The AD Sync client cannot decrypt users' existing passwords when installed due to Active Directory encryption.After the client is installed, users must change their passwords so the client can synchronize them with Services Manager.1. Log on to an external domain controller and then log on to the Services Manager control panel using the administrator
credentials of the customer just provisioned.
2. Download the AD Sync client installer:
1. From the Services Manager menu bar, select Services > AD Sync > AD Sync Download and then click Download.
2. Click Save to save the AD Sync client installer to a drive location so you can copy it to the other external domain
controllers.
3. Install the client:
1. Run the AD Sync Setup installer, enter the requested password, and then click Next.
2. Specify the User watch frequency, select the following settings, and then click Next:
Watch for changes to contacts
Watch for changes to groups
Watch for changes to users
Important: Perform this step for only one AD Sync client to ensure that duplicate requests are not sent to the
Services Manager API. The domain controller configured to watch for changes synchronizes user and password
changes. The other domain controllers synchronize only password changes.
3. Select the Active Directory user groups to include in AD Sync operations and then click Next twice. When the AD Sync
service detects a USN change, it performs the synchronization only if the user is in an included group. The last USN
value is stored in [INSTALLDIR]QueueSyncActiveDirectory.config.
4. If a proxy server is used in the external domain, enter the information for it. Using a proxy server ensures that domain
controllers are not exposed to the internet.
5. Click Next, choose a location to install the AD Sync client, click Next, and then click Install.
6. Restart the domain controller. The AD Sync service starts.
7. Copy the AD Sync client installer to all other external domain controllers and then repeat Steps 3a - 3g for each
domain controller.
4. Test the AD Sync client:
1. After a domain controller restarts, log on to Services Manager and then click Users to view the user list. The
synchronized users have a small green arrow next to the user icon.
2. To test that the synchronization works for new accounts, create a new user account in the external domain, add it
to a user group that is included in AD Sync operations, change an attribute on the account, and then verify that the
account appears on the Users screen.
To synchronize additional Active Directory attributes
To change the Active Directory attributes included in API requests, edit the request format in [INSTALLDIR]Requests.
Synchronize Exchange contacts and distributiongroups in a remote domain
Jun 05, 2015
Updated: 2013-04-30You can configure AD Sync to monitor changes to Hosted Exchange contacts and distribution groups that are created in a
remote domain through Services Manager. You can also disable AD Sync for specific contacts and distribution groups so you
can modify them through the control panel.
When a contact or distribution group is created, an object identifier is assigned automatically. For contacts, the identifier is
the objectGUID. For distribution groups, the identifier is the objectSid. The AD Sync client provides these identifiers to
Services Manager, which uses them to display synchronized items in the control panel. By default, these object identifiers
are stored in extensionAttribute12 on the primary domain. If another application is using extensionAttribute12 to store
other values, you can modify the Sync Object Id setting in the Hosted Exchange service settings to specify a different
extension attribute (Configuration > System Manager > Service Deployment > Hosted Exchange > Service Settings,
Customer category, under Extension Attributes).
To enable synchronization for specific contacts and distribution groups
To configure AD Sync to synchronize contacts and distribution groups, you add the contacts and distribution groups youwant to synchronize to appropriate groups that will be included in the AD Sync client's inclusion f ilter. The AD Sync clientmonitors the Windows Event Log for changes to these items and synchronizes the included groups accordingly.Note: When contacts are added or removed, the AD Sync client does not synchronize these changes automatically as theyare not reflected in the Windown Event Log. To ensure changes to contacts are synchronized, you must force the AD Syncclient to synchronize. For more information, see To force synchronization of changes to contacts in Active Directorygroups.
To disable synchronization for specific contacts and distribution groups
Synchronized items such as contacts and distribution groups are displayed in the control panel as read-only items. If youwant to modify a synchronized contact or distribution group, you disable AD Sync for the item and then remove the itemfrom Active Directory group being synchronized. Disabling AD Sync removes the object identif ier from the item's customattribute and makes the item editable.Important: If you disable AD Sync for a contact or distribution group and make changes through the control panel, thosechanges will be lost if you re-enable AD Sync later.1. From the Services Manager menu bar, click Services > Exchange > Contacts or Distribution Groups.
2. Select the contact or distribution group for which you want to disable synchronization.
3. Click Disable AD Sync and then click Close.
4. On the remote domain controller, launch Active Directory Users and Computers and locate the group that contains the
contacts or distribution groups that are no longer being synchronized.
5. Right-click the group and select Properties.
6. On the Members tab, select the contacts or distribution groups you want to remove and click Remove. Click OK.
To re-enable synchronization for specific contacts and distribution groups
1. In the remote domain, locate the object identif ier for the contact or distribution group.
2. On the primary domain, add the object identif ier to the item's Exchange custom attribute.
3. Add the item to the appropriate group that is included in the IncludeGroups setting in the ADSync.exe.config f ile.
Updated: 2013-04-30The following events at a customer site require changes to AD Sync service configuration:
A change has been made to the administrator account for the external domain controllers
A new contact has been added to or removed from a group that is included in AD Sync operations
To re-configure for a new administrator
If the administrator who installed the AD Sync client is no longer available, the new administrator must uninstall the AD
Sync client from all external domain controllers, re-install the client (which will be associated with the new administrator's
account), and restart the domain controllers. The AD Sync service then restarts using the new administrator's account and
synchronize all users on the remote Active Directory domains to Services Manager.
To force synchronization of changes to contacts in Active Directory groups
When a contact is added to or removed from an Active Directory group, the change is not automatically synchronized with
the AD Sync client. To force a synchronization, change a property in the contact. AD Sync detects the change and updates
the include group in Services Manager.
Note: If the contact is a member of a distribution group that is being synchronized, you do not need to force asynchronization. When the AD Sync client synchronizes the distribution group, the contact will be synchronized as well.
Updated: 2013-02-11Services Manager enables administrators to review the current status of provisioning requests after they have been
submitted to the provisioning engine.
Administrators can view these requests through the Services Manager system or with an RSS feed. Administrators can also
search for a specific request.
Using the Services Manager control panel, administrators can view the following information:The type of provisioning request (e.g., Bulk Request, Object Provision, Object Deprovision, etc.)
The service and customer for whom the request is created
The date on which the request is executed
The subrequests that are executed as part of the provisioning request and their transaction logs
If all subrequests in a provisioning request execute successfully, the request displays a green status indicator. If some
subrequests do not execute successfully, the request displays a yellow triangle status indicator which, later, changes to a
red status indicator.
To view provisioning information through the Services Manager system
1. From the Services Manager menu bar, click Configuration > Provisioning & Debug Tools > Provisioning Requests.
2. To view the transaction logs and subtasks executed in a provisioning request, click the Request Type entry and then
expand the Request Logs or Sub-Requests nodes.
To view provisioning errors with RSS
The Services Manager RSS feed enables administrators to receive notifications whenever a provisioning error occurs.
Because the RSS feed is secured using Windows authentication, an RSS reader that supports digest authentication is
required. You can change the authentication method through IIS, if necessary.
The URL for the RSS feed is http://YourHostHeaderName/cortexdotnet/Rss/CortexProvisioningErrorsRss.aspx.
To search for a specific provisioning request
1. From the Services Manager menu bar, click Configuration > Provisioning & Debug Tools > Provisioning Requests.
2. Under Request Filter, use the following f ilters to refine the list of provisioning requests:
Type displays requests of a specif ic type such as Object Provision.
My Requests and All Requests displays requests that you have created or all requests in the system.
Request Status displays requests of a particular status that have been recorded during the life of the system. For
example, using this f ilter to f ind requests with the Provisioned status displays requests with a green status indicator in
the Status column.
Object Status displays requests where the current status of subrequests matches the status selected.
Note: Using this f ilter to f ind subrequests with the Provisioned status might display some failed provisioning requests
in f iltered results. However, the subrequest itself is not necessarily in a failed state. For example, a provisioning request
to move a customer's user from one Hosted Exchange package to another might fail because the Services Manager
system cannot f ind the mail store for the new package. Although the provisioning request failed, the user is still
To migrate users to different user plans in bulk withthe Package Migration Wizard
Jun 05, 2015
Use the Package Migration Wizard to move multiple users from one user plan to another user plan. When you specify theservice and user plan from which to migrate, Services Manager can automatically select the customers and users whomatch the criteria. If the users you are migrating belong to customers that have not been provisioned with the target userplan, Services Manager can create the required package and complete the migration.This process creates a bulk provisioning request that you can track on the Provisioning Requests page. To make tracking
easier, you can specify a unique name and description for the request.
1. From the Services Manager menu bar, click Configuration > Provisioning & Debug Tools > Package Migration Wizard.
2. Under Wizard Setup, select any of the following wizard options and then click Next:
Select all customers selects for migration all customers with the specif ied source plan.
Select all users selects for migration all users in the Services Manager system with the specif ied source plan.
Generate missing destination packages enables Services Manager to create the target user plan for users belonging
to customers who are not provisioned with the target user plan.
3. Under Service Selection, in Service, select the service containing the user plan from which you want to migrate and then
click Next.
4. Select the user plan from which you want to migrate and click Add selected packages. The selected user plan appears in
a table, in the Source column.
5. From the package table, in the Destination column, select the plan to which you want to migrate and then click Next. A
table displays the customers that match the selected service and source user plans.
6. Ensure the customers you want to migrate are selected and then click Next. The source and destination user plans are
displayed.
7. To verify the appropriate users are selected, perform the following actions:
1. Click the source user plan and then click the customer name.
2. On the Users screen, select or clear the Selected check box as required for any users that you do or do not want
migrated.
3. Click Save and then click Save again to save your changes.
8. Under Request Details, enter a name and description for the provisioning request so it can be easily tracked on the
Provisioning Requests page.
9. Click Finish. Services Manager creates the provisioning request and sends it to the provisioning engine. To view the status
of the request, click Configuration > Provisioning & Debug Tools > Provisioning Requests.
Updated: 2014-08-13With the ShareFile service, you can manage customers' ShareFile accounts through the Services Manager control panel.
Features of the ShareFile service
With the ShareFile service, you can perform the following tasks from within the Services Manager control panel:Onboard customers using their existing ShareFile Enterprise account
Provision and deprovision Employee user accounts directly to ShareFile
Create, modify, and delete folders
Configure folder permissions
Grant users access to specif ic folders, either individually or using groups
Configure users' permissions for specif ic folders
Create, modify, and delete distribution groups
Maintain accurate billing data by synchronizing Services Manager customers and users with ShareFile
How do I deploy the ShareFile service?
Before you deploy the ShareFile service, review the deployment requirements in Plan to deploy the ShareFile service.
Use the following topics to configure and provision the service:1. Configure the ShareFile service
2. Provision the ShareFile service
3. To synchronize ShareFile users with Services Manager
After deploying the ShareFile service, use the following topics to manage folders and maintain and view billing information:Manage ShareFile folders and folder access
Updated: 2014-01-29The ShareFile service includes the following billing reports:
ShareFile Customer: Displays details for all customers provisioned with the ShareFile service.
ShareFile Plan: Displays ShareFile customers and users grouped by plan at the reseller level.
ShareFile Reseller: Displays ShareFile customers and users at the reseller level.
To view these reports, click Reports > View Reports, and then expand ShareFile.
Important: To maintain accurate billing data for customers, ensure the cost and sales price values you configure for theShareFile service are updated in the event of updates to ShareFile's service pricing. Because of limitations in the ShareFileReseller API, Services Manager cannot read summary billing data directly from ShareFile.com. Therefore, you must manuallyverify with ShareFile that the cost and sale price values you have configured in Services Manager remain accurate.
Create and provision additional user and customerplans
Jun 05, 2015
Updated: 2013-02-11When you configure a service for the f irst time, you create the initial user and customer plans that are eventually sold toResellers and customers. However, adding more plans later does not require the same level of configuration that wasrequired during service configuration. After the service is fully configured, you can create additional user or customer plansand:
Enable Resellers to offer additional levels of service to their customers.
Migrate customers’ users to a new user plan using the Package Migration Wizard. For more information about
performing this task, refer to the topic To migrate users to different user plans in bulk with the Package Migration
Wizard in Citrix eDocs.
This topic assumes the following conditions:You have fully configured the services for which you are creating more plans.
You have at least one user plan and one customer plan enabled and available for provisioning.
Use this topic as a guide for creating more plans and making them available to Resellers and customers. For more
information about configuring service-specific settings, consult the service’s configuration instructions in the Deploy
services section of the Services Manager product documentation in Citrix eDocs.
To create additional user plans
1. Create and configure a user plan for the desired service at the Top Environment Level:
1. From the Services Manager menu bar, click Configuration > System Manager > Service Deployment.
2. Under Service Filter (at left), select Top Environment Services and then expand the desired service.
3. Click User Plans, enter a Name for the user plan, and then click Create.
4. Perform any additional configuration required.
5. Click Apply Changes, and then click Save.
2. Enable and configure the user plan at the Location level:
1. Under Service Filter, select Active Directory Location Services, and choose a Location Filter, if applicable.
2. Expand the desired service, click User Plans, and then select the Enabled check box for the new user plan.
3. Expand the new user plan and update applicable settings.
4. Click Apply Changes and then click Save.
3. Provision the user plan to the top Reseller:
1. From the Services Manager menu bar, click Customers > Customer Services. Under Customer Search, enter the name
of the Reseller and click Search. The specif ied customer is selected.
2. Expand the Reseller service and then expand the service for which you added the new user plan.
3. Select the Enabled check box for the new user plan.
4. Click Apply Changes and then click Provision.
4. Repeat Step 3 for any other Resellers in the hierarchy.
5. Provision the user plan to the customer:
1. From the Services Manager menu bar, click Customers > Customer Services. Under Customer Search, enter the name
of the customer and click Search.
2. Expand the desired service and click Advanced Settings.
Updated: 2014-11-20The Hosted Apps and Desktops service for Services Manager delivers applications, desktops, and resources either directly from XenApp farms and XenDesktop sites, or from
farms and sites that are managed by Citrix App Orchestration.
Deploying the Hosted Apps and Desktop service includes the following tasks:Install the Hosted Apps and Desktops web service
Configure the Hosted Apps and Desktops service
Configure Hosted Apps and Desktops offerings
Provision the Hosted Apps and Desktops service
You can install the web service on a XenApp or XenDesktop Controller or on an App Orchestration configuration server using the Services Manager Setup Tool or from the
command line.
For more information about the requirements for deploying the service, review the information in Plan to deploy the Hosted Apps and Desktops service.
To install the Hosted Apps and Desktops web service using the graphical interface
The installation process includes preliminary configuration to create the web service account and IIS application pool, and define the service port.
This task assumes the Services Manager installer is running and the Select Deployment Task page is displayed.
1. On the Select Deployment Task page, select Install CloudPortal Services Manager.
2. On the Install CloudPortal Services Manager page, select Add Services.
3. On the Add Services page, select Install Services.
4. Accept the License Agreement and then click Next.
5. On the Select Web Services page, select one of the following options, depending on the product installed on the server, and then click Next:
If you are installing the web service on a XenApp server, select Hosted Apps and Desktop Web Service (XenApp).
If you are installing the web service on a XenDesktop server, select Hosted Apps and Desktops Web Service (XenDesktop).
If you are preparing an App Orchestration configuration server to work with the Hosted Apps and Desktops service through the control panel, select App Orchestration
Configuration Tool.
6. On the Review Prerequisites page, review the list of software that will be installed to support the component and then click Next. Setup will install any prerequisites that are
not already present.
7. On the Ready to Install page, review your selection and then click Install.
8. After the installation f inishes, click Finish.
9. On the Add Services page, select Configure Services.
10. On the Configure Installed Components page, click Configure next to the component you want to configure.
11. To configure the XenApp or XenDesktop web services, on the Configure IIS page, enter the following information and then click Next:
Auto-generate credentials: Select this check box to allow service account credentials to be generated automatically.
User name: Enter a user name for the web service account. If you installed the web service on a XenApp server, the default user name is csm_xenapp_svc. If you installed
the web service on a XenDesktop server, the default user name is csm_xendesktop_svc. This f ield is unavailable when you elect to auto-generate credentials.
Password: Enter a password for the web service account. This f ield is unavailable when you elect to auto-generate credentials.
Create if doesn't exist: Leave this check box selected to allow the web service account to be created if it does not already exist in Active Directory.
Service port: Enter the port used by the web service. The default port is 8095.
12. To configure the App Orchestration Configuration Tool, perform the following actions:
1. On the Specify Config Server page, enter the following information and then click Next:
Server address: Enter the FQDN of the App Orchestration configuration server if it is not already present. By default, the FQDN of the current server is displayed.
Connect as: Enter the username and password of the orchestration service account used to access the App Orchestration configuration server. By default, the
username of the current logged-in user is displayed in DOMAINusername format.
Click Test Connection to test communication with the App Orchestration configuration server.
2. On the Create Service Account page, enter the following information and then click Next:
Username: Enter a user name for the self-service account for App Orchestration. The default user name is csm_haad_selfsvc. This account is added as an administrator
to the App Orchestration deployment.
Password: Enter a password for the self-service account.
Create if doesn't exist: Leave this checkbox selected to allow the self-service account to be created if it does not already exist in Active Directory.
13. On the Summary page, review the configuration information. If you want to change anything, return to the appropriate configuration page. When the summary contains
the settings you want, click Next. The Configuration Tool configures the web service and displays progress.
14. Click Finish and then click Exit to close the Configuration Tool.
To install the Hosted Apps and Desktops web service from the command line
1. On the server where you are installing the web service, log on as an administrator.
2. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
3. To install the web service component, at the command prompt, enter CortexSetupConsole.exe /Install:component.
The Setup Tool installs the web service and returns the command prompt.
4. To perform preliminary configuration, at the command prompt, enter install-locationServicescomponentConfigurationHostedAppsAndDesltopsConfigConsole.exe and
specify the following properties:
Property Description
/UserName:ctx_svc_acct Valid only when installing the XenApp or XenDesktop component. Username for the web service account . This account must be a
XenApp or XenDesktop administrator.
/Password:password Valid only when installing the XenApp or XenDesktop component. Password for the web service account. This property is optional if
/GenerateCredentials is specif ied.
/SqlServer:server-address Required. Address of the server where the SQL Server database is deployed.
/AutoCreateUser:True|False Valid only when installing the XenApp or XenDesktop component. Optional. Creates the service account in Active Directory, if
required.
/GenerateCredentials:True|False Valid only when installing the XenApp or XenDesktop component. Optional. Generates a password for the service account.
/ServicePort:port Valid only when installing the XenApp or XenDesktop component. Optional. Inbound port to be used/added to the CortexServices
web site. Default = 8095.
/SqlUserName:user-name Optional. SQL Server login username.
/SqlPassword:password Optional. SQL Server login password.
/UseSqlAuthentication:True|False Optional. Enables or disables use of SQL authentication mode.
Install-location is the installation directory on the local computer. The default directory is C:Program Files (x86)CitrixCortex.
The Configuration Tool performs initial configuration of the web service and returns the command prompt.
Sample command strings
The following commands install and initially configure of the XenDesktop component of the Hosted Apps and Desktops web service. The default port (8095) will be used.CortexSetupConsole.exe /Install:CsmXenDesktopWSinstall-locationServicesCsmXenDesktopWSConfiguration HostedAppsAndDesktopsConfigConsole.exe /UserName:ctx_svc_acct /Password:password /SqlServer:server-address
Updated: 2014-03-20Configure 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.
Important: If you have an earlier version of the Hosted Apps and Desktops service installed, you must remove it beforeimporting the new version's service package. For instructions, see If you have an earlier version of the service installed.
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 f ile. Click Open.
4. Click Preview. Services Manager displays the contents of the f ile for your review.
5. Click Import at the bottom of the page. Services Manager imports the f ile 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. Under Service Filter, select Top Environment Services.
2. 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 and, if applicable, specify the App Orchestration datacenter:
1. Under Service Filter, select Active Directory Location Services and choose a Location Filter, if applicable.
2. Expand Hosted Apps and Desktops, click Service Settings. and then expand App Orchestration.
3. 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.
4. 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 Qualif ied 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.
Updated: 2013-07-11The SharePoint 2010 web service is installed on a SharePoint 2010 server in your environment. You can install the SharePoint web service using either the
graphical interface of the Services Manager installer or through the command line. After the installation process finishes, you can enable the service and
continue configuration through the control panel.
To install the SharePoint web service using the graphical interface
The installation process creates the IIS web service, updates the web application settings, and enables PowerShell remoting.
This task assumes the Services Manager installer is running and the Select Deployment Task page is displayed.
1. On the Select Deployment Task page, select Add Services & Locations.
2. On the Add Services & Locations page, select Install Services.
3. Accept the License Agreement and then click Next.
4. On the Select Web Services page, select SharePoint 2010 Web Service and then click Next.
5. On the Ready to Install page, review your selection and then click Install.
6. After the installation f inishes, click Finish.
7. On the Installed Services page, click Configure next to the SharePoint 2010 Web Service list item.
8. On the Configure Service Details page, enter the following information and then click Next:
Auto-generate credentials: Select this check box to allow the Configuration Tool to generate service account credentials automatically.
User name: Enter a user name for the Citrix web service account. The default user name is csm_sharepoint_svc. This f ield is unavailable when you
elect to auto-generate credentials.
Password: Enter a password for the SharePoint web service account. This f ield is unavailable when you elect to auto-generate credentials.
Create if doesn't exist: Leave this check box selected to allow the web service account to be created if it does not already exist in Active Directory.
Service port: Enter the port used by the SharePoint web service. The default port is 8095.
9. On the Specify Remoting Credentials page, enter the Username and Password of an account with PowerShell remoting permissions and then click
Next. The default account username is csm_sharepoint_rem.
10. On the Summary page, click Next. The Configuration Tool configures the SharePoint web service and displays progress.
11. Click Finish and then click Exit to close the Configuration Tool.
To install the SharePoint web service from the command line
1. On the SharePoint 2010 server, log on as an administrator.
2. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
3. At the command prompt, enter CortexSetupConsole.exe /Install:SharePoint2010. The Setup Tool installs the web service and returns the command
prompt.
4. At the command prompt, enter install-locationServicesSharePoint2010WSConfigurationSharePointConfigConsole.exe and specify the following
properties:
Property Description
/UserName:username The application pool ID. Usually, this is SharePoint Admin User. This parameter is optional if you are using
/GenerateCredentials.
/Password:password The application pool password. This parameter is optional if you are using /GenerateCredentials.
/ServicePort:port Inbound port to be used and added to the CortexServices web site. Default = 8095
/AutoCreateUser:True | False Optional. Create the service account in Active Directory.
/GenerateCredentials:True |
False
Optional. Generate the password for the service account.
Install-location denotes the web service installation directory on the local computer. The default directory is C:Program Files (x86)CitrixCortex.
The Configuration Tool performs initial configuration of the web service and returns the command prompt.
Sample command string
The following command performs the initial configuration of the web service.install-locationServicesSharePoint2010WSConfigurationSharePointConfigConsole.exe /UserName:shpt_svc_acct /Password:password /ServicePort:8095
When the installation process is finished, log on to the control panel and configure the web service. For instructions, see Configure the SharePoint 2010
this proxy group. This step can take several minutes to complete.
5. Under Site Subscription, complete the settings, and then click Create. The site subscription tenant service starts. This
step can take several minutes to complete.
3. To import web templates from a farm: From the SharePoint 2010 Farm Configuration page, click Retrieve Web
Templates. After web templates are stored in the Services Manager database, they can be assigned to a SharePoint site
during customer provisioning.
To add and configure SharePoint feature packs
A SharePoint feature pack is a collection of SharePoint features. The Services Manager displays the feature packs
configured on a SharePoint farm and enables you to create new feature packs from a list of the features installed on the
SharePoint server.
1. From the Services Manager menu bar, choose Services > SharePoint 2010 > Feature Packs, choose a Location and Farm,
and then click Retrieve Feature Packs.
2. To add a feature pack, click New Feature Pack, enter a user-friendly Name, and add the features for the feature pack.
You can add the features individually or click a default feature pack (such as foundation or enterprise). The Name is
visible to customers during resource configuration. After a feature pack is added, it can be configured for a customer
account.
To enable DNS for the SharePoint 2010 service
Before you enable DNS for the SharePoint 2010 service and configure DNS provisioning, the DNS service must be enabledand configured.Important: The SharePoint 2010 service enables you to manage only one DNS record type at a time for SharePoint sites.Do not change the DNS record type after SharePoint sites have been created. Changing the DNS record type can result induplicate DNS records being created for each site.1. Enable DNS for the SharePoint 2010 service:
1. From the Services Manager menu bar, select Configuration > System Manager > Service Deployment.
2. Under Service Filter, select Active Directory Location Services and choose a Location Filter, if applicable.
3. Expand SharePoint 2010 and then click Service Settings.
4. In DNS Record Type, select A Record or CNAME Record for the SharePoint server as appropriate.
5. Click Save.
2. Enable DNS provisioning:
1. From the Services Manager bar, Configuration > System Manager > Servers.
2. Select the SharePoint server from the server list and perform one of the following actions:
To enable A Record provisioning, in External IP Address, enter the IP address of the SharePoint server.
To enable CNAME Record provisioning, in External Name, enter the FQDN of the SharePoint server.
Provision the SharePoint 2010 service to customers
Jun 05, 2015
Before provisioning the SharePoint 2010 service to a customer, at least one SharePoint Farm and Feature Pack must be
configured and assigned to the customer. When provisioning a customer, you can specify multiple, different farms with
companion feature packs. However, you cannot specify multiple instances of the same farm.
Customers are configured with SharePoint Feature Packs that determine the functionality that is available to provisioned
users.
A standard SharePoint installation includes 12 preconfigured customer plans. These plans determine how the site isconfigured and saved on the SharePoint 2010 server. Service providers configure the availability of the following templateswhen they provision the service to customers. All templates support SSL authentication.Customer Site
This site is attached to a Web application that is configured specif ically for the customer. If additional sites are configured
with the same package, these sites are assigned to the same Web application. This site uses a dedicated content database.
Additionally, a separate Customer site template is available that includes anonymous authentication.
Shared Site
This site is attached to a shared Web application where other customers' SharePoint sites reside. This site uses a dedicated
content database. Additionally, a separate Shared site template is available that includes anonymous authentication.
Dedicated Site
This site is attached to its own Web application. No other SharePoint sites are configure for the Web application pool
unless the Web application is manually overridden with the Web application's name. This site uses a dedicated content
database. Additionally, a separate Dedicated site template is available that includes anonymous authentication.
1. From the Services Manager menu bar, click Customers > Customer Services.
2. In Customer Search, f ind the customer for whom you want to provision SharePoint 2010.
3. In the services list, click SharePoint 2010 configure resources. The Service Setup page appears.
4. In the SharePoint Farm table, click Add and select the farms and companion feature packs to allocate to the customer.
5. Click Update to save your selections.
6. Click Save to save the resource configuration.
7. In the services list, click SharePoint 2010 create an instance. The SharePoint 2010 Service Instance page appears.
8. Type an instance name that contains no spaces or special characters and click Create. The Instance Setup page appears.
9. Under Service Plan Configuration, in Customer Plan, select the settings package to use for the site. To customize the
template, click Edit and make the appropriate changes. When you are f inished, click Apply Changes.
10. Under Site Administrators, enter the user names for the users granted full administration rights to the site. These users
must be members of the customer's organizational unit in Active Directory.
11. In Site Template, select the SharePoint site template with which to create the site.
Note: If no template is selected, no template is configured when the site is provisioned. The Site Administrator must
access the SharePoint site directly to configure the site template and security groups manually before users can access
the site.
12. In Site Name, enter the host header for the site.
13. Click Advanced Settings and perform the following actions:
1. In Maximum Users, select the Enabled check box and enter the total number of users the customer can provision to
/UserRoleName:name The SCVMM user role under which the service operates. Default = CSM_SelfServiceUser. This
parameter is optional if you have set /SkipUserRoleCreation to True.
/VMHostGroups:host-
groups
A comma-delimited list of host groups to add to the SCVMM scope. This parameter is optional
if you have set /SkipUserRoleCreation to True.
/VMMServer:address:port Default = localhost
Property Description
Install-location denotes the web service installation directory on the local computer. The default directory is C:Program Files
(x86)CitrixCortex.
The Configuration Tool performs initial configuration of the web service and returns the command prompt.
Sample command string
The following command performs initial configuration of the web service:install-locationServicesCitrixWSConfigurationVMConfigConsole.exe /UserName:vm_svc_acct /Password:password /ServicePort:8095
When the installation process is finished, log on to the control panel and configure the web service. For instructions, see Configure
Updated: 2013-02-11Checkpoints capture the state of a virtual machine at a certain moment in time. You can then use the checkpoint torestore the virtual machine to the state it was in when the checkpoint was created.
To create a checkpoint
1. From the Services Manager menu bar, click Services > Virtual Machine > Virtual Machines.
2. Select the virtual machine for which you want to create a checkpoint.
3. On the Checkpoints tab, in the Checkpoint Management table, click Add. A blank text box appears in the Name column.
4. Type the name of the checkpoint and then click Update.
To restore a virtual machine to a previous state
1. From the Services Manager menu bar, click Services > Virtual Machine > Virtual Machines.
2. Select the virtual machine whose state you want to restore.
3. On the Checkpoints tab, select the checkpoint you want to use.
4. Click Restore. The restore request is sent to the host machine. To view the progress of the restore, click the Status tab.
The Most Recent Task section displays the progress of each task the host machine processes.
Updated: 2013-08-16CloudPortal Services Manager 11.0 supports in-place upgrading from CloudPortal Services Manager 10.Important: Review all the information in this topic and in Upgrade deprecated services, which contains information aboutservices that are not supported in Services Manager 11. If your Services Manager 10 deployment includes any deprecatedservices, you must prepare your deployment accordingly prior to upgrading any web components.
Prepare for upgrading your deployment
Upgrading your Services Manager 10 deployment to Services Manager 11 involves several steps that you perform insequence. To prepare your deployment for upgrading, perform the following tasks:1. Disable all locations in your deployment by stopping the Directory Web Service, Provisioning Engine, and Web platform
components.
2. Back up all Services Manager databases (OLM, OLMReports, OLMReporting).
Perform the upgrade
After you have completed the preparation steps, you can perform the upgrade. The following table lists the required stepsand the instructions for performing them. Perform these steps in the order shown.
Step#
To perform this task... ...refer to this topic.
1. Upgrade the system databases Upgrade system databases
2. Upgrade and reconfigure platform server roles Upgrade platform server roles
3. Upgrade and reconfigure web services in use Upgrade web components
4. If required, upgrade or remove deprecated services Upgrade deprecated services
5. Upgrade the Reporting service and migrate the datawarehouse
Upgrade the Reporting service and datawarehouse
Complete the upgrade
After you have finished all the upgrade steps, re-enable all locations in your deployment by starting the Directory Web
Service, Provisioning Engine, and Web platform components.
Updated: 2013-08-16Before upgrading the system databases, ensure you have backed up all databases in your Services Manager deployment:OLM, OLMReports, and OLMReportingImportant: The upgrade process makes irreversible changes to these databases. Creating backups ensures you can recoverand restart the upgrade process in the event of a failure.This topic provides instructions for upgrading the system databases in CloudPortal Services Manager 10 to system
databases compatible with Services Manager 11.
You can perform this upgrade on the database server for the primary location or on a server that can connect to the
database server. When you perform the upgrade, the Configuration Tool deploys a set of SQL scripts that are included on
the Services Manager installation media. These scripts prepare the system databases for upgrading the other Services
Manager components. Therefore, you must upgrade the system databases before you upgrade any other component.
To upgrade the system databases using the graphical interface
1. From the installation media, double-click setup.exe and click Get Started.
2. On the Select Deployment Task page, select Upgrade Existing Deployment.
3. On the Upgrade Existing Deployment page, select Upgrade System Databases and then click Install.
4. When prompted, accept the End User Licensing Agreement and then click Next.
5. Click Install. The Setup Tool installs the Configuration Tool and displays progress.
6. Click Finish to continue with the upgrade process.
7. On the Specify Primary Database Settings page, perform the following actions and then click Next:
1. Enter the following database details for the primary location:
In Server address, specify the database server for the primary location using the DNS alias, IP address, or FQDN.
In Server Port, select Use specif ic port and enter the port number used by the SQL Server. The port for the default
instance of SQL Server is 1433.
In Authentication Mode, select whether to use Integrated (Windows) or SQL authentication. By default,
Integrated is selected.
In Connect as, specify the username and password of the SQL administrator user. These f ields are available when
select the SQL authentication mode.
2. Click Test Connection to ensure the Configuration Tool can contact the SQL Server.
8. On the Confirm Databases Are Backed Up page, select This step has been completed and then click Next.
9. On the Summary page, review the database configuration information. If you want to change anything, click Back to
return to the appropriate configuration page.
10. Click Commit. The Configuration Tool launches the database upgrade scripts and displays the upgrade progress.
11. When the upgrade is completed, click Finish. The Configuration Tool returns you to the Upgrade Existing Deployment
page.
To upgrade the system databases using the command line
Open the Command Prompt window and enter the following command:CortexConfigConsole.exe /Upgrade:Databases /Legacy
The Configuration Tool launches the upgrade database scripts that perform the upgrade. When the upgrade is completed,
Note: If your deployment of CloudPortal Services Manager 10 includes customizations, be aware that you might need toupdate these customizations manually when you upgrade to CloudPortal Services Manager 11. For example, you mightneed to update custom stylesheets to accommodate changes in the site structure.For instructions to upgrade the platform server roles, see Upgrade platform server roles using the graphical interface or
Upgrade platform server roles using the graphicalinterface or command line
Jun 05, 2015
Updated: 2014-02-04Use this topic to upgrade Services Manager platform servers from Services Manager 10 to Services Manager 11. Perform theupgrade on the servers hosting the following platform components:
Directory Web Service
Provisioning
Report Mailer
Web
The upgrade process involves the following tasks:Upgrade the platform roles installed on each server in your deployment.
Reconfigure each role to f inalize the upgrade.
To upgrade platform server roles using the graphical interface
1. From the installation media, double-click setup.exe and click Get Started.
2. On the Select Deployment Task page, select Upgrade Existing Deployment.
3. On the Upgrade Existing Deployment page, select Upgrade Roles and Services. The Setup Tool verif ies the database
version. If the correct database version is not detected, the Setup Tool prompts you to manually verify the version and
click Next.
4. When prompted, accept the End User Licensing Agreement and then click Next.
5. On the Select Components page, select the components you want to upgrade. By default, installed components for
which upgrades are available are selected.
6. On the Ready to upgrade page, click Upgrade. The Setup Tool installs the Configuration Tool, upgrades the selected
roles or services, and displays progress.
7. On the Upgrade Complete page, click Finish.
8. From the Upgrade Existing Deployment page, select Re-configure Upgraded Roles and Services.
9. On the Re-configure Upgraded Components page, select the component you want to reconfigure and click Finish
Upgrade.
10. Use the following table to configure the settings for each server role:
Role Page Description
Directory
Web
Service
No configuration needed. Proceed to Step 11.
Provisioning No configuration needed. Proceed to Step 11.
Review the service components that will be imported when the Web server role is
configured. Other service components, such as reports, are imported when the
Reporting service is reconfigured.
Role Page Description
11. On the Summary page, click Commit.
12. When the reconfiguration is complete, click Finish.
13. Repeat Steps 1-12 for each server role you want to upgrade.
To upgrade platform server roles using the command line
To upgrade platform components, you perform the following tasks:Upgrade the platform server roles using the Setup Tool
Reconfigure the platform server roles using the Configuration Tool
When running the Setup and Configuration Tools, use the following role names to specify the platform server roles youwant to upgrade:
Provisioning
DirectoryWebService
Web
ReportMailer
1. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
2. At the command prompt, enter CortexSetupConsole.exe /Install:role-name /Upgrade /Legacy. To specify multiple
components, use a comma-delimited list. The Setup Tool upgrades the specif ied role and returns the command prompt.
3. At the command prompt, enter CortexConfigConsole.exe /Upgrade:role-name /Legacy. The Configuration Tool
reconfigures the specif ied role and returns the command prompt.
Example
The following command upgrades the Provisioning server and Directory Web Service.CortexSetupConsole.exe /Install:Provisioning,DirectoryWebService /Upgrade /Legacy
After upgrading the platform server roles, continue the upgrade process by upgrading Services Manager web services. For
more information, refer to the topic Upgrade web components.
Updated: 2013-08-16This topic describes the upgrade process of web components from Services Manager 10 to Services Manager 11. For upgrades, the term web components refers to the control panel web site, the APIservice, and all supported web services.Important: In addition to this section, review the topic Upgrade deprecated services, which contains information about services that are not supported in Services Manager 11. If your ServicesManager 10 deployment includes any deprecated services, you must prepare your deployment accordingly prior to upgrading any web components.
During the upgrade process, the Services Manager Setup Tool updates all sites to run from the backup and puts all associated sites and application pools in a stopped state. Therefore, if the namesof any of the sites or application pools in your deployment have been changed from the default, you must specify those changes in an XML f ile before you initiate the upgrade. To create this f ile, usethe following format:<Configuration> <Property Name="<service-id>.ApplicationPool" Value="MyAppPool" /> <Property Name="<service-id>.Application" Value="MyAppName" /> <Property Name="<service-id>.Site" Value="MySite" /> </Configuration>
The service-id property is the web service's deployment identifier used in the Configuration Tool.
After creating the XML f ile, you can initiate the upgrade using the following command:CortexSetup.exe /ConfigFile:path-to-XML-file /Upgrade
When you upgrade the web components, the Configuration Tool performs the following tasks:1. Stop the site and applicable web services in IIS.
2. Back up the site. The default f ile path for this backup is %ProgramData%CitrixCloudPortal Services Manager SetupBackupsLegacycomponent-name.
3. Update physical paths in IIS to point to the site backup.
4. Update the site f iles in the %ProgramFiles% directory.
5. Copy updated site f iles from %ProgramFiles% to C:Inetpubsite-name.
6. Restore customer content from site backup (for example, downloads, images, stylesheets, or scripts).
7. Restore web.config f ile from site backup and apply updates.
8. Update physical paths in IIS.
9. Restart site in IIS.
In the event a conflict arises during the upgrade, the sites remain in a stopped state and reference the backup created earlier in the process. Site files in the %ProgramFiles% directory are updated and
site content in C:Inetpubcomponent-name are reverted to the previous version. You can then review the configuration update file located in %ProgramFiles% and make any necessary changes to the
deployed web.config file.
For instructions to upgrade web components, see Upgrade web services using the graphical interface or command line.
Upgrade web services using the graphical interface orcommand line
Jun 05, 2015
Updated: 2013-08-16Use this task to upgrade Services Manager web services from Services Manager 10 to Services Manager 11. Perform thistask on the servers hosting the following components:
Citrix
Hosted Exchange
Lync
Lync Hosted
MySQL
SharePoint 2010
Virtual Machine
Windows Web Hosting
Important: Services Manager 11 does not support several services that were supported by Services Manager 10. Beforeupgrading any web services, refer to Upgrade deprecated services for a list of deprecated services and additional upgradeinformation.The upgrade process involves the following tasks:
Upgrade the web services installed on each server in your deployment
Reconfigure the web services to f inalize the upgrade
1. From the installation media, double-click setup.exe and click Get Started.
2. On the Select Deployment Task page, select Upgrade Existing Deployment.
3. On the Upgrade Existing Deployment page, select Upgrade Roles and Services. The Setup Tool verif ies the database
version. If the correct database version is not detected, the Setup Tool prompts you to manually verify that the system
databases have been upgraded and click Next.
4. When prompted, accept the End User Licensing Agreement and then click Next.
5. On the Select Components page, select the components you want to upgrade.
6. On the Ready to upgrade page, click Upgrade. The Setup Tool installs the Configuration Tool, upgrades the selected
roles or services, and displays progress.
7. On the Upgrade Complete page, click Finish.
8. From the Upgrade Existing Deployment page, select Re-configure Upgraded Roles and Services.
9. On the Summary page, review the settings that will be reconfigured and click Next. The Configuration Tool restores and
upgrades the IIS site for the web service, and displays progress.
10. When the reconfiguration is complete, click Finish and then click Exit.
When running the Setup and Configuration Tools, use the following information to specify the web service you want toupgrade and the location of its configuration console:
Web service nameWeb service name Conf igurat ion console locat ionConf igurat ion console locat ion
Updated: 2014-01-13In-place upgrade of services that come with Services Manager 11 is supported by default. However, some services thatwere supported in CloudPortal Services Manager 10.0 have been deprecated or support for specif ic product versions hasbeen removed in Version 11. The following table describes the affected services:
Service nameService name Support ed inSupport ed inVersion 11.0Version 11.0
Upgrade pat hUpgrade pat h
BlackBerry 4 Not supported None. See the section "Upgrade overview."
BroadWorks
CRM 4
SharePoint 3 (WSS 3.0)
Hosted Exchange Multi-tenanted (for Exchange2010 SP1 in /hosting mode)
Not supported See the section "Upgrade process for HostedExchange Multi-tenanted."
Hosted Exchange Exchange 2003not supported
See the section "Upgrade process for HostedExchange."
Windows Web Hosting IIS 6 notsupported
See the section "Upgrade process forWindows Web Hosting."
The upgrade process for a Services Manager 10 deployment that includes deprecated services is similar to the overviewdescribed in Upgrade from CloudPortal Services Manager 10. However, when upgrading web components, the ConfigurationTool detects whether or not a deprecated service is present in the deployment. If a deprecated service is detected, theConfiguration Tool performs one of the following actions:
Informs you of any additional actions that are required before the upgrade process can be completed. This action
applies to Hosted Exchange, Hosted Exchange Multi-tenanted, and Windows Web Hosting. Refer to the sections in this
topic for information about upgrading these services.
Notif ies you that the service and all service-related data will be removed from the Services Manager deployment. No
Active Directory data is modif ied or removed. This action applies to BlackBerry 4, BroadWorks, CRM 4, Hosted Exchange
Multi-tenanted, and SharePoint 3.
Note: Removing all service-related data can take time, depending on the size of the deployment. During upgrading, the
Configuration Tool displays the progress of data removal. Do not close the Configuration Tool during this process.
After all web components are upgraded successfully, you can upgrade the Reporting service and migrate the data
warehouse, as described in Upgrade the Reporting service and data warehouse. Historic billing data is retained and no new
billing data is processed for services that have been removed.
When upgrading the Hosted Exchange service, the Configuration Tool checks the version of Exchange deployed for the
service. If Exchange 2003 is detected, the Configuration Tool checks for any existing server connections and user plans. If
these items are detected, the Configuration Tool halts upgrading and advises you to remove these items.
If your Services Manager deployment uses Exchange 2003 with the Hosted Exchange service, you need to migrate the
Exchange 2003 users to a version of Exchange that Services Manager 11 supports, prior to upgrading. You can do this using
the service migration tool in Services Manager 10.
Afterward, you can run the Configuration Tool to upgrade web components, as described in Upgrade web components.
Note: In Services Manager 10, the Hosted Exchange Multi-tenanted service supports installations of Exchange 2010 SP1 in/hosting mode. Services Manager 11 does not include this service due to changes in Microsoft's recommendations forachieving multi-tenancy with Exchange 2010. For more information about these changes, see the article "Multi-TenantSupport" on the Microsoft TechNet web site.When upgrading the web components in a Services Manager 10 deployment, the Configuration Tool checks for any
deprecated services. If the Hosted Exchange Multi-tenanted service is detected, the Configuration Tool halts upgrading
and advises you to migrate your users to a supported version of Exchange.
Because the Active Directory structure supporting the Hosted Exchange Multi-tenanted service is incompatible with
Services Manager 11 (which supports only the Hosted Exchange service), the Active Directory structure must be transitioned
to one that supports the Hosted Exchange service prior to upgrading. If your Services Manager deployment uses the
Hosted Exchange Multi-tenanted service, Citrix recommends you contact Microsoft Support for assistance with this
transition.
After the transition, you can run the Configuration Tool to upgrade the service. When launched, the Configuration Tool
detects the presence of the Hosted Exchange Multi-tenanted service and removes it, along with all service-related data.
However, no Active Directory data is modified or removed.
When upgrading the Windows Web Hosting service, the Configuration Tool checks the version IIS deployed for the service.
If IIS 6 is detected, the Configuration Tool checks for existing server connections and customer plans. If these items are
detected, the Configuration Tool halts upgrading and advises you to migrate your customers.
If your Services Manager deployment uses IIS 6 with the Windows Web Hosting service, Citrix recommends you contact
Citrix Support for assistance with migrating your customers to Windows Web Hosting using IIS 7.
Updated: 2013-08-16Migrating the data warehouse uses the public API of the Data Warehouse service and a Data Transfer configuration file to
update the required schema in the OLMReporting database and reprocess historical data. This process might run for an
extended period of time due to data reprocessing. You can monitor this process through the Data Warehouse logs located
at %PROGRAMDATA%CitrixCloudPortal Services Manager SetupLogsData Warehouse Migrationtimestamp.log. Additionally,
the %PROGRAMFILES%CitrixCortexData Warehouse Servicelog folder contains logs of errors that occur while upgrading
the OLMReporting database schema and data to the Version 11 format.
To initiate the upgrade, you can use the Services Manager graphical interface or the command line.Important: The user initiating the upgrade must be logged on as a domain administrator. When migrating the DataWarehouse, do not initiate any data transfers.When you upgrade the Reporting service, the Configuration Tool performs the following tasks:1. Back up Services Manager 10 config.xml f ile, report definitions, and data sources.
2. Upgrade product f iles for the Reporting service.
3. Finalize the upgrade and start the new Data Warehouse service.
After the Configuration Tool completes these tasks, you can migrate the data warehouse. During the migration process,the DataWarehouseMigrator.exe command-line utility performs the following tasks:1. Import new reporting configuration and report definitions for enabled services.
2. Migrate the OLMReporting database and generate the required configuration f iles.
After the DataWarehouseMigrator.exe utility is f inished running, you manually restore any reporting customizations. Forexample:1. Redeploy any custom views or stored procedures to accommodate schema changes.
2. Migrate any custom commands in the Version 10 config.xml f ile to the Version 11 config.xml f ile to accommodate
schema changes.
3. Redeploy any report definition customizations.
For instructions to upgrade the Reporting service and migrate the data warehouse, see Upgrade the Reporting service and
Upgrade the Reporting service and migrate the data warehouse
Jun 05, 2015
Updated: 2014-08-18Upgrading the Reporting service involves the following tasks:
Upgrade and reconfigure the Reporting service. This includes backing up the config.xml f ile, RDL f iles, and data sources. The config.xml f ile is located at
%PROGRAMFILES%CitrixCortexData WarehouseData Transferconfig. You can f ind the RDL f iles and data sources through the Report Manager web site for SQL Server Reporting
Services. If the reporting definitions and data sources have been moved to another location, you must back up these components manually.
Migrate the data warehouse. This includes importing new reporting configuration and report definitions for enabled services, migrating the OLMReporting database, and generating the
required configuration f iles.
Note: The migration process might run for an extended period of time due to data reprocessing. You can monitor this process through the Data Warehouse logs located at
%PROGRAMDATA%CitrixCloudPortal Services Manager SetupLogsData Warehouse Migrationtimestamp.log. Additionally, the %PROGRAMFILES%CitrixCortexData Warehouse
Servicelog folder contains logs of errors that occur while upgrading the OLMReporting database schema and data to the Version 11 format.
The user performing the upgrade must be logged on as a domain administrator.
1. From the installation media, double-click setup.exe and click Get Started.
2. On the Select Deployment Task page, select Upgrade Existing Deployment.
3. On the Upgrade Existing Deployment page, select Upgrade Roles and Services. The Setup Tool verif ies the database version. If the correct database version is not detected, the Setup
Tool prompts you to manually verify the version and click Next.
4. When prompted, accept the End User Licensing Agreement and then click Next.
5. On the Select Components page, select Reporting. By default, installed components for which upgrades are available are selected.
6. On the Ready to upgrade page, click Upgrade. The Setup Tool installs the Configuration Tool, upgrades the selected components, and displays progress.
7. On the Upgrade Complete page, click Finish.
8. From the Upgrade Existing Deployment page, select Re-configure Upgraded Roles and Services.
9. On the Re-configure Upgraded Components page, click Finish Upgrade for each component you want to reconfigure.
10. Use the following table to configure the settings for each server role:
RoleRole PagePage Descript ionDescript ion
Report
Mailer
No action needed. Proceed to Step 11.
Reporting Preview Service
Package Import
Review the service components that will be imported when the Reporting service is reconfigured. By default, only the Reporting service
components are selected. Other components, such as roles and assemblies, are imported when the Web server role is configured.
Enter Data Transfer
Connection
Credentials
Configure the following settings:
Under Source Connection, enter the password for the OLMUser account.
Under Destination Connection, enter the password for the OLMReportingUser account.
Data Transfer Service Auto-generate credentials: Select this option to create the service account with auto-generated credentials. Leave this option cleared to
specify your own credentials for this account.
User name: Enter a unique user name for the service account. The default user name is csm_dataw_svc.
Password: Enter a password for this account that conforms to your domain's password policy. This f ield is not available if you elect to auto-
generate credentials.
Create if doesn't exist: Leave this option selected to create the service account if it does not already exist. If you elect to create this
account manually prior to configuring the server role, clear this option. This option is not available if you elect to auto-generate credentials.
Service port: Specify the port that the service will use. The default port is 80.
Data purge window (months): Select Configure and then specify the number of months after which older historical data is deleted. For
example, specify 84 to delete data that is older than seven years.
11. On the Summary page, click Commit.
12. When the reconfiguration is complete, click Finish.
1. From the installation media, double-click setup.exe and click Get Started.
2. On the Select Deployment Task page, select Upgrade Existing Deployment.
3. On the Upgrade Existing Deployment page, select Start Data Warehouse Migration.
4. On the Start Data Warehouse Migration page, click Start Migration. The Setup Tool launches the migration process. To monitor progress, click Refresh.
5. When the migration is f inished, click Exit.
After the upgrade and migration are complete, you can manually restore any reporting customizations. For example:1. Redeploy any custom views or stored procedures to accommodate schema changes.
2. Migrate any custom commands in the Version 10 config.xml f ile to the Version 11 config.xml f ile to accommodate schema changes.
1. Open a command line window and navigate to the CortexSetup directory on the Services Manager installation media.
2. At the command prompt, enter CortexSetup.exe /Upgrade:Reporting /Legacy. The Setup Tool upgrades the Reporting service and returns the command prompt.
3. At the command prompt, enter CortexConfigConsole.exe /Upgrade:Reporting /Legacy and specify the following properties:
Propert yPropert y Descript ionDescript ion
/OlmPassword The password for the OLM database.
/OlmReportingPassword The password for the OLMReporting database.
/DwsUserName The user name for the data warehouse service account.
/DwsPassword The password for the data warehouse service account.
/AutoCreateDwsUser:True|False Optional. Create the data warehouse user account. Default = True
/DwsServer:hostname Optional. The hostname of the server hosting the data warehouse. Default = the name of the local computer
/DwsPort:port Optional. Inbound port to be used with the data warehouse. Default = 8095
/PackageFolder:path-to-service-
packages
Optional. The location of the Services folder on the Services Manager installation media, which contains the service packages.
/IgnoreErrors:True|False Optional. Whether or not to ignore service import errors. Default = True
/PurgeAgeInMonths Optional. The number of months after which older historical data is deleted. For example, specify 84 to delete data that is older than
seven years.
Sample command strings
The following command reconfigures the Reporting service and migrates the data warehouse.CortexConfigConsole.exe /Upgrade:Reporting /Legacy /OlmPassword:password /OlmReportingPassword:password /DwsUserName:user-name /DwsPassword:password /IgnoreErrors:False
Updated: 2013-05-11A security role is a set of permissions that defines customer, administrator, and user access to specific tasks in the services
manager. For example, the first or default user created for a customer is a customer administrator. The customer
administrator is automatically assigned the Customer Administrator security role (and can also be assigned other security
roles). The customer administrator can then assign one or more security roles to users in the customer hierarchy. A security
role can also consist of multiple security roles; for example, the My Account and Services Management role consists of the
My Account Management and My Services Management roles.
Services Manager includes a default set of security roles. A service provider can manage security roles associated with:Customer, user, and service tasks
User services
Reports and reporting
Dialog boxes, menus, or pages in the control panel
This topic lists the default security roles available and describes how to:Create or copy security roles
Export and import security roles, enabling you to design, test, and configure a customized role before implementing it in a
Role Permissions: Customers, Services, User Services,Users
Jun 05, 2015
Updated: 2013-05-11This topic describes the settings used for defining a security role's access to customers, services, and users in the control
panel. These settings appear in the Role Permissions section of the Role Management screen. To access the Role
Management screen, select Configuration > Security > Security Roles and then create or select the security role you want
to configure.
For information about role settings for accessing menus, pages, and reports, see Role Permissions: Menus, Pages, Reports.
On the Customer, Services, User Services, and Users tabs, you can expand certain permissions and apply more detailed
permissions. For example, on the Customers tab, you can expand the Read permission and select additional permissions such
as Name, Contact Detail, and Billing Identifier. On the Services and User Services tabs only, you can use the Filter drop-down
list to apply selected permissions to a specific service or to all services in your deployment.
You set permissions for each function by clicking the Access selector next to the function. The Access selector changes todenote one of the following permission levels:
AccessAccessT ypeT ype
AccessAccessselect orselect orsymbolsymbol
Access descript ionAccess descript ion
Noneselected
No access to the function.
Customer The function is permitted for the selected customer. For example, the User Servicespermissions of Read, Update, and Provision for the My Services Management security role areset as Customer. This setting indicates that the administrator user with the My ServicesManagement role can perform that function on its customer only.
SubCustomer
The function is permitted for the subcustomer of the selected customer. For example, if theUser Services permissions of Read, Update, and Provision for a security role are set as SubCustomer, users with this role can perform the function on the customer's subcustomer (butnot on the customer).
Customerand SubCustomer
The function is permitted for the selected customer and related subcustomer(s). For example,if the User Services permissions of Read, Update, and Provision for a security role are set toCustomer and Sub Customer, users with this role can perform the function on the customerand its subcustomer(s).
After you finish modifying the security role, click Save.
Available Funct ionAvailable Funct ion Cust omersCust omers ServicesServices User ServicesUser Services UsersUsers
Updated: 2013-05-11This topic describes the settings used for defining a security role's access to menus, pages, and reports in the control panel.
These settings appear in the Role Permissions section of the Role Management screen. To access the Role Management
screen, select Configuration > Security > Security Roles and then create or select the security role you want to configure.
For information about role settings for accessing customers, services, and users, see Role Permissions: Customers, Services,
User Services, Users.
To permit a security role to access specif ic menus, pages, or reports, you select the appropriate check box. To deny access,clear the appropriate check box.Note: When granting access to submenus, you must also enable access to all parent menus. If you do not enable access tothe parent menus, the submenu item is not visible to applicable users when they are logged on to the control panel. Forexample, if you enable access to the Customer Brand submenu item, but do not enable access to Customers, Configuration,and Branding, the Customer Brand menu item does not appear in the menu bar to applicable users.After you have finished modifying the security role, click Save.
T op-level MenuT op-level Menu Second-level SubmenusSecond-level Submenus T hird-level SubmenusT hird-level Submenus Fourt h-levelFourt h-levelSubmenusSubmenus
Updated: 2014-01-06Services Manager includes a default set of security roles. The default roles cannot be deleted or modified but can be copied
and used as a template for a new role. A role can consist of one or more roles. In the case of a role consisting of multiple
roles, the role inherits the permission levels of the component roles.
RoleRole Descript ionDescript ion ComponentComponentRolesRoles
AD SyncAdministrator
Advanced UserView
Enables access to Advanced section of the Create User dialog box.
All ServicesSchemaAdministrator
Manage the schema and configuration for all services. Service SchemaAdministrator
API User Enables access to the Services Manager API.
AuthenticatedUsers
Permission to perform generic user functions and view related dialogs. Access anyservice-related user dialog when the user is provisioned with that specif ic service.Mandatory role assigned to all authenticated users.
Exchange User
Office
Communication
Server (OCS)
User
Sharepoint
User
SQL Users
Citrix ServiceAdministrator
Create customized Citrix Application Groups for the administrator's customer.
The f irst user created by default after creating a customer inherits this role. Thecustomer administrator can create, provision, and edit users, then provision users toservices. This role can also manage services provisioned to the customer. This roleincludes all permissions of the user and service administrator.
UserAdministratorService
Administrator
DNS ServiceAdministrator
Allowed access to the Domain Name Service (DNS) Records and DNS Templatesdialogs. Can manage DNS zones and create DNS entries.
Everyone Permission for authenticated and non-authenticated users to view generic pages inthe services manager.
ExchangeServiceAdministrator
Create and manage Microsoft Exchange Distribution Groups, Contacts, and PublicFolders.
ExchangeUsers
Access to Exchange Summary dialog and can download Outlook Account settings.
File SharingServiceAdministrator
Create folders and add specif ic user permissions to folders. Create user securitygroups.
Hosted Appsand DesktopsServiceAdministrator
Manage the service, including all pages.
Hosted Appsand DesktopsUser
Enables users to access the service.
Lync 2010 forHostersServiceAdministrator
Manage the service, including all pages.
Lync 2010 forHosters User
Enables users to access the service.
LyncEnterpriseServiceAdministrator
Manage the service, including all pages.
LyncEnterprise
Enables users to access the service.
RoleRole Descript ionDescript ion ComponentComponentRolesRoles
Combines My Account Management and My Services Management roles. Enablesend users to manage their own accounts, edit services provisioned to them, andselect new available services.
My AccountManagementMy Services
Management
My AccountManagement
Enables the end user to change the user information details, account password,and manage email addresses associated with the user account.
My ExchangeService
Enables the customer to manage Hosted Exchange resources such as public foldersand distribution lists.
My HostedApps andDesktopsService
Enables the user to access subscriptions provisioned through the service.
My ServicesManagement
Enables the end user to select, edit, and re-provision the services provisioned to theend user account.
MySQLAdministrator
Manage the service, including all pages.
OCS ServiceAdministrator
Manage the service, including all pages.
OCS User Allowed access to the service as a user.
Partial UserAdministrator(ResetPasswords)
Reset passwords for a customer's user. Cannot create or delete users.
ReportingUsers
Access to the front-end reporting system.
Reseller FullAdministrator
Create, provision, and edit its own customers, then provision services to itscustomers. Create, provision, and edit users, then provision users to services.
Reseller PartialAdministrator
Manage reseller customer services and users.
ServiceAdministrator
Manage administration tasks for services. Access any editable service-relatedadministration dialog when the customer is provisioned with that specif ic service.
BlackBerry
Service
Administrator
RoleRole Descript ionDescript ion ComponentComponentRolesRoles
Create user templates and configure services to them. This administrator cancreate a new user by using a default template.
UserAdministrator
Create, provision, and edit users for a customer.
User andServiceAdministrator
Enable the user to create and administer users and provision services for acustomer.This role is identical to the customer administrator. Assign this role to a user when
you require more than one customer administrator user in your organization or
hierarchy.
UserAdministratorService
Administrator
VirtualMachineAdministrator
Access the Virtual Machine Management pages.
Windows WebHostingServiceAdministrator
Create and configure web sites, add user permissions to web sites, and create usersecurity groups.
WorkflowApprovalAdministrator
Allowed to define approval subscriptions.
WorkflowApproval User
Allowed to view and respond to approval requests.
RoleRole Descript ionDescript ion ComponentComponentRolesRoles
Updated: 2013-03-18Reporting for Services Manager delivers usage and billing reports to your customers and application vendors. It includes
standard reports to support standard provisioned services and a data warehouse. The Reporting service communicates
directly with the SQL Server Reporting Services web service.
The View Reports page of the control panel (Reports > View Reports) displays the reports available for each service as wellas billing reports. The service reports include the following report types:
Customer reports list users provisioned with the service at the customer level.
Plan reports list user counts grouped by the service's plans, at the reseller level.
Depending on the service, Reseller reports list varied information at the reseller level. For some services, this information is
limited to customers and users provisioned with the service. For other services, this information includes items such as
usage limits, f ile transfers and instant messages, memory and disk usage, or f ile counts.
Services Manager includes the following billing reports:Customer Detail displays the billing detail for services at the customer level.
Distributor Summary displays usage data for reporting to the CSP distributor.
Reseller Detail displays the billing detail for services at the reseller level.
To generate a report, click a report link on the View Reports page. A separate window appears, displaying the report. After
you generate a report, you can export it in several formats, including XML, CSV, and Excel. You can also customize the
parameters of the report, including starting and ending dates and whether or not to include certain types of records. After
you modify the parameters, click Generate to regenerate the report.
Reporting views are used as a source for data transferred to the data warehouse. When you generate reporting views,
issues related to missing source views during data transfer are described in error messages to help you with troubleshooting.
1. From the Services Manager menu bar, click Reports > Configuration > Data Warehouse.
2. Under Refresh, click Refresh report views from reporting services.
Note: If a "401 Unauthorized error appears, verify which service account is configured for SQL Server Reporting Services.
If it is Network Service or Local System, try adding http/SQLReportingServiceFQDN to the servicePrincipalName
attribute of the service account.
3. Under Filter, select the service for which you want to generate views, if applicable.
4. Under Generate, click one of the following options:
Views for all services. Click this option to generate views for all deployed services.
Views for selected service. Click this option to generate views for the service you selected in Step 3.
To create a new reporting view
When creating a new reporting view for a service, you will also need to ensure it can transfer data to the data warehouse.
To do this, add a transfer command for the service to the data warehouse configuration file.
1. From the Services Manager menu bar, click Reports > Configuration > Data Warehouse.
2. Under Filter, select the service for which you want to create a new view.
Updated: 2013-03-04During the course of business, resellers or customers might need to change services that are provisioned, the number of
provisioned users, or the level at which a service is provisioned. These changes affect the pricing and billing of services, so
service providers, resellers, and customers need a mechanism for managing these requests in a timely manner.
Using Workflow Approval, you can approve or reject provisioning requests such as deprovisioning a service from a customer,
updating user details, or adding users to an existing service. Approvers can be managers in an organization or members of a
group that is notified whenever a specific type of request is made. All requests move through an approval chain before they
are enacted in the system.
Workflow Approval is not enabled by default in Services Manager. You can enable this feature through the Feature Setup
menu item (Configuration > System Manager > Workflow Setup). Only Service Provider Administrators can enable workflow
approvals and customize notification messages by default. After this feature is enabled, users logging on to the control
panel see the Workflow menu bar item which enables them to view provisioning requests. Additionally, you can configure
approval requirements and create approval chains.
When Workflow Approval is enabled, the following events occur:All users are assigned the Workflow Approval User security role and can view approval requests and responses.
The Workflow Approval Administrator security role is available for assigning to appropriate users.
The My Account Management, My Services Management, and My Account and Service Management security roles are
enabled for all customers. These roles allow users to modify their own account or provision services to themselves which
can be approved by managers or groups you define.
For Service Provider Administrators, a Workflow Approval preview link appears on the Customer Details, User Details,
customer service, and user service pages. When clicked, this link displays a preview of the approval notif ication message
that will be sent when information on these pages is modif ied.
When Workflow Approval is disabled, the following events occur:The Workflow Approval Administrator and Workflow Approval User security roles are disabled for all customers and users.
Workflow Approval role membership is removed from other security roles in which it was included.
For Service Provider Administrators, the Workflow Approval preview link is removed from all control panel pages.
The Bypass workflow approval role permission is enabled for the Authenticated Users security role and applies to all
control panel items governing customers, users, and services. This disables workflow approvals for all customers.
When enabling workflow approval, you can also enable security roles that allow users to modify their own account orprovision services to themselves without additional approval. When these security roles are enabled for selected users,those users can log on to the control panel and perform the following tasks:
The My Account Management security role allows users to modify their own User Details page. Clicking My Account >
Personal Details displays the User Functions dialog box, enabling the user to click Edit User and make changes to the User
Details page.
The My Services Management security role allows users to manage their own service provisioning. Clicking My Account >
Services displays the User Services page for the logged in user. From this page, the user can provision available services,
Updated: 2013-03-04The Workflow Approval feature includes a set of XSL templates that are used to create the notification emails that are
sent when approval requests are generated. Service Provider Administrators can customize these templates according to
their needs or create new templates for specific services.
Notification emails are composed of the Header and Footer template and an Email Content template. The Header and
Footer template defines the overall look and feel of all notification messages. Email Content templates define the text
used for specific actions and services.
Services Manager includes Email Content templates for the following actions:Provisioning and deprovisioning customers or users
Provisioning and deprovisioning services for a customer or user
Provisioning the DNS service for a customer
Provisioning the Reseller service for a customer
Each Email Content template includes text for approval requests and approval responses.
After you customize a template, you can preview your changes by clicking the Workflow Approval preview link located on
the Customer Details, User Details, customer services, and user services pages.
1. From the Services Manager menu bar, select Workflow > Configuration > Approval Emails.
2. From the template list, click the template you want to customize. The XSL editor page appears.
3. If you are customizing an Email Content template, click the Request or Response tab to select the content you want to
customize.
4. Make the appropriate changes using well-formed XSL tags.
5. Click Save.
You can create new Email Content templates for notif ications about customer and user actions or about specif ic servicesin your deployment.Note: If you attempt to create a new template for an action or service that already exists in the template list, a newtemplate is not created and the existing template is not overwritten. Instead, the existing template opens so you cancustomize it.1. From the Services Manager menu bar, select Workflow > Configuration > Approval Emails.
2. Under Create Notif ications, perform the following actions:
1. In Category, select the type of notif ication you want to create. For example, select User Service for notif ications
about a user's access to a service.
2. In Event, select the action about which you want to notify approvers.
3. In Service, select the service for which you want to create the notif ication. This f ield is available when you select the
Customer Service or User Service categories.
4. Click New Message. An empty XSL editor page appears.
3. Click the Request or Response tab to select the type of content you want to insert. For example, click the Request tab
to add text for an approval request notif ication.
When the Workflow Approval feature is enabled, all users can view approval requests and responses. However, onlyWorkflow Approval Administrators can view the current status of approvals.
Use this procedure to view approval requests that you have generated.
1. From the Services Manager menu bar, select Workflow > Approval Requests.
2. In Filter, select the response status of requests you want to view (for example, Pending, Accepted, and so on).
The Approval Request page displays the requests you selected.
1. From the Services Manager menu bar, select Workflow > Approval Responses.
2. In Filter, select the response status of requests you want to view (for example, Pending, Accepted, and so on).
3. Select whether you want to view responses to requests you generated or to all requests in the system.
The Approval Response page displays the requests you selected.
1. From the Services Manager menu bar, select Workflow > Approval Status.
2. In Status, select the status of requests you want to view (for example, Pending, Accepted, and so on).
3. To refine your search by date, select Request Date or Resolved Date and then select the appropriate date.
The Approval Status page displays the requests you selected.
Updated: 2013-02-12A common task for a service provider or reseller to perform after logging on to the Services Manager control panel is tocreate a customer. A customer is a container that can consist of :
Hosted services that can be configured and made available (that is, provisioned) to the customer's users
A customer administrator who can create and manage users, and provision services to them
Users who access one or more services with which they have been provisioned
Additional customers (known as resellers) who, in turn, can create and manage customers and users of their own, and
provision services to them
To create a reseller, the service provider provisions a customer with the Reseller service. Resellers can, in turn, create their
own customers and enable them to be resellers as well. Service providers have access to advanced system configuration
functions, such as service configuration, which resellers do not.
As you create a customer through the control panel, you specify the customer location (that is, the hosted domain), its
Active Directory organizational structure (optionally), and any advanced properties. Advanced properties can include
password expiry rules, additional organizational structure, and service security roles. You can select one or more security
roles to enable the customer to administer available services. As a final step, the Provisioning engine creates an organization
structure and security groups in Active Directory for the defined customer.
Creating a customer consists of these initial steps:1. Create a new customer by selecting Customers > New Customer from the Services Manager menu bar.
You can quickly create a customer with minimal details: name, email contact information, and a domain name. Services
Manager assigns a default set of restricted and allowed security roles in this case. Alternately, you can add more detailed
information and choose roles for the customer and any inherited customers and users.
2. Create a customer administrator user to manage users and administer services in the customer's organization.
After creating a customer, Services Manager automatically prompts you to create an administrator user. You can cancel
this operation, but this first user created for a customer is always an administrator user.
3. Provision available services to a customer, an action performed by a service provider or reseller.
4. Create users to whom services are later provisioned, an action performed by a customer administrator.
5. Provision services to users, an action performed by the customer administrator.
Updated: 2013-02-12After you create and initially provision a customer, Services Manager automatically prompts you to create the f irst user forthe customer: the customer administrator. If you do not create an administrator at this time, when you attempt to createthe f irst user for the customer, it is created as an administrator.
Before you create a customer administrator, gather all contact information and determine a password for this user. You
can choose to provide more detailed contact information when you create the user.
After you create (that is, provision) this user, the Services Manager will automatically prompt you to provision services.
1. Find and select the customer for whom you want to create the administrative user, as described in Find customers.
2. From the Services Manager menu bar, click Users > New Users.
3. If not expanded, expand User Details, then select or type the following information:
In UPN, type a user name that will be added to the appended domain name that you select from the drop-down list.
This entry is automatically populated in the Username field. You can edit this f ield.
In First Names and Last Name, type the user's f irst and last name. These entries are automatically populated in the
Display Name field. You can edit this f ield.
4. Click Additional User Properties to add more details about the user.
5. Under Address, General, Organization, and Telephones, add information as appropriate.
6. Under Password Configuration, add a password for the user.
7. Click Account Settings and configure the following options:
Change Password at Logon
Account Disabled
Account Locked
Account Expires
8. Click Advanced Options to select security roles for the customer administrator.
9. Ensure the Configure a custom role collection check box is cleared and then select one of the following administrator
roles from the drop-down list:
Customer Administrator
Partial User Administrator (Reset Passwords)
Service Administrator
User Administrator
User and Service Administrator
10. (Optional) Expand Email Addresses to configure one or more email addresses for the customer administrator.
Note: If no email address is specif ied, Services Manager automatically assigns an email address constructed from the
UPN.
11. Click Provision to create the user. Services Manager automatically prompts you to provision services.
Brands consist colors, fonts, images, and layout information that define the look and feel of the control panel. Service
providers, resellers, and customers can manage these brands according to certain permissions.
A customer's brand can be configured to the following methods:Associate a brand with a specif ic URL. This defines what users see when they access the control panel login page.
Associate a brand with the user's login. This defines what users see after they log on to the control panel.
Inherit the parent customer's brand settings. This enables the service provider or reseller to define the customer's brand
using a brand of their own.
Brand types
Services Manager includes two types of brands:System brands are brands that exist at higher levels in the customer hierarchy, relative to a specif ic customer. Typically,
brands that service providers and resellers create are system brands. Customers that belong to the service provider or
reseller in the hierarchy will inherit these brands.
Customer brands are brands that are attached to specif ic customers using a customer ID. By default, customer
administrators can create their own customer brands. Service providers and resellers can create customer brands by
impersonating the customer to whom they want to attach the brand.
Brand management
The Brands section of the control panel enables you to perform the following tasks:View, modify, and delete the stylesheets of existing brands
Download templates that you can modify and upload to create a new brand
Select the brand you want to use for all logged in users
Associate a brand with a specif ic URL
To access the Brand Management pages of the control panel, users must have the Content Management Administrator
security role. Typically, this role is automatically assigned when the first user is created for a new customer.
This topic describes the visual elements that comprise most pages in the control panel and the stylesheet attributes that
control their appearance.
For more information about the default attributes for each style, download the Full Template file from the Brand
Management Overview page.
Headings
Headings appear near the top of all control panel pages and are used to title pages. Use the following styles to change theappearance of specif ic heading levels on a page:
.heading1
.heading2
.heading3
.heading3box
.pageTitle
Page titles
The .pageSubTitle style controls the appearance of the subheading that appears immediately beneath the main heading on
a page.
Side bar boxes
The side bar boxes appear on the left side of each page. Typically, these boxes display management tasks for a specif icmenu item, search functions, or related pages.
.boxAlt-topleft
.boxAlt-topright
.boxAlt-bottomleft
.boxAlt-bottomright
.boxAlt-inside
Banner
The .top_banner style references the logo image that appears across the top of each page. When you upload a custom
banner image, Services Manager appends the brand code to the default image filename. For example, if you specify a
custom image for a brand with the code "Sample01," Services Manager names the file "toplogoSample01." Typically,
uploaded images are located at C:Program Files (x86)CitrixCortexCortexWebCortexDotNetpics.
To ensure your uploaded image is used in pages that specify the #banner element, customize your stylesheet as follows:.top_banner{background-image:url('/CortexDotNet/pics/toplogoBrandCode.FileFormat}
Note: Service Manager accepts banner images in the GIF or JPEG f ile format.
Menu hover
When you hover over a menu item in the control panel, the item's background and text color change. Use the following
When you hover over an item in the control panel menu bar, the background color changes. Use the following style tochange this attribute:
.MainMenu
.MainMenuHover
.MainMenuStyle
Page background
The .pageBackground style references the background image and background color of control panel pages. When you
upload a custom background image, Services Manager appends the brand code to the default image filename. For example,
if you specify a custom image for a brand with the code "Sample01," Services Manager names the file "bg_Sample01."
Typically, uploaded images are located at C:Program Files (x86)CitrixCortexCortexWebCortexDotNetpics.
To reference your custom background image, customize your stylesheet as follows:.top_banner{background-image:url('/CortexDotNet/pics/bg_BrandCode.FileFormat}
Logged on user
The name of the currently logged on user appears on the top banner of all control panel pages. Use the following styles tochange how this name appears:
A.loginlabel
A.loginlabel:link
A.loginlabel:active
A.loginlabel:hover
A.loginlabel.visited
.loginlabel
Table rows
Table rows are styled differently depending on whether or not the row is alternating or expanded. Use the following stylesto change the appearance of table rows:
Style name Description
td.rowA Allows you to change the appearance of all rows in tables.
td.rowAalt Allows you to change the appearance of alternate rows intables.
Services Manager uses CSS stylesheets to control brand appearance. All elements are defined in the top level stylesheet,
Default.css. Using inheritance, a customized stylesheet can be defined to override specific elements in the top level
stylesheet.
When customizing a stylesheet to override styles at the top level, include only the styles and attributes that you want tooverride. It is not necessary to include all styles in your customized stylesheet as the top level stylesheet will be used for anyunmodified styles. As an example, the following table illustrates the default attributes for the .pageTitle style in the toplevel stylesheet and the customization required for modifying only the font color.
You can download a copy of the top level stylesheet from the Brand Management Overview page (Customers >Configuration > Branding). Choose from the following templates:
Basic template: Includes the core styles required for changing the background, top banner image, and site colors.
Full template: Includes all the styles and layout elements in the top level stylesheet.
2. From the Customer Move page, perform the following actions:
1. In Customer Search, type the name of the customer to be moved and select the customer.
2. In Reseller Search, type the name of the destination reseller that will receive the customer and select the reseller.
3. Click Load Customers.
4. From the drop-down list, ensure the correct location is selected. The destination reseller's location must match the
customer's current location.
Important: If multiple locations are available from the drop-down list and you select a location that is different from the
customer's current location, the move operation will fail. Moving customers to resellers in other locations is not
supported.
5. Under Package Selection, if available, select the source and destination customer service plan and service access level.
6. Click Move.
The Services Manager displays a message that changes are complete and the customer is being provisioned. You can checkthe status of move by clicking Configuration > Provisioning & Debug Tools > Provisioning Requests.
Updated: 2013-02-12By default, the Service Provider Administrator and Reseller Full Administrator roles can create customers. However, only the
Service Provider Administrator can create a Reseller customer (known as the reseller). In this case, the reseller resides in the
Service Provider's customer hierarchy and the reseller can then create one or more customers within its own hierarchy.
To create a reseller, perform the following actions:1. Create a customer and create the customer administrator user. Alternatively, select an existing customer.
2. Provision the Reseller service to the customer.
3. Add the Reseller Administrator role to a user.
To create a reseller
1. Create a new customer or select an existing customer:
To create a new customer and customer administrator, follow the steps described in Create new customers and To
create customer administrators. Afterward, Services Manager automatically prompts you to provision services to the
customer after you create the customer administrator.
Locate and select the existing customer for whom you want to provision the Reseller service as described in Find
customers.
2. From the Customer Functions box, select Services and then expand Reseller.
Note: If more than one location is configured, multiple Reseller services are listed, one per location. Select the Reseller
service instance for the desired location.
3. Select the Reseller check box.
4. Click Provision.
When you create a reseller customer, the reseller administrator roles are added automatically to the list of available usersecurity roles.
To add the reseller administrator role to a user
1. From the Services Manager menu bar, click Customers and select a customer from Customer Hierarchy or search for a
customer from the Advanced Customer Search dialog box.
2. Click the customer name, click Users, and then select the user to whom you want to assign the reseller administrator role.
3. Click Edit User, click Account Settings, and then click Advanced Options.
4. Select the Configure a custom role collection check box, expand the Service - Administration node, and then select one
of the following roles:
Select Reseller - Reseller Full Administrator if you want to grant to the user full rights to create, modify, and delete
sub-customers.
Note: Before the reseller customer can create sub-customers, a user must be assigned the Reseller Full Administrator
role.
Select Reseller - Reseller Partial Administrator if you want to designate a user with the ability to update sub-customer
Updated: 2013-09-20By default, the Service Provider Administrator and Reseller Full Administrator roles can create a customer.
To create a customer with default settings, gather the customer name, email contact information, and primary domainname. You can provide more detail such as:
Detailed customer contact information
Language (locale) for users
Password and email management specif ications
Security roles to assign or disable for the customer
After you create and initially provision a customer, Services Manager prompts you to create the initial administrator for thecustomer as described in To create customer administrators. If you do not create an administrator at this time, the f irstuser created for the customer is an administrator.Note: After you create a customer, you can edit the customer properties as described in To modify customers.
To create customers with all restricted security roles
1. From the Services Manager menu bar, click Customers > New Customer. The Create Customers page appears.
2. Under Customer Details, select or type the following information:
In Location, select the location where this customer and related users will reside. This selection is displayed if multiple
location have been configured. The location cannot be changed after the customer is created and saved.
In Full name, enter the full name of the customer.
In Code, the customer code is automatically generated from the customer's Full Name. You can edit this f ield to
replace the generated code.
In Contact Name, enter the name of the person or entity associated with the customer as the primary point of
contact.
In Email Address, enter the contact email address in the format of username@domain-name.
3. Under Domain Management, type the new customer's domain name.
4. Select Primary to select this domain as the primary domain for this customer.
Note: The customer is limited to a single primary domain. If you add another domain and select Primary, the added
domain becomes the primary domain.
5. Select the DNS Zone check box to create a DNS zone for each domain entered and click Update.
Note: This option is displayed if the DNS service is installed and configured in the control panel. Only domains owned by
the customer can become a DNS zone. When the customer is provisioned, this domain will be added to the DNS service.
6. Click Add to add more domains.
7. When you are f inished, click Provision to create the customer. Otherwise, click Additional Options or expand Advanced
Properties to add more detail about the customer.
To add more customer details (Additional Options)
1. On the Customer Details page, click Additional Options.
2. Under Address, add complete address information. Services Manager automatically populates the required Country
attributes in Active Directory (co, c, and countryCode) when you select a country from the Country drop-down list.
3. Under Phone, add the following information:
In Phone Number and Fax Number, add complete telephone and fax information.
Updated: 2013-02-12You can create users in the following ways:
Create a new user with the New User Wizard
Import many users by using the Bulk User Import feature, with user information defined in a Microsoft Excel spreadsheet
Move users from one customer to another customer
Overview for creating users
Creating a user through the Services Manager control panel consists of these initial steps:1. Create a new user by clicking Users > New User from the Services Manager menu bar. You can quickly create a user with a
minimum of information: name, user name and password, and display name.
Manage user password expiration email notificationsand reports
Jun 05, 2015
Updated: 2013-02-12Services Manager enables a customer administrator to configure, enable, and report on user password expiry andnotif ication. As described in Create users and configure account settings, you can allow passwords in user accounts toexpire. Creating and configuring password expiration email notif ication is the f irst step of a two-step process: f irst create amessage, then enable the message to be sent. To do this, you perform the following tasks:
Create and configure a password expiration email notif ication to all users within a customer hierarchy.
Enable the password expiration notif ication email.
Generate a user email expiry report to be sent to a customer administrator.
Note: The Password Expiry date is set by the service provider or domain administrator for the domain's Group Policy.
To create and configure a password expiration email notification to users
If you intend to include a file attachment with the notification, upload the file before creating the new notification
message.
1. From the Services Manager menu bar, click Customers > Configuration > Email Notif ication.
2. (Optional) If you intend to include a f ile attachment with the notif ication, click Attachments and then select and upload
the f ile you want to include. To return to the email notif ication page, click Notif ication.
3. Under Create Messages, select the following options:
In Event, select User Password Expiry.
In Recipient, User.
In Customer Type, select Full Customer.
4. Click New Message. The Email Content dialog box appears.
5. Configure the following email notif ication settings and then click Save:
Under Settings, select the status, frequency, modif ication settings for the notif ication. By default, notif ications have
an Enabled status and are sent once.
Under Recipients, select one of the following f ilters by which to search for or select recipients and then click Add:
Select Custom and, in E-mail, type a common email pattern or customized email address. For example, the common
email pattern {UserExternalEmail} sends email to the address specif ied in the user's External Email Address property.
Select User or Customer and, in Search, type a name or search by specifying a partial name prepended with the
percent (%) character.
Select Role and choose a role from the drop-down list. All users provisioned with that role will receive a notif ication
email.
Select Reseller Role and choose a role from the drop-down list. All users provisioned with that role will receive a
notif ication email.
In From Address and From Display, type the reply-to address and a display name of the email sender.
Under Message, perform the following actions:
In Language, select a language from the drop-down list.
In Subject, type a subject for the notif ication.
(Optional) In Attachments, select a f ile that you uploaded using the Attachments feature.
In the message box, type the text of your message.
Updated: 2013-02-12You can move a user from one customer to another customer, migrating the user information and provisioned services tothe new customer, with the following conditions:
Both customers must belong to the same Services Manager location (that is, Active Directory domain).
Provisioned services that will transfer with the user are limited to Hosted Exchange and Office Communications Server
(OCS). If the user is provisioned with any other service, deprovision that service before attempting the migration.
You can also make a copy of an existing user within the customer hierarchy. The copied user resides in the original user's
customer hierarchy and possesses the original user's provisioned services.
To move a user to a different customer
Ensure that you perform the following procedure as a Service Provider or Reseller administrator.
1. From the Service Manager menu bar, select Users > Configuration > User Move.
2. In Customer Search, type a source customer name and click Next. Services Manager returns the source customer name,
if found.
3. In User Search, type a user name and click Next. Services Manager returns the user name, if found.
4. In Customer Search, type a destination customer name and click Next. Services Manager returns the customer name, if
found, and displays the User Mapping table to enable you to change the moving user's new UPN and email address.
5. Accept or edit the defaults and click Next.
6. Click Finish to move the user.
When complete, Services Manager prompts you to review the customer and user. Citrix recommends that you review both
and edit each as required. To move another user, click Move another user to a new customer.
To copy a user in the same customer hierarchy
Ensure that you perform the following procedure as a user administrator, at a minimum.
When performing this procedure, consider the following items:Some services might appear in the User Services dialog box with a blue provisioning status. Blue indicates that the user's
services require additional configuration. After configuring the service, manually provision it.
When the Hosted Exchange service is provisioned to the copied user, the default primary email address is the new copied
user's address.
If populated, the Title and Web Page f ields in Additional User Properties are copied to the new user.
1. Click Users to display all users for a customer, then click a user to access the User Functions dialog box.
2. Click Copy User. The Create User page appears.
3. Enter user details and password for the new user and configure account settings as described in Create users and
configure account settings.
4. Click Copy Services and clear the check boxes for any provisioned services you do not want to be copied to the new user.
5. Click Provision. The Provision Services page displays all provisioned and unprovisioned services.
6. Provision any additional services from the list to the copied user.
7. Click Provision for each service you want to provision to the user. The copied user is now created and provisioned in the
Updated: 2013-02-12You can import new or edit existing users in a customer hierarchy by using the Bulk User Import feature. This featureenables you to create new or modify existing multiple users as specif ied in a Microsoft Excel 97-2003 format workbook(.xls). You can download a new blank template or a workbook populated with existing user information from the portal. Ineither scenario, you perform the following actions:
Download the appropriate template
Create new or edit existing users
Upload the template to the portal
Select users to add or update
Provision services to the users and then provision the users
After uploading the template, Services Manager gives you the opportunity to perform the following actions:Resend the f ile process request to upload the template again
Import the users from the template you uploaded
Download the template you uploaded
Cancel the bulk user import process
Delete the f ile from the imported f ile list
Bulk User Import Template Settings describes the template's workbook headings and settings.
Consider the following when you create or edit a Bulk User Import template:Do not rename the column headings in the templates.
Do not leave blank rows between users.
The templates do not support provisioning new services to users. You must provision services to users through the
Services Manager by using the User Functions or Multi User Selection features.
To download a template
1. Click Users > Bulk User Import.
2. Click one of the following options, then click Save when prompted to save a copy of the template on your PC:
Click New Users Template to download a blank workbook template with column headings.
Click Existing Users Template to download a workbook with column headings and cells populated with user data.
Click Generate Template to create a new template with column headings and cells populated with current user data.
When the workbook template is ready, click Existing Users Template to download it.
Note: This selection exists depending on how Services Manager was installed. The workbook is not generated
immediately. The speed at which the workbook is generated depends on how many users exist in the customer
hierarchy.
To import users
1. Click Users > Bulk User Import.
2. Under Upload User Import File, click Browse, navigate to your new or edited workbook, and select it.
3. Add a description for the workbook and click Upload. The Bulk Import File List displays the f ile details as the f ile is verif ied.
4. From the f ile list, click the upload date of the f ile you uploaded and, under Import File Management, click Import. The
Updated: 2013-05-13Impersonating a user allows you to see what the user can access and view within the Services Manager control panel. Youcan do this, for example, when troubleshooting a system problem that a user is experiencing. To impersonate a user, youmust have the User Administrator security role assigned to you.While you are impersonating a user, you cannot impersonate another user, even if the user you are impersonating has the
User Administrator security role assigned.
1. From the Services Manager menu bar, select Customers.
2. Select the customer whose user you want to impersonate and then, under Customer Functions, click Users.
3. Select the user you want to impersonate and then, under User Functions, click Impersonate. The impersonation takes
immediate effect and the top of the control panel page indicates you are impersonating the selected user. The control
panel displays all the menus and functions that are allowed for the selected user.
4. To return to your own user account, click your username near the top of the control panel. The control panel displays
Updated: 2013-05-11You can f ind users by using one of the following search methods:
The User Search feature available from the control panel Home page, located under User Management
The search criteria available from the Users page
Note: User search is limited to the users of a specif ic customer. Before searching for users, f ind and select the customer towhom the target users belong.
To search for users from the Home page
1. From the Services Manager menu bar, click Home and expand User Management.
2. Select a f ilter of Name, UPN, or Email.
3. In User Search, type a user name, email, or User Principal Name (UPN) and click Search.
You can use the percent (%) character as a leading wildcard to perform partial searches. For example, type %citrix to find
all users with "citrix" as part of the user name.
To search for users from the Users page
1. From the Services Manager menu bar, click Users. The Users page appears, listing all the users for the current customer.
2. To search for users alphabetically:
1. Expand Filter Fields and select one of the following criteria:
User ID
UPN
Firstname
Surname
Location
Department
2. Click the letter with which the selected criteria begins.
For example, to f ind users with UPNs beginning with F, you select UPN and then click the letter F.
3. To search for users using several different criteria:
1. Expand Advanced Search and enter any of the following information:
In User ID, UPN, First Name, Surname, or Email, type at least one letter in any of these f ields to f ind users whose
information begins with the letter or letters.
In Role, select a security role from the drop-down list. For example, select User Administrator to f ind users assigned
the User Administrator role.
Under User Types, select Standard to f ind a customer's user. Select Template to f ind any user templates in the
Services Manager. Typically, a template user is the defined user template you can download for Create multiple
users with Bulk User Import.
2. Under Service Filter, enter any of the following information:
In Service, select a service from the drop-down list. Only services that are currently provisioned to the customer
appear in this f ield.
In Access Level, select a user plan, if applicable.
In Status, select the service provisioning status for the users you want to f ind.
3. Under Account Status, select Yes or No to f ind users according to the associated account status. By default, Ignore is
selected to prevent the account status options from being considered in searching.
Updated: 2013-02-12Each user can be assigned a specif ic security role in the Services Manager control panel. A security role provides a user withselected access permissions in the Services Manager. The following roles are the standard or default administrator rolesavailable when creating or editing a user.
SecurityRole
Description
Customeradministrator
The f irst user created by default after creating a customer inherits this role. The customeradministrator can create, provision, and edit users, then provision users to services. This role can alsomanage services provisioned to the customer. This role includes all permissions of the user and serviceadministrator.
Partial useradministrator
This role can reset passwords for a customer's user.
Useradministrator
This role can create, provision, and edit users for a customer.
Serviceadministrator
This role can manage services provisioned to the customer. It can access any editable administrationinterface associated with a service.
User andserviceadministrator
This role is identical to the customer administrator. Assign this role to a user when you require morethan one customer administrator user in your organization or hierarchy.
Services Manager also includes three security roles to enable end-users (that is, consumers of customer services) to managetheir accounts and provisioned services. These roles are disabled by default and need to be enabled and provisioned to thetop-level customer by a service provider or reseller administrator before they can be provisioned to a user account. Onceprovisioned, users can manage their accounts through My Account, available from the Services Manager menu bar afterlogon.
Security Role Description
My AccountManagement
Enables the end user to change the user information details, account password, and manageemail addresses associated with the user account.
My ServicesManagement
Enables the end user to select, edit, and re-provision the services provisioned to the end useraccount.
My Account & ServicesManagement
Combines the above management capabilities in a single role.
To enable and provision user security roles
Ensure that you are logged on to the Services Manager as a customer administrator user to perform these steps.