Get started

This article walks you through the process of setting up the Citrix ITSM Adapter service.

Preparations

To set up the ITSM Adapter service, make sure you have the following things ready:

  • An account with system administrator permission to your ServiceNow instance

    After the service is set up, you can implement role-based access control on it. For more information, see Access management.

  • An active subscription to Citrix DaaS

    You can also sign up for a free trial. For more information, see Verify you’ve subscribed to Citrix DaaS.

  • A Citrix Cloud administrator account with Full access

  • Connectivity between your ServiceNow instance and the IP address of the region where your Citrix Cloud account is located

    Citrix Cloud region IP address
    US 52.158.218.132/30
    EU 20.54.214.12/30
    Asia Pacific 20.195.2.68/30

Verify you’ve subscribed to Citrix DaaS

Sign in to Citrix Cloud or sign up for a new account.

If you have an active subscription to Citrix DaaS or signed up for a free trial, the ITSM Adapter service appears in the My Services list. Otherwise, check with your Citrix representatives.

Citrix Cloud

Tip:

The Manage button is available only when your organization has the valid subscription to Citrix DaaS Premium Edition. Before that, Request Demo is displayed.

Step 1: Install the Citrix ITSM Connector plug-in in ServiceNow

Install the Citrix ITSM Connector plug-in on your ServiceNow instance.

  1. Sign in to your ServiceNow Service Management Portal.

  2. Verify you’ve activated the ServiceNow Orchestration plug-in.

    If any dependency is missing on your ServiceNow instance, you’re prompted to install.

    Prompt for dependencies

  3. Install the Citrix IT Service Management Connector plug-in for your ServiceNow instance:

    1. In the left pane, select All Available Applications > All. To quickly locate the menu, type Applications in the Filter navigator field.

    2. On the All applications page that appears, search for Citrix in the search bar.

      Install an ITSM connector

    3. In the search results, locate Citrix IT Service Management Connector, and then click Install.

    4. Follow the onscreen instructions to complete the installation.

    Note:

    To verify you download the latest version of the Citrix ITSM connector plug-in, click Other App Versions.

Step 2: Configure the Citrix ITSM Connector plug-in

Configure the plug-in to set up its connection with Citrix Cloud.

Steps:

  1. Create the authentication credentials in Citrix Cloud.
  2. Add the authentication credentials to the plug-in.

Starting with the ITSM Adapter service version 22.3.0, a single ServiceNow instance can manage apps and desktops in multiple Citrix Cloud accounts.

Create the authentication credentials in Citrix Cloud

To communicate with Citrix Cloud, the Citrix ITSM connector plug-in must have the authentication credentials that the Citrix Cloud generates.

Create the authentication credentials in each Citrix Cloud account that you want to manage.

Steps:

  1. Sign in to Citrix Cloud, and then select the Citrix Cloud account you want to manage.

  2. Create a Secure Client for the Citrix ITSM connector plug-in. For more information, see Get started with Citrix Cloud APIs.

    Secure Client ID and Secret

  3. Store the Secure Client ID and Secret in a safe place.

  4. If you have more Citrix Cloud accounts to manage, repeat steps 1–3 for each.

Add the authentication credentials to the plug-in

After you create the authentication credentials in your Citrix Cloud account, add them to the ITSM Connector plug-in. The plug-in uses the credentials to set up the connection with Citrix Cloud.

  1. Sign in to your ServiceNow Service Management Portal.

  2. In the left pane, select Citrix IT Service Management Connector > Home.

  3. On the Get started with your Citrix Cloud integration page that appears, click Connect.

    ITSM ServiceNow authentication

  4. In the Citrix Cloud Authentication dialog that appears, type the pair of Secure Client ID and Secret that you created in your Citrix Cloud account. For more information, see Create the authentication credentials in Citrix Cloud.

  5. Click Test to test the connection to your Citrix Cloud account.

  6. Save the configuration.

    An acknowledgment from ServiceNow appears, indicating that the connection is up and running.

    ITSM connector is up and running

  7. If you have more Citrix Cloud accounts to manage, follow these steps for each:

    1. Click Add customer.
    2. Repeat steps 4–6.

After the configuration completes, the ServiceNow instance automatically connects to Citrix Cloud using the provided authentication credentials. When you sign in to Citrix Cloud and go to the ITSM Adapter for ServiceNow > Manage page, you can see all instances that have set up connections with Citrix Cloud.

ServiceNow list

Those instances are in Unregistered status, indicating that Citrix Cloud hasn’t registered with them.

Decommission a Citrix account

To decommission a Citrix Cloud account from your ServiceNow instance, on the Home page, click the ellipsis and then click Decommission.

Note:

To completely remove Citrix ITSM data for a Citrix Cloud account, decommission the account. Manually deleting or editing an account might leave residual data in your environment.

Step 3: Register Citrix Cloud with your ServiceNow instance

To enable Citrix Cloud to send alerts and notifications to your ServiceNow instance, register Citrix Cloud with your ServiceNow instance by providing the following details:

  • URL of your ServiceNow instance

  • Authentication credentials that your ServiceNow instance generates

Starting with the ITSM Adapter service version 22.3.0, a single ServiceNow instance can manage multiple Citrix Cloud accounts. If you have multiple Citrix Cloud accounts to manage, add your ServiceNow information to each.

