CIS Problem Reporting
Citrix Provisioning allows you to report problems you encounter while using the software. Using this feature, you can directly report issues to Citrix Support, who uses the information to troubleshoot and diagnose the problem to improve Citrix Provisioning. This feature, along with the Customer Experience Improvement Program (CEIP), is used by Citrix to continually improve the software.
Participation in programs that help improve Citrix Provisioning is voluntary. Problem reporting, along with CEIP, are enabled by default. Use the information in this article to configure and use problem reporting.
How problem reporting works
Problem reporting works by sharing diagnostic information resulting from an event within Citrix Provisioning. It can be performed for a specific Provisioning Server, or for a site:
- If you have an environment with multiple Provisioning Servers, each may have a different SOAP Service user. In such environments, the SOAP Service user must have read\write permissions to the network share when generating the diagnostic bundle.
- If you are reporting a problem for a specific Provisioning Server, only that server will generate a diagnostic bundle that captures the event.
- If you are reporting a problem for a site, each Provisioning Server in the site generates a diagnostic bundle.
- The diagnostic bundle can be uploaded directly to Citrix, or it can be saved to a shared network drive and manually uploaded to Citrix at a later time.
The diagnostic bundle is manually uploaded to the Citrix CIS website; login to this site using your Citrix credentials.
Using a token for secure communication
When using problem reporting, a token is generated to associate the diagnostic bundle with your My Citrix account login credentials. Once the token is associated with your My Citrix credentials, it is stored in the database for all future problem reporting, thus eliminating the need to store your login credentials.
If you are using Problem Reporting for the first time and have not yet configured a login token, you will be prompted to enter your My Citrix login credentials. Once you enter your login credentials, the token will be generated and stored in the database.
Configure problem reporting
In the Citrix Provisioning Configuration Wizard screen:
- Enter your Citrix username and password.
- Confirm the password.
- Click Next.
If you haven not secured a token used to authenticate your login credentials, the Problem Report Configuration screen displays information indicating that ‘The token required to submit problem reports is empty. Please re-configure.’ The token can be generated by entering your credentials here or at a later time using the Provisioning Console.
You are prompted to enter your My Citrix credentials when you try to upload a problem report, and you have not yet generated the token.
The password and username you specify are not saved. The token that is generated is used to associate your diagnostics bundle with your My Citrix account.
Report a problem
To report a problem you must first specify the options to use. You can either upload a bundle of diagnostic information using your Citrix username, or you can generate diagnostic information locally to a ZIP file by selecting an empty folder on a shared network drive accessible to all of the servers included in this problem report.
To report a problem
In the Citrix Provisioning Console, expand the Sites node to display the server on which you want to report a problem.
Select the server, and right click to display a context menu.
Click the Report a problem option.
In the Problem Report screen, select how to generate diagnostic information:
- Upload Diagnostics – Use the generated token to upload a diagnostic bundle (a ZIP file containing numerous files related to the problem).
- Generate Diagnostics – Select an empty folder on a shared network drive that is accessible to the servers you have selected.
Each server in the selected site uploads or generates its own diagnostic bundle.
The token is only required for automatic upload. If you are generating the bundle locally, the token is not required.
After selecting the method to report a problem, you can specify information to help describe the issue. In the Specify Problem Details screen:
a. Enter a brief description that summarizes the problem. Once you enter the information for this mandatory field the remaining fields become editable.
b. Optionally enter a support case number.
c. Select the date when the problem occurred.
d. Enter an approximate time when the problem occurred.
e. Enter a description that characterizes the problem.
After finishing, the bundle is created on the server(s) and uploaded. You can view the status of the most recent problem report from Server>Property>Problem Report.
After clicking Finish, the problem reporting function reports the issue for either a single server, or for each server in an entire site. Each server generates the problem report as a background task and uploads it to the CIS server (or, alternately, saves the file to a shared network drive).
The Status field displays information indicating the state of the reporting mechanism; once the process starts, use the Done button to dismiss the dialog to allow the process to continue in the background:
If you choose not to dismiss the dialog, the process continues in the foreground; once completed, the Problem Report screen provides additional information stating “Check each Server’s Properties for results.” With this message, each server has completed the problem report generation process and saves the results (report generation success or failure).
Once the problem report is generated, you can view the results in the Properties screen. To view the report, select Server>Properties:
The Problem Report tab displays:
- Most recent problem report. This field displays the date and time of the most recent problem report attempt.
- Summary. This field describes the problem; it’s generated from the mandatory summary field specified when the administrator first created the report.
Status. Describes the status of the most recent report. It indicates:
- Success or failure
- Whether the report was uploaded or saved to a shared network drive; if the report was saved to a drive, the full path where the file is located is displayed.