Citrix ITSM Adapter service

Tables in the Citrix ITSM connector

When developing your own services, you can use the ServiceNow (SNOW) table APIs to invoke information from tables used in the Citrix ITSM connector plug-in.

The section describes the tables that are available with the Citrix ITSM connector plug-in since version 2110.1.0. This section provides the following information for those tables:

  • Table label: Indicates the table name displayed in the ServiceNow Service Management Portal.
  • Table name: Indicates the table name in the database.
  • Table columns: List table columns in the database table.

Available tables

The following tables are available in the Citrix ITSM connector plug-in:

Table Label Table Name Description
Citrix Customer x_cion_citrix_it_s_citrix_customers Lists customer information.
Citrix Alert x_cion_citrix_it_s_citrix_alert Lists alerts that originate from Citrix components.
Citrix Cloud Notification Policies x_cion_citrix_it_s_citrix_notification_policy Lists notification policies for retrieving notifications from Citrix Cloud.
Citrix ITSM Access Given x_cion_citrix_it_s_citrix_itsm_access_given Lists parameters used to request the ITSM Adapter service.
Citrix ITSM AD Groups x_cion_citrix_it_s_citrix_itsm_ad_groups Lists AD groups of the customer.
Citrix ITSM Application Group x_cion_citrix_it_s_citrix_itsm_application_group Lists application groups of the customer.
Citrix ITSM Applications x_cion_citrix_it_s_ctx_applications Lists applications available to the customer.
Citrix ITSM Delivery Group x_cion_citrix_it_s_citrix_itsm_desktop_group Lists delivery groups of the customer.
Citrix ITSM Machine Catalogs x_cion_citrix_it_s_citrix_itsm_machine_catalogs Lists machine catalogs of the customer.
Citrix VM Resize Option x_cion_citrix_it_s_vm_resize_options Lists VM resize options of the customer.
Citrix ITSM OS Configurations x_cion_citrix_it_s_citrix_itsm_os_configurations Lists the available OS configurations.
Citrix ITSM Sites x_cion_citrix_it_s_citrix_itsm_sites Lists ITSM sites in your deployment.
Citrix Notification x_cion_citrix_it_s_citrix_notification Lists notifications from Citrix Cloud.
Citrix Virtual Apps and Desktops Alert Policies x_cion_citrix_it_s_citrix_alert_policy Lists alert policies from Citrix Virtual Apps and Desktops.
Deprovisioning List x_cion_citrix_it_s_citrix_deprovision Lists deprovisioning requests.
User Requests x_cion_citrix_it_s_citrix_requests Lists user requests.
Citrix VDAs x_cion_citrix_it_s_citrix_vdis Lists VDA machines and machine details in your deployment.
Data Import Policies x_cion_citrix_it_s_data_import_policy Lists settings for Data Import Policies.
ADM Alert x_cion_citrix_it_s_adm_alert Lists alerts from Citrix Application Delivery Management (ADM) service.
ADM Event Policy x_cion_citrix_it_s_adm_alert_policies Lists event policies for retrieving events from ADM service.
Citrix Cloud Health Incident x_cion_citrix_it_s_citrix_cloud_health_incident Lists Citrix Cloud health incidents.
Citrix Cloud Health Incident Policy x_cion_citrix_it_s_citrix_cloud_health_incident_policy Lists Citrix Cloud health incident policies.
Citrix Maintenance Window x_cion_citrix_it_s_citrix_events_maintenance_window Lists the Citrix maintenance window.

Table label: Citrix Customer

This table lists customer information.

Table name

x_cion_citrix_it_s_citrix_customers

Table columns