Steps:

  1. Sign in to Citrix Cloud, and then select the Citrix Cloud account you want to manage.

  2. On the ITSM Adapter for ServiceNow tile, click Manage. The IT Service Management Adapter page appears.

  3. Click the Manage tab. All instances that have established connections with Citrix Cloud appear.

  4. Locate the ServiceNow instance that you want to register with, and then select Register from the ellipsis menu. The following page appears with the URL of the ServiceNow instance automatically filled.

    Add a ServiceNow Instance

    Alternatively, you can click Add a ServiceNow Instance to start the registration.

  5. Follow the onscreen instructions to have ServiceNow generate an OAuth endpoint for the Citrix Cloud account:

    1. Copy the Redirect URL provided in the instructions.
    2. Open a new tab in your browser to access your ServiceNow Service Management Portal.
    3. In the Portal, create an OAuth endpoint for the Citrix Cloud account. You must enter the Redirect URL copied in step a when creating the endpoint. For more information, see Create an OAuth Endpoint for a Citrix Cloud account.
  6. Return to the tab that has the Add a ServiceNow Instance in Citrix Cloud dialog open and enter the required OAuth credentials:

    • (Optional) Enter a descriptive name for the ServiceNow instance.
    • Enter the OAuth endpoint details (Client ID and Client Secret) generated in step 5.
    • (Optional) To use a ServiceNow service account for ServiceNow login and registration authorization, turn on Use ServiceNow Service Account, and then enter the user ID and password.

    Fill in the field values for your ServiceNow instance

  7. If you didn’t turn on Use ServiceNow Service Account in step 6, follow these steps to use a ServiceNow user account to log in to ServiceNow and authorize the registration:

    1. Click Connect. Your ServiceNow instance login page appears.

    2. Type the user name and password of your ServiceNow account, and then click Log in. A page appears, requesting your permission for the ITSM Adapter service to connect to this ServiceNow account in your ServiceNow instance.

      Requesting a permission to connect to ServiceNow

    3. Click Allow. You’re taken back to the Add a ServiceNow Instance in Citrix Cloud dialog.

      The Add a ServiceNow Instance in Citrix Cloud dialog

  8. If you turned on Use ServiceNow Service Account in step 6, click Validate to verify the service account credentials.

    Fill in the field values for your ServiceNow instance 2

    Note:

    Data sent from Citrix DaaS to ServiceNow through the OAuth endpoint-authenticated channel is stored in the ServiceNow database. The corresponding database records clearly indicate that they were created by the user account that you used for ServiceNow login and registration authorization.

  9. Click Save instance. The ITSM Adapter service starts testing the connections with the Citrix ITSM connector. If the test completes successfully, the status of the instance changes to Registered.

    A ServiceNow Instance added

    Tip:

    If the instance status appears as ServiceNow Instance Unauthorized, check for expired OAuth credentials and reauthenticate if needed by selecting Re-authenticate from the ellipsis menu.

  10. If you have more Citrix Cloud accounts to manage, repeat steps 1–9 for each.

After you complete the preceding steps successfully, IT help desks and end users can now access the Citrix ITSM services.

Register with a different ServiceNow instance

A Citrix Cloud account can be registered only with one ServiceNow instance. To register it with a different ServiceNow instance, first unregister the existing one.

  1. On the Manage page of the ITSM Adapter service, click the ellipsis next to the existing ServiceNow instance.
  2. Select Unregister.
  3. To register Citrix Cloud with a different ServiceNow service instance, locate the instance record and then select Register from the ellipsis.
  4. Follow the onscreen instructions to complete the procedure.

Create an OAuth Endpoint for a Citrix Cloud account

In your ServiceNow instance, create an OAuth Endpoint (including a Client ID and a Client Secret) for a Citrix Cloud account.

Steps:

  1. Sign in to your ServiceNow Service Management Portal.

  2. In the left pane, select System OAuth > Application Registry. To quickly locate the menu, type oauth in the Filter navigator field.

  3. On the Application Registries page, click New next to Application Registries.

    Create an OAuth endpoint in ServiceNow

  4. On the OAuth application page that appears, select Create an OAuth API endpoint for external clients.

  5. On the Application Registries New record page that appears, create an OAuth endpoint:

    1. Type a name for the OAuth endpoint.
    2. Click the lock icon next to the Redirect URL field, and then type the Redirect URL that was prompted in the Add a ServiceNow Instance in Citrix Cloud dialog.
    3. Click Submit.
  6. On the Application Registries page that appears, locate the OAuth endpoint that you created.

  7. Click the OAuth endpoint name to open its detail page.

    OAuth endpoint details

  8. Store the Client ID and Client Secret.

  9. Return to the Citrix Cloud console to continue the remaining steps.

Step 4: (Optional) Add on-premises sites to Citrix Cloud through site aggregation

To manage apps and desktops in your on-premises Citrix Virtual Apps and Desktops sites, add them to your Citrix Cloud account.

Steps:

  1. Click the Manage tab. The Manage page appears with the following sites listed:

    • The Citrix DaaS site that is connected to your Citrix Cloud account. By default, the site has the ITSM Adapter service enabled. To disable the management, click the ellipsis next to the Citrix DaaS site.

    • The on-premises sites that you’ve added to Citrix Cloud through site aggregation. To add more Add on-premises sites to Citrix Cloud, see Citrix Workspace documentation - Site aggregation.

    The manage tab

  2. On the Manage page, locate an on-premises site as needed, and then select Manage Credentials from the ellipsis.

    Select Manage Credentials

  3. Type the credentials of the full administrator of the site.

  4. Click Test to check the connection.

    You’re prompted when the site is running and connected to the ITSM Adapter service.

  5. Click Save.

  6. Repeat steps 2–5 on each on-premises site that you want the service to manage.