Product Documentation

To configure server roles using the graphical interface

Jun 05, 2015
Updated: 2013-03-05

In general, the configuration process is similar for each server role you install. However, some server roles include additional configuration options. Only the roles you install on the server are available for configuration.

This topic assumes you have installed the server roles you want to configure, the Services Manager Setup Tool is running and displaying the Deploy Server Roles & Primary Location page.

  1. From the Deploy Server Roles & Primary Location page of the Setup Tool, select Configure Server Roles.
  2. On the Load Deployment Configuration File page, browse to location where you created the XML configuration file and select the file. Click Next.
  3. On the Select Configuration Task page, select one or more roles to configure and then click Next.
  4. Use the following table to configure the settings for each server role:
    Role Page Description

    Directory Web Service

    Configure Directory Web Service

    Configure the following options as required:
    • Auto-generate credentials: Select this option to create the Directory Web Service account with auto-generated credentials. Leave this option cleared to specify your own credentials for this account.
    • User name: Enter the user name of a domain administrator for the service account. The default user name is cortex_dirws_svc. This field is not available if you elect to auto-generate credentials.
    • Password: Enter a password for this account that conforms to your domain's password policy. This field 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 Directory Web Service will use. By default, the Directory Web Service uses port 8095.

    Provisioning

    • Configure Queue Monitor Service
    • Configure Directory Monitoring Services

    The Queue Monitor service processes administrative requests from the Web Server and automates other internal services. The Provisioning Engine hosts scheduled tasks that monitor Active Directory, keeping user account information current, and sending email notifications for events such as password expiry.

    Configure the following options as required:
    • Auto-generate credentials: Select this option to create the monitoring service account with auto-generated credentials. Leave this option cleared to specify your own credentials for this account.
    • User name: Enter the user name of a domain administrator for the service account. For the Queue Monitor service, the default user name is cortex_qmon_svc. For the Directory Monitor service, the default user name is cortex_dirmon_svc. This field is not available if you elect to auto-generate credentials.
    • Password: Enter a password for this account that conforms to your domain's password policy. This field 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.

    Configure Provisioning Mail Server

    Specify the SMTP server address and port number the Provisioning server will use to send email messages, such as system updates to administrators, account notifications to end users, and usage reporting to Citrix. Click Test Connectivity to ensure the Configuration Tool can communicate with the SMTP server.

    Report Mailer

    Configure License Reporting

    Configuring the Report Mailer is required. Licensing data is reported to Citrix through emailed reports.

    Configure the following settings:
    • Customer ID: Enter your Citrix customer ID.
    • 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 cortex_RM_svc. This field is not available if you elect to auto-generate credentials.
    • Password: Enter a password for this account that conforms to your domain's password policy. This field 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.

    Configure Mail Server for Report Mailer

    Specify the address and port number of the SMTP server that the Report Mailer server will use to send email messages to administrators, end users and Citrix. If you have previously configured SMTP settings for the Provisioning server, the Use shared mail settings check box is selected by default.

    Additionally, specify the From Address that will be used to send email messages. The default address is ReportMailer@domain.com.

    Reporting

    Reporting Database Credentials

    Configure the following settings:
    • Auto-generate credentials: Select this option to create the Reporting 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 OLMReportingUser.
    • Password: Enter a password for this account that conforms to your domain's password policy. This field is not available if you elect to auto-generate credentials.

    Configure Mail Server

    Specify the address and port number of the SMTP server that the Reporting service will use to send email messages to administrators, end users, and Citrix.

    Preview Service Package Import

    Review the selected service components that will be imported when the Reporting service is configured. Unselected service components, such as packages, roles, and assemblies, are imported when other server roles are configured.

    Configure Reporting Database

    Configure the following settings:
    • Use primary database settings: Leave this option cleared if you want to configure a secondary database server to handle system reporting and billing. Select this option if you want to use the server hosting the main database for these functions.
    • Server address: Enter the FQDN, IP address, or DNS alias of the database server you want to use.
    • Use specific port: Select this option to configure the port number for the database server. The default port number is 1433.
    • Authentication mode: Select the database authentication you want to use. By default, Windows (Integrated) is selected. A SQL Server login for the reporting database ensures cross-domain accessibility.
    • Connection credentials: Enter the user name and password for the database administrator user. These fields are not available if SQL authentication is not selected.

    Click Test Connection to ensure the Configuration Tool can communicate with the database server.

    Configure Data Transfer Service

    The Data Transfer Service is a scheduled task of the Data Warehouse feature that migrates and adapts data from the primary database to facilitate building reports with Microsoft SQL Server Reporting Services. Configure the following settings:
    • 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_datatransfer_svc.
    • Password: Enter a password for this account that conforms to your domain's password policy. This field 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.

    Data Transfer Notifications

    The Data Transfer task sends email notifications with the results of Data Warehouse operations. This enables administrators to respond quickly to interruptions in reporting functionality. Specify the source and destination email addresses for sending success and failure notifications.

    Specify Reporting Services Details

    Configure the following settings:
    • Report server URL: Enter the URL of the reporting server instance as it appears in the Microsoft SQL Server Reporting Services Configuration Manager.
    • User name and password: Enter the credentials of the report server administrator user. The password for this user account should never expire, in order to avoid potential service interruption.

    Click Test Connection to verify the Configuration Tool can communicate with the reporting server.

    Data Warehouse 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 field 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.

    Web

    Preview Service Package Import

    Review the selected service components that will be imported when the Web server role is configured. Unselected service components, such as reports, are imported when other server roles are configured.

    Configure Web Server

    • External address: Enter an externally resolvable host name or address by which the server can be reached. The default address is cortexweb.
    • Binding IP: By default, all IP addresses are included.
    • Use SSL: Leave this option selected if you are deploying Services Manager in a production environment. You can clear this option if you are deploying Services Manager in a test environment.
    • SSL certificate: Specify the SSL certificate you want to use for the server. This item is not available if you do not elect to use SSL.
  5. 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.