Column name Column label Type Reference Max length
citrix_customer_api_url Citrix Customer API URL URL NA 1024
citrix_itsm_api_url Citrix ITSM API URL URL NA 1024
customer_id Customer ID String NA 40
citrix_cloud_client_id Citrix Cloud Client ID String NA 40
token_timestamp Token Timestamp Date/Time NA 40
enable_ad_operation_via_itsm Enable AD Operation via ITSM True/False NA 40
credential_header Credential Header String NA 200
ad_password AD Password Password NA 255
last_data_sync Last Data Sync Date NA 40
secret_expiration_time Secret Expiration Time Date/Time NA 40
token_state Token State String NA 40
user_unique_identity User Unique Identity Choice NA 40
ad_account AD Account String NA 40
citrix_authentication_api_url Citrix Authentication API URL URL NA 1024
citrix_cloud_client_secret Citrix Cloud Client Secret Password NA 255
token Token Password NA 2000
customer_domain Customer Domain String NA 40
enable_remote_powershell Enable Remote Powershell True/False NA 40
custom_user_unique_identity Custom User Unique Identity String NA 40
enable_data_auto_deletion Enable Data Auto-Deletion True/False NA 40
display_name Display Name String NA 40
auto_renew_principal_secret Auto Renew Principal Secret True/False NA 40
organization_id Organization ID String NA 40
days_of_retention Days of Retention Integer NA 40

Table label: Citrix Alert

This table lists alerts that originate from Citrix components.

Table name

x_cion_citrix_it_s_citrix_alert

Table columns

Column name Column label Type Reference Max length
id Id String NA 40
customer Customer Reference Citrix Customers 32
category Category String NA 64
comment Comment String NA 1024
condition Condition String NA 128
description Description String NA 1024
incident Incident Reference Incident 32
policy_name Policy Name Reference Citrix Virtual Apps and Desktops Alert Policies 40
priority Priority String NA 40
site Site Reference Citrix ITSM Sites 40
state State String NA 40
sub_category Sub Category String NA 64
target Target String NA 128
trigger_value Trigger Value String NA 40
type Type String NA 40
data Data String NA 4000

Table label: Citrix Cloud Notification Policies

This table lists the notification policies that IT Admin creates to retrieve notifications from Citrix Cloud.

Table name

x_cion_citrix_it_s_citrix_notification_policy

Table columns

Column name Column label Type Reference Max length
customer Customer Reference Citrix Customers 32
policy_name Policy Name String NA 128
uid Uid String NA 40
create_incident Create Incident True/False NA 40
enabled Enabled True/False NA 40
name Name String NA 40
priority Priority List NA 1024
severity Severity String NA 1024
description Description String NA 8192
title Title String NA 256
policy_priority Policy Priority Integer NA 40
service_now_action Service Now Action String NA 32
category Category String NA 64
impact Impact String NA 40
urgency Urgency String NA 40
assign_to Assign To Reference User 32
assign_to_group Assignment Group Reference Group 32
active Active True/False NA 40

Table label: Citrix ITSM Access Given

This table lists the parameters that are used to request the ITSM Adapter service.

Table name

x_cion_citrix_it_s_citrix_itsm_access_given

Table columns

Column name Column label Type Reference Max length
admin_account Admin Account String NA 40
admin_password Admin Password Password (2 Way Encrypted) NA 255
ad_group AD Group Reference Citrix ITSM AD Groups 100
application_group Application Group Reference Citrix ITSM Application Group 32
delivery_group Delivery Group Reference Citrix ITSM Delivery Group 100
machine_catalog Machine Catalog Reference Citrix ITSM Machine Catalogs 32
ritm RITM Reference Requested Item 32
site Site Reference Citrix ITSM Sites 32
customer Customer Reference Citrix Customer 32
site_id Site ID String NA 100
tuuid TUUID String NA 200
users Users List User 1024

Table label: Citrix ITSM AD Groups

This table lists AD groups of the customer.

Table name

x_cion_citrix_it_s_citrix_itsm_ad_groups

Table columns

Column name Column label Type Reference Max length
customer Customer Reference Citrix Customers 32
name Name String NA 128
active Active True/False NA 40

Table label: Citrix ITSM Application Group

This table lists that application groups of the customer.

Table name

x_cion_citrix_it_s_citrix_itsm_application_group

Table columns

Column name Column label Type Reference Max length
customer Customer Reference Citrix Customers 32
ad_groups AD Groups List Citrix ITSM AD Groups 4000
name Name String NA 128
uuid UUID String NA 40
active Active True/False NA 40

Table label: Citrix ITSM Applications

This table lists applications that are available to the customer.

Table name

x_cion_citrix_it_s_ctx_applications

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
ad_groups AD Groups List Citrix ITSM AD Groups 4000  
ad_group_for_auto_approve AD Groups for Automatic Approval List Citrix ITSM AD Groups 4000  
application_groups Application Groups List Citrix ITSM Application Groups 4000  
application_group_for_auto_approve Application Groups for Automatic Approval List Citrix ITSM Application Groups 4000  
availability_for_requests Available for Requests True/False NA 40 false
delivery_group_for_auto_approve Delivery Groups for Automatic Approval List Citrix ITSM Delivery Group 4000  
delivery_groups Delivery Groups List Citrix ITSM Delivery Group 4000  
enable_auto_approve Enable Automatic Approval True/False NA 40 false
limit_visibility Limit Visibility List Citrix ITSM AD Groups 4000  
name Application Name String NA 128  
published_name Published Name String NA 128  
site Site Reference Citrix ITSM Sites 32  
uuid UUID String NA 40  
description Description String NA 1024  
active Active True/False NA 40 true

Table label: Citrix ITSM Delivery Group

This table lists delivery groups of the customer.

Table name

x_cion_citrix_it_s_citrix_itsm_desktop_group

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
ad_groups AD Groups List Citrix ITSM AD Groups 4000  
allocation_type Allocation Type String NA 64  
days_of_idling_before_alerts Days of idling before alerts Integer NA 40 30
days_of_idling_before_deprovisioning Days of idling before deprovisioning Integer NA 40 45
delivery_type Delivery Type String NA 64  
desktops_available Desktops Available Integer NA 40  
desktops_inuse Desktops InUse Integer NA 40  
desktops_unregistered Desktops Unregistered Integer NA 40  
enable_deprovisioning Enable Deprovisioning True/False NA 40 false
isremotepc IsRemotePC True/False NA 40 false
name Name String NA 128  
sessions Sessions Integer NA 40  
session_support Session Support String NA 64  
total_desktops Total Desktops Integer NA 40  
uuid UUID String NA 40  
auto_deprovision Automatic Deprovisioning True/False NA 40  
in_maintenance_mode In Maintenance Mode True/False NA 40  
description Description String NA 1024  
deprovision_type Deprovision Type Choice NA 40 Remove the desktop
active Active True/False NA 40 true

Table label: Citrix ITSM Machine Catalogs

This table lists machine catalogs of the customer.

Table name

x_cion_citrix_it_s_citrix_itsm_machine_catalogs

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
minimum_functional_level Minimum Functional Level String NA 100  
name Name String NA 128  
description Description String NA 1024  
provisioning_type Provisioning Type String NA 100  
scopes Scopes String NA 100  
session_support Session Support String NA 100  
zone_name Zone Name String NA 100  
uuid UUID String NA 40  
resize_type Resize Type List VM Resize Option 4000  
hypervisor_type Hypervisor Type String NA 40  
enable_vm_resize Enable VM Resize True/False NA 40 false
active Active True/False NA 40 true

Table label: Citrix VM Resize Option

This table lists VM resize option of the customer.

Table name

x_cion_citrix_it_s_vm_resize_options

Table columns

Column name Column label Type Reference Max length Default value
name Name String NA 128  
memory Memory Integer NA 40  
full_path Full Path String NA 400  
cpu_architecture_type CPU Architecture Type String NA 64  
cores Cores Integer NA 40  
associate_machine_catalogs Associate Machine Catalogs List Citrix ITSM Machine Catalogs 4000  

Table label: Citrix ITSM OS Configurations

This table lists the available OS configurations.

Table name

x_cion_citrix_it_s_citrix_itsm_os_configurations

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
add_to_ad_group Add to AD Group Instead True/False NA 40 false
ad_group_for_auto_approve AD Group for Automatic Approval Reference Citrix ITSM AD Groups 32  
allocation_type Allocation Type String NA 40  
availability_for_requests Available for Requests True/False NA 40 false
delivery_group Delivery Group List Citrix ITSM Delivery Group 32  
enable_auto_approve Enable Automatic Approval True/False NA 40 false
machine_catalog Machine Catalog Reference Citrix ITSM Machine Catalogs 32  
os_type OS Type String NA 100  
os_version OS Version String NA 40  
published_name Published Name String NA 128  
site Site Reference Citrix ITSM Sites 32  
uuid UUID String NA 40  
active Active True/False NA 40 true
description Description String NA 1024  

