Citrix Virtual Channel SDK for Citrix Workspace app for HTML5
Configure
Each custom virtual channel has a virtual channel stream name (streamName) and virtual channel code resources information (appId) as part of the configuration.
Note:
We recommend using Configuration Utility Tool to generate required configuration through a Graphical user interface. You can find the corresponding guide here.
Use one of the following ways to configure a virtual channel:
Configuration.js
Sample configuration
var HTML5_CONFIG = {
.....
.....
"customVC": [
{
"appId": "<html=https://<webserver>:<port>/<resource>>",
"streamName": "<virtual channel name>"}
]
};
<!--NeedCopy-->
Verification
- Configuration.js saved successfully.
- Example:
var HTML5_CONFIG = {
.....
.....
"customVC": [
{
"appId": "html=https://127.0.0.1:8000/Thirdparty.html",
"streamName": "CTXPING"
}
]
};
<!--NeedCopy-->
Global App Config service
Sample setting
{
"category": "CustomVC",
"userOverride": false,
"assignedTo": [
"AllUsersNoAuthentication"
],
"settings": [{
"name": "custom virtual channels",
"value": [{
"Id of the Html5 App implementing the custom vc":
"<html=https://<webserver>:<port>/<resource>>,"
"Virtual Channel Name ": "<virtual channel name>"
}
]
}]
}
<!--NeedCopy-->
Verification
- PUT request for updating the configuration is successful with ‘204’ status
- Perform a GET request and verify the settings that have been pushed.
For example,
{
"category": "CustomVC",
"userOverride": false,
"assignedTo": [
"AllUsersNoAuthentication"
],
"settings": [{
"name": "custom virtual channels",
"value": [
{
"Id of the Html5 App implementing the custom vc": "html=https://127.0.0.1:8000/Thirdparty.html"
"Virtual Channel Name ": "CTXPING"
}
]
}]
}
<!--NeedCopy-->
Configure
Copied!
Failed!