Product documentation
Citrix ITSM Adapter service
View PDF

Configure Citrix ITSM settings

March 16, 2023
Contributed by: 
C

This article provides guidance on how to complete the following administrator tasks:

Required roles

Citrix ITSM administrator role (x_cion_citrix_it_s.ctx_itsm_admin)

Manually sync Citrix DaaS data

The Citrix ITSM connector syncs delivery data from the connected Citrix Cloud accounts to the Studio Dashboard menu. The synchronization occurs every hour. Citrix ITSM administrators can sync the data immediately by using the following steps:

  1. Sign in to your ServiceNow Service Management Portal.

  2. Go to Citrix IT Service Management Connector > Home.

  3. On the Data Synchronization tile, click Refresh Data.

Import Citrix data to ServiceNow

By default, the Citrix ITSM connector imports five types of deployment data from Citrix DaaS to your ServiceNow instance. See View Citrix DaaS deployment information for details. Starting with the Citrix ITSM connector 22.6, you can import more deployment data by configuring Data import policies.

For example, by configuring the policies, you can import VDA and license information from Citrix DaaS to your ServiceNow instance:

Note:

The Citrix ITSM connector provides two ServiceNow tables to store VDA and license information respectively. Developers can invoke those tables when creating custom ITSM workflows or updating your asset information in the Configuration Management Database. For more information, see ServiceNow tables in the Citrix ITSM developer documentation.

Import VDA information

With Data Import Policies, you can import VDA information from your Citrix Cloud accounts to your ServiceNow instance on a daily basis.

To create a data import policy, follow these steps:

  1. Sign in to your ServiceNow Service Management Portal.

  2. Go to Citrix IT Service Management Connector > Configurations > Data Import Policies. The Data Import Policies page appears.

  3. Click New in the upper-right corner. The following page appears.

    Create a data import policy

  4. In the Customer field, select a Citrix Cloud account you want to manage.

  5. In the Policy Name field, enter a descriptive name for the policy.

  6. From the Policy Type list, select Import VDA Info.

  7. In the Optional Fields field, select any additional fields you want to import as follows:

    1. Click the lock icon.
    2. From the list that appears, select the fields to import.
    3. Click the unlock icon to save the changes.

    Note:

    • By default, the policy automatically imports several VDA fields, such as machine name, desktop group name.
    • For the policy to take effect if the Citrix ITSM connector plug-in installed is version 22.6, you must add at least one optional field. To remove this limitation, upgrade the plug-in to version 22.9 or later.
    • Importing more fields consumes more resources on your ServiceNow instance, such as storage capacity, processing power, and network bandwidth.

  8. From the Daily Run Time drop-down list, select the time of day you want the import task to run.

  9. To import VDA to ServiceNow immediately after you create the policy, select Refresh All Data Immediately.

  10. Click Submit.

    A new tab, Published VDI List, appears on the Studio Dashboard page, where IT help desks can view the VDA machine information. The imported VDA data are also stored in the x_cion_citrix_it_s_citrix_vdis database table. For more information, see the Citrix ITSM developer documentation.

After you create a data import policy, the first import loads all the VDA records from the Citrix Cloud account into your ServiceNow instance. Subsequent imports load only the VDA records that have been added since the previous import. If needed, you can refresh existing VDA data in ServiceNow with the latest data from Citrix Cloud.

To refresh VDA data in ServiceNow with the latest data from Citrix Cloud, follow these steps:

  1. Go to Citrix IT Service Management Connector > Configurations > Data Import Policies. The Data Import Policies page appears.

  2. Open a policy as needed.

  3. Select Refresh All Data Immediately.

  4. Click Update.

Import license information

To import daily usage data for Citrix app and desktop licenses, follow these steps:

  1. Go to Citrix IT Service Management Connector > Configurations > Data Import Policies. The Data Import Policies page appears.

  2. Click New in the upper-right corner. The New Record page appears.

  3. In the Customer field, select a Citrix Cloud account you want to manage.

  4. In the Policy Name field, enter a descriptive name for the policy.

  5. From the Policy Type list, select Import License Info.

  6. From the License Type list, select the license type you want to import.

    For more information, see License types in the Citrix Licensing documentation.

  7. Click Submit.

    The imported license usage data is stored in the x_cion_citrix_it_s_cvad_active_use database table. For more information about this table, see the Citrix ITSM developer documentation. For more information about license usage data, see Monitor licenses and active usage for cloud services in the Citrix Cloud documentation.

Manage Citrix ITSM services

Through the Studio Dashboard menu, you can manage Citrix ITSM services based on apps, desktops, and delivery groups:

Set application and desktop availability for user requests

By default, all published applications and desktops are unavailable for user requests. You can enable their availability as needed. Detailed steps are as follows:

  1. Sign in to your ServiceNow Service Management Portal.

  2. Go to Citrix IT Service Management Connector > Studio Dashboard.

  3. Click the Published Applications or the Published Desktops tab as needed.

  4. Locate an application or desktop, and then click the Published Name field. The application or desktop information page appears.

  5. To make the applications or desktops available for user requests, select Availablility for requests.

  6. To hide the application or desktop from the request list, clear Available for requests.

  7. Click Update.

Enable automatic approval for applications

By default, application requests require manual approval. To save the approval process for an application, you can enable automatic approval for it. Detailed steps are as follows:

  1. Go to Citrix IT Service Management Connector > Studio Dashboard.

  2. Click the Published Applications tab.

  3. Locate an application and click the Published Name field. The application information page appears.

  4. Select Enable Automatic Approval.

  5. Set the rule for adding users to a resource group:

    • AD Group for Automatic Approval. Click the lock icon and then the Add/Move Multiple icon. Active Directory groups that have permission to use this application appear. Follow the onscreen instructions to add groups as needed.
    • Delivery Group for Automatic Approval. Click the lock icon and then the Add/Move Multiple icon. Delivery groups that have permission to use this application appear. Follow the onscreen instructions to add groups as needed.
    • Application Group for Automatic Approval. Click the lock icon and then the Add/Move Multiple icon. Application groups that have permission to use this application appear. Follow the onscreen instructions to add groups as needed.

  6. Click Update.

Enable automatic approval for desktops

By default, desktop requests require manual approval. To speed up the approval process for a desktop, you can enable automatic approval for it. Detailed steps are as follows:

  1. Go to Citrix IT Service Management Connector > Studio Dashboard.

  2. Click the Published Desktops tab.

  3. Locate a desktop and click the Published Name field. The desktop information page appears.

  4. Select Enable Automatic Approval.

  5. To add users to the displayed delivery group, click Update.

  6. To add users to an AD group that has permission to use the desktop, follow these steps:

    1. Select Add AD Group Instead.
    2. From the AD Group for Automatic Approval list, select an AD group as needed. The list displays AD groups that have permission to use the desktop.
    3. Click Update.

Enable deprovisioning of idle desktops

Deprovisioning idle desktops lets resource managers take back idle resources, thus increasing resource utilization. You can enable deprovisioning of idle desktops based on delivery groups. If needed, you can also enable automatic deprovisioning.

Note:

Deprovisioning idle desktops is supported only for static VDI desktops.

Detailed steps are as follows:

  1. Go to Citrix IT Service Management Connector > Studio Dashboard.

  2. Click the Delivery Groups tab.

  3. Locate a delivery group whose Allocation Type field shows Static, and then click the Name field. The information page of the delivery group appears.

    Clicking the name of a delivery group

  4. Select Enable Deprovisioning.

  5. In the Days of Idling Before Alerts field that appears, change the default value if needed.

    When a desktop in the delivery group has been idle for more than the specified days, the desktop appears in the Deprovisioning List menu. Its State field shows Flagged for Deprovisioning, notifying the desktop will soon be ready for deprovisioning. To avoid generating such notifications, set Days of Idling before Alerts to 0.

  6. In the Days of Idling Before Deprovisioning field that appears, change the default value if needed.

    When a desktop in the delivery group has been idle for more than the specified days, the desktop appears in the Deprovisioning List menu. Its State field shows Ready for Deprovisioning.

  7. To enable automatic deprovisioning, select Automatic Deprovisioning, and then select a deprovisioning type:

    • Remove the desktop
    • Keep the desktop but remove the user assignment

  8. Click Update.

Enable remote PowerShell

To support the Run PowerShell scripts on a machine Custom Activity, enable the remote PowerShell feature in the Citrix ITSM connector as follows:

  1. Sign in to your ServiceNow Service Management Portal.

  2. In the left pane, select Citrix IT Service Management Connector > Configurations > Properties. The Citrix Customers page appears, listing Citrix Cloud accounts that you added to the plug-in.

  3. Locate a customer, and then click Display Name. The customer information page appears.

  4. Select Enable Remote PowerShell.

  5. Click Update.

    For more information about this Custom Activity, see Custom Activities and tables.

Note:

Your setting takes effect in 24 hours. For it to take effect immediately, restart Cloud Connectors.

Enable auto-deletion for Citrix alerts and notifications

The Citrix ITSM connector keeps syncing the following data from Citrix Cloud to your ServiceNow instance. To save storage space, you can enable automatic deletion for the data and specify a retention period for it.

  • Alerts from Citrix DaaS and Citrix Virtual Apps and Desktops
  • Notifications from Citrix Cloud
  • Events from Citrix Application Delivery Management (ADM)
  • License usage data from Citrix DaaS

To enable auto-deletion for Citrix data, follow these steps:

  1. Sign in to your ServiceNow Service Management Portal.

  2. In the left pane, select Citrix IT Service Management Connector > Configurations > Properties. The Citrix Customers page appears, listing Citrix Cloud accounts that you added to the plug-in.

  3. Locate a customer, and then click Display Name. The customer information page appears.

  4. Select Enable Data Auto-Deletion.

  5. In the Days of Retention field that appears, enter a retention period, in days.

  6. Click Update.

Enable support for multiple-AD-domain Citrix Cloud accounts

In multiple-AD-domain Citrix Cloud accounts, users are identified by user names and domain names. To enable the ITSM connector plug-in to retrieve user session data from those accounts, select the SAM Account Name or User Principal Name (UPN) as the user-unique identity.

Follow these steps to enable the support:

  1. Sign in to your ServiceNow Service Management Portal.

  2. In the left pane, select Citrix IT Service Management Connector > Configurations > Properties. The Citrix Customers page appears, listing Citrix Cloud accounts that you added to the plug-in.

  3. Locate a customer that has more than one AD domain, and then click Display Name. The customer information page appears.

  4. From the User Unique Identity list, select the field that stores the sAMAccountName or UPN. The options come from the field names in the Organization > Users table.

  5. Click Update to save the change.

  6. For the other multiple-AD-domain customers in the list, repeat steps 3–5 for each.

Configure Citrix ITSM settings
March 16, 2023
Contributed by: 
C
March 16, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.