Table label: Citrix ITSM Sites

This table lists ITSM sites in your deployment.

Table name

x_cion_citrix_it_s_citrix_itsm_sites

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
site_id Site ID String NA 128  
site_name Site Name String NA 128  
active Active True/False NA 40 true

Table label: Citrix Notification

This table lists notifications from Citrix Cloud.

Table name

x_cion_citrix_it_s_citrix_notification

Table columns

Column name Column label Type Reference Max length
customer Customer Reference Citrix Customers 32
categories Categories String NA 4000
component Component String NA 128
create_date Create Date String NA 40
description Description String NA 1024
detail_uri Detail Uri String NA 1024
id Id String NA 1024
notification_state Notification State String NA 40
policies Policy List Citrix Cloud Notification Policies 4000
priority Priority String NA 40
severity Severity String NA 40
title Title String NA 1024
incident Incident Reference Incident 32

Table label: Citrix Virtual Apps and Desktops Alert Policies

This table lists alert policies from the Citrix Virtual Apps and Desktops.

Table name

x_cion_citrix_it_s_citrix_alert_policy

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
assign_to Assign to Reference User 32  
assign_to_group Assignment Group Reference Group 32  
category Category String NA 40 inquiry
create_incident Create Incident True/False NA 40 false
create_incidents_for Create Incidents for String NA 40 Critical
create_incident_for_critical_alerts_only Create Incidents for Critical Alerts Only True/False NA 40 false
description Description String NA 1024  
impact Impact Integer NA 40 3
urgency Urgency Integer NA 40 3
monitor Monitor True/False NA 40  
id Id String NA 100  
policy_name Policy Name String NA 256  
scope Scope String NA 128  
site Site Reference Citrix ITSM Sites 32  
target_kind Target Kind String NA 64  
uid UID String NA 40  
webhook Webhook URL NA 1024  
enable_analysis Enable Analysis True/False NA 40 true
send_to_event_management Send to Event Management True/False NA 40 true
active Active True/False NA 40 true

Table label: Deprovisioning List

This table lists deprovisioning requests.

Table name

x_cion_citrix_it_s_citrix_deprovision

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
allocation_type Allocation Type String NA 64  
associated_user Associated User String NA 128  
delivery_group Delivery Group String NA 128  
identify_code Identify Code String NA 64  
last_connection_time Last Connection Time String NA 40  
last_connection_user Last Connection User String NA 40  
machine_catalog Machine Catalog String NA 128  
machine_name Machine Name String NA 128  
os_type OS Type String NA 64  
power_state Power State String NA 64  
registration_state Registration State String NA 64  
state State String NA 40  
unused_days Unused Days Integer NA 40  
user User String NA 32  
uuid UUID String NA 100  

Table label: User Requests

This table lists user requests.

Table name

x_cion_citrix_it_s_citrix_requests

Table columns

Column name Column label Type Reference Max length Default value
requested_item Requested Item Reference Requested Item 32  

Table label: Citrix VDAs

This table lists the VDA machines and machine details in your deployment.

Table name

x_cion_citrix_it_s_citrix_vdis

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
associatedusernames AssociatedUserNames String NA 128  
catalogname CatalogName String NA 128  
desktopgroupname DesktopGroupName String NA 128  
dnsname DNSName String NA 128  
hostedmachineid HostedMachineId String NA 128  
hostedmachinename HostingServerName String NA 40  
hypervisorconnectionname HypervisorConnectionName String NA 128  
ipaddress IPAddress String NA 40  
isassigned IsAssigned String NA 40  
lastconnectiontime LastConnectionTime String NA 40  
lastconnectionuser LastConnectionUser String NA 128  
lastderegistrationreason LastDeregistrationReason String NA 1024  
lastderegistrationtime LastDeregistrationTime String NA 40  
machinename MachineName String NA 128  
ostype OSType String NA 128  
osversion OSVersion String NA 64  
powerstate PowerState String NA 64  
zonename ZoneName String NA 64  
provisioningtype ProvisioningType String NA 64  
registrationstate RegistrationState String NA 64  
sessionsupport SessionSupport String NA 64  
sid SID String NA 40  
site Site Reference Citrix ITSM Sites 128  
uuid UUID String NA 40  
hostingservername HostingServerName String NA 128  

Table label: Data Import Policies

This table lists settings for Data Import Policies.

Table name

x_cion_citrix_it_s_data_import_policy

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
daily_start_time Daily Run Time Choice NA 40 08:00Z
enabled Enabled True/False NA 40 true
license_type License Type String NA 40 UserDevice
optional_fields Optional Fields List NA 4000  
policy_name Policy Name String NA 128  
policy_type Policy Type Choice NA 40 Push VDI
pre_needed Pre Needed String NA 40  
pre_type Pre Type String NA 40  
force_update_directly Refresh All Data Immediately True/False NA 40 false
active Active True/False NA 40 true

Table label: ADM Alert

This table lists alerts that originate from Citrix Application Delivery Management (ADM) service.

Table name

x_cion_citrix_it_s_adm_alert

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
category Category String NA 64  
comment Comment String NA 1024  
contact_type Contact Type String NA 40  
description Description String NA 1024  
impact Impact String NA 40  
incident Incident Reference Incident 32  
short_description Short Description String NA 256  
urgency Urgency String NA 40  
state State String NA 40  
sub_category Sub Category String NA 64  
policy Policy Reference Citrix ADM Event Policy 32  

Table label: ADM Event Policy

This table lists the event policies that IT Admin creates to retrieve events from ADM service.

Table name

x_cion_citrix_it_s_adm_alert_policies

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
uid Uid String NA 40  
name Policy Name String NA 128  
priority Policy Priority Integer NA 40  
category Category String NA 64  
severity Severity List NA 1024  
failure_object Failure Object String NA 256  
region Region String NA 40  
information Information String NA 256  
action ServiceNow Action String NA 40  
incident_category Incident Category String NA 40 2
impact Impact String NA 40 2
urgency Urgency String NA 40  
assign_to Assign To Reference User 32  
assign_to_group Assignment Group Reference Group 32  
active Active True/False NA 40 true

Table label: Citrix Cloud Health Incident

This table lists Citrix Cloud health incidents.

Table name

x_cion_citrix_it_s_citrix_cloud_health_incident

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
title Title String NA 128  
event_status Event Status String NA 40  
priority Priority String NA 40  
affected_services Affected Services String NA 1024  
latest_message Latest Message String NA 256  
messages Messages String NA 1024  
event_start_at Event Start At String NA 40  
event_end_at Event End At String NA 40  
event_id Event Id String NA 40  
event_type Event Type String NA 40  
policy Policy Reference Citrix Cloud Health Incident Policy 40  
incident Incident Reference Incident 32  

Table label: Citrix Cloud Health Incident Policy

This table lists the Citrix Cloud health incident policies.

Table name

x_cion_citrix_it_s_citrix_cloud_health_incident_policy

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
uid Uid String NA 40  
name Policy Name String NA 128  
policy_priority Policy Priority Integer NA 40  
servicename Service Name List NA 4000  
region Region List NA 4000  
event_type Event Type String NA 4000  
servicenow_action ServiceNow Action String NA 32 Incident
category Category String NA 64  
impact Impact String NA 40 2
urgency Urgency String NA 40 2
assign_to Assign To Reference User 32  
assign_to_group Assignment Group Reference Group 32  
active Active True/False NA 40 true

Table label: Citrix Maintenance Window

This table lists the Citrix maintenance window.

Table name

x_cion_citrix_it_s_citrix_events_maintenance_window

Table columns

Column name Column label Type Reference Max length Default value
customer Customer Reference Citrix Customers 32  
description Description String NA 1024  
end_time End Time Date/Time NA 40  
start_time Start Time Date/Time NA 40  
repeat Repeat String NA 40 Once