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:

Admin policy

Sample policy

{
    "settings": {
        "Value": {
            "settings_version": "1.0",
            "engine_settings": {
                "customVC": [ 
                    { // Must be repeated for each virtual channel to be added. Up to 20 custom virtual channels are supported.
                     "appId": "<third_party_chrome_app_id1> or
                    <html=https://<webserver>:<port>/<resource>>",                   
                     "streamName": "<virtual channel name>" // Here, CTXPING, Mix, or CTXOVER based on the VC you want to try.
                    } 
                ]
            }
        }
    }
}
<!--NeedCopy-->

Verification

  • On chrome OS device open browser and enter chrome://policy in URL.
  • Scroll down to “Citrix Workspace” section and verify that all updated policies are reflecting.
  • In case of policies are not updated , click Reload policies.
{
    "settings": {
        "Value": {
            "settings_version": "1.0",
            "engine_settings": {
                "customVC": [ 
                    { 
                     "appId": "bghephdihhfjoonfnmdglleaepihecho", 
                     "streamName": "CTXPING" 
                    },
                    { 
                     "appId": "html=https://127.0.0.1:8000/Thirdparty.html", 
                     "streamName": "CTXMIX" 
                    } 
                ]
            }
        }
    }
}
<!--NeedCopy-->

Global App Config service

Sample setting

{
    "category": "CustomVC",
    "userOverride": false,
    "assignedTo": [
        "AllUsersNoAuthentication"
    ],
    "settings": [{
        "name": "custom virtual channels",
        "value": [{
                "Id of the Chrome 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 Chrome App implementing the custom vc": "html=https://127.0.0.1:8000/Thirdparty.html"
                "Virtual Channel Name ": "CTXPING"
            }
        ]
    }]
}
<!--NeedCopy-->
Configure