Citrix(R) Unified Workspace API - Single Page Application (SPA) sample built with .Net Core and Javascript
This is a simple implementation of a Single Page Application (SPA) that shows how to interact with the Citrix(R) Unified Workspace APIs to build a functional web portal. It is a pure javascript implementation that is hosted by a C# ASP .NET server.
It uses the provided sample Token Management Service (TMS) as its backend to handle OAuth tokens, and once it's received a token it will call the Workspace APIs.
This is purely an example and shouldn't be used for real production services.
- You have either a Private or Public Workspace OAuth Client
- You will be running the example code in Visual Studio and can run .NET 7.0
- You have the Citrix Workspace App installed
To run this example, you must first be running the TMS. See the instructions here.
You will need to configure the TMS Frontend settings in the appsettings.Development.json as follows:
"FrontEnd": {
"FrontEndRedirectUrl": "https://localhost:7183/",
"FrontEndCorsOrigin": "https://localhost:7183"
}This is because the SPA is configured to run on https://localhost:7183.
The SPA code assumes that you are running the TMS on https://localhost:7182 and if you want to change that, you'll need to update the code in app.js and index.html.
Before running the SPA example, you will need to set the Application ID at the top of app.js to be the application ID for the OAuth client you have created in the Citrix Cloud Admin Console.
The C# server provides the backend and hosts the html and javascript files, and also provides endpoints for performing authorization. See Token Management Service for details on how the flow occurs.
- Recommend using an Incognito browser to avoid cookie and cache causing problems.
Once started, you should be directed to the login page:
At this point, enter your customer.cloud.com address and click 'login'.
It should direct you to the standard login flow and after entering your login details it will take you to the home page:
Clicking on the resources should initiate a launch:
This sequence diagram illustrates the API calls the example Single Page Application (SPA) and the Token Management Service (TMS) will make during the initial page load, login, resource enumeration and resource launch.
The SPA frontend implementation uses simple javascript without any framework. For a more complicated application, implementers should consider using a framework such as Angular or React (see https://learn.microsoft.com/en-us/aspnet/core/client-side/spa/angular and https://learn.microsoft.com/en-us/aspnet/core/client-side/spa/react for info on integrating these frameworks with aspnet). This will also allow for proper package management of the javascript libraries.
The implementation retrieves the access token and stores it inside a private javascript closure. There are more secure alternatives involving web worker threads, or to simply have all token calls be handled by the backend (as in the Citrix.Unified.Api.Test.WebClient example).
This example supports three types of Application/ Desktop launch via Workspace, native, HTML5 and IFrame.
You can switch between the launch types using the dropdown:
Native launches work by calling the native Citrix Workspace Application (CWA) with a launch ticket that can be obtained from the launchstatus endpoint, returned as part of the resource enumeration. This response contains the URL to redirect the user to.
This launch flow is detailed in the sequence diagram above.
HTML5 and IFrame launches work similarly to each other. These launch methods make use of the Citrix HTML5 HDX SDK. This SDK uses the ICA file which contains information about how a connection should be established. An ICA file can be obtained from the launchica endpoint, returned as part of the resource enumeration.
Source code to launch a resource in a new tab. For more information check the SDK documentation
citrix.receiver.setPath("https://localhost:7183/receiver");
let icaFile = await apiHandler.get(launchUrl)
const sessionId = "html5"
const connectionParams = {
"launchType": "newtab",
"container": {
"type": "window"
}
};
function sessionCreated(sessionObject){
const launchData = {"type": "ini", value: icaFile.data};
sessionObject.start(launchData);
}
citrix.receiver.createSession(sessionId, connectionParams,sessionCreated);The repo includes the following javascript libraries,
- Axios, https://axios-http.com/
- Handlebars, https://handlebarsjs.com/
- jQuery, https://jquery.com/
- Semantic UI CSS, https://semantic-ui.com/
- Citrix HTML5 HDX SDK, https://developer-docs.citrix.com/en-us/citrix-workspace-app-for-html5/workspace-app-html5-hdx-sdx/hdx-sdk-html5
Copyright © 2023. Cloud Software Group, Inc. All Rights Reserved.