Get started

Building a server-side example using Nmake

Examples of the latest server-side executables are available for testing. You can download the latest Windows Virtual Channel SDK to develop the server-side component.

Building a client-side example

To build an example, you need to configure the virtual channels, and host the third-party code on the webserver as follows:

• Step 1 - Configuring the Citrix Workspace app.
• Step 2 - Loading a sample virtual channel app.
• Step 3 - Running an example virtual channel.

Go to the downloads page to view examples and a detailed guide on configuring the sample.

Step 1 - Configuring the Citrix Workspace app

Use one of the following configuration methods:

• Admin policy
• Global App Config service

Step 2 - Loading a sample virtual channel app

The sample apps illustrate a third-party implementation of the Virtual Channel SDK. You can make the virtual channel resources available for the Citrix Workspace app by the following two-step process.

a) Third-party code as a Chrome extension

Citrix provides Chrome packaged apps for each of the example virtual channel in the form of Chrome extensions. You can load the apps using the following steps.

1. Download and extract V3 sample code (CitrixWorkspaceAppChromeVCSDK_XX.X.X.X_Examples->VC_SDK_Chrome_Extension_samples->V3) to folder ‘V3’.
2. Open new tab in Chrome browser.
3. Open chrome://extensions .
4. Ensure that the Developer mode is enabled.
5. Click on load unpacked extensions.
6. Point to the third-party sample app in the folder ‘V3’ (for example, Ping)
7. You can see the app Id which needs to be used to configure Workspace app.

b) Hosting third-party code on the webserver

Citrix also provides sample third-party code for each example virtual channel that can be hosted on a webserver. The following steps illustrate how to host the file on a local server:

1. Download and extract the HTML5 sample (CitrixWorkspaceAppChromeVCSDK_XX.X.X.X_Examples > html5Sample) to the folder html5Sample.
2. Copy the folder html5Sample onto your webserver and host it with the ‘https’ protocol.
3. Open the Google Chrome browser and enter the webserver URL https://<webserverurl>/Thirdparty.html.
4. Verify if the webserver URL is accessible through the browser.
5. Configure the webserver URL through Citrix Workspace app.

Note:

All third-party implementations of the Virtual Channel SDK must implement the window.onmessage event listener, and must validate the origin of the event and then pass the event to citrix.receiver.onMessage.

window.onmessage = (event) => {
    /*
    if(event.origin == "https://trustworty-url.com" && // check for trustworthy URL
       event.data.source ==="CITRIX" &&
       event.data.destination === "VCSDK"){
    }
     */
};
<!--NeedCopy-->

Step 3 - Running an example virtual channel

Verify the following:

• Custom VC configurations are properly maintained in the Citrix Workspace app.
• Third-party resources are available.

Start the session using Citrix Workspace app for ChromeOS and run the server-side executable after the preceding steps are completed.