Plan the integration

Select a target business application for integration, identify integration use-cases, and identify APIs.

There are countless applications that can be integrated into Citrix Workspace. Select a target application that holds information of interest to Citrix Workspace users. Of particular interest are applications that are regularly used for quick tasks and are not intuitively accessible to users. Actionable applications enabling users to directly interact from within Citrix Workspace have much more value than applications that simply enable notification of users. For example, approving, creating, adding.

Select a target business application for integration

Select a target application that holds information of interest to Citrix Workspace users.

Of particular interest are applications that are regularly used for quick tasks and are not intuitively accessible to users. Also, applications that enable users to directly interact (for example, approve items) from within Citrix Workspace have much more value than applications that simply enable notification of users.

If the target system uses JSON REST and any common authentication mechanism (OAuth 2.0, NTLM, Basic Auth, Bearer Auth), chances are good that the system can be integrated with Citrix Workspace seamlessly. To be able to use HTTP integration with your target integration system of records (SoR), ensure your SoR meets the following prerequisites:

  • Your target integration application SOR uses REST API that returns data in the JSON format.

  • Your product supports the use of a service account that can access the data of all users and write back on their behalf in the service actions, possibly two separate accounts.

  • Your product supports fetching all instances of an object from a single endpoint. For example, all Jira tickets can be fetched via GET /search, whereas O365 requires fetching emails user by user.

  • The SOR is populated with representative data (data table autogeneration is done by fetching results and discerning its structure, if the data in the SOR is missing nested JSON fields then tables are not created for them).

  • Your product supports one of the following Auth formats: None, basic, OAuth 2.0, NTLM, or bearer/token authentication. When OAuth 2.0 is available, always use this method as the default to ensure maximum security compliance.

  • Your product supports one of the following forms of pagination: none, page, offset, link, header link, cursor, OData.

Identify integration use-cases and identify APIs

Next, we identify key use-cases for the selected target business application that we want to integrate into Citrix Workspace. This activity is a creative process and needs account for:

  • The potential time savings that can be achieved by integrating the use-case.
  • The effort required to implement the use-case.

Once use-cases are known, the next step is to identify the APIs that allows us to extract relevant information from the target system or inject back into it. This step might well involve back-and-forth iterations to the use-case identification because the target system might not provide suitable APIs to implement a use-case.

The most common API standard today is RESTful APIs, which provide responses formatted using JSON. Nearly all modern enterprise SaaS applications implement APIs like that.

Where to go next

Now that you have your integration planned, create and then configure the integration: