Skip to content

Configure

Each custom virtual channel has a virtual channel stream Name (streamName) and virtual channel code resources information (appId) as part of the configuration.

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>"} 
] 
}; 

Verification

  • Configuration.js saved successfully.
  • Example:
var HTML5_CONFIG = { 
..... 
..... 
"customVC": [  
        {  
           "appId": "html=https://127.0.0.1:8000/Thirdparty.html",  
           "streamName": "CTXPING"  
       }  
       ] 
}; 

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>" 
            } 
        ] 
    }] 
}  

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" 
            } 
        ] 
    }] 
} 
Was this article helpful?