SystemOptionsServicesGetConfig Method |
Retrieves the all entries of System Options, in a 2 level deep tree structure
Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.5.94
SyntaxReturn Value
Type: XHRServiceResponseGenericSystemOptionsConfigContainerAll System Options entries in a tree structure.
Examples
Sample JSON return
JavaScript
{
"code": 0,
"error": null,
"message": {
"name": "System Options",
"id": "SysOptRoot",
"children": [{
"__type": "SystemOptions_container:#IngeniuxCMService",
"name": "Dynamic Site Server Configuration",
"id": "RTSettingsRoot",
"children": [{
"__type": "SystemOptions_setting:#IngeniuxCMService",
"name": "Global Variables Configuration",
"id": "globalVariables",
"children": null,
"desc": "Manage Global Variable values for Dynamic Content Placements. Each Global Variable can be unique values for specific Publishing Targets.",
"navName": "Global Variables",
"type": "setting",
"contextDisplayItem": null,
"displayItems": [{
"__type": "SystemOptions_globalVariablesListing:#IngeniuxCMService",
"name": "",
"id": "globalVariablesConfig",
"defaultValue": null,
"displayItems": null,
"field": "globalVariables",
"groupName": null,
"type": "globalVariablesListing",
"validation": null
}]
}, {
"__type": "SystemOptions_container:#IngeniuxCMService",
"name": "Server Variables",
"id": "serverVariables",
"children": [{
"__type": "SystemOptions_setting:#IngeniuxCMService",
"name": "Default Server Variables Selection",
"id": "serverVariablesConfig",
"children": null,
"desc": "Select the default HTTP server variables to be included in the IGX_Info element of expanded page XML.",
"navName": "Default Variables",
"type": "setting",
"contextDisplayItem": null,
"displayItems": [{
"__type": "SystemOptions_multiselect:#IngeniuxCMService",
"name": "Available Default Server Variables",
"id": "serverVariablesSelect",
"defaultValue": null,
"displayItems": null,
"field": "serverVars",
"groupName": null,
"type": "multiselect",
"validation": null,
"ajaxArgs": [""],
"ajaxName": "getPossibleServerVariables",
"identifier": null,
"returnName": null,
"sortable": false
}]
}, {
"__type": "SystemOptions_setting:#IngeniuxCMService",
"name": "Custom Server Variables Configuration",
"id": "customServerVariablesConfig",
"children": null,
"desc": "Manage custom server variables to be included in the XML element IGX_Info during page rendering.",
"navName": "Custom Variables",
"type": "setting",
"contextDisplayItem": null,
"displayItems": [{
"__type": "SystemOptions_editablelist:#IngeniuxCMService",
"name": null,
"id": "customServerVariablesAdd",
"defaultValue": null,
"displayItems": null,
"field": "customServerVars",
"groupName": null,
"type": "editablelist",
"validation": [{
"display": "alert",
"message": "Could not save! {0} is a duplicated value.",
"type": "NoDuplicatesMsg"
}, {
"display": "alert",
"message": "Invalid characters. Please use only letters, numbers, and underscores and dashes.",
"type": "InvalidChars"
}],
"columns": [{
"name": "Custom Server Variables",
"editable": true,
"field": "name",
"relWidth": 2,
"selectable": true,
"singleClickEdit": true
}],
"labelKey": null
}]
}],
"desc": "Configure the server variables to be included in the expanded page XML during page rendering.",
"navName": "",
"type": "container"
}, {
"__type": "SystemOptions_setting:#IngeniuxCMService",
"name": "DSS Cache Configuration",
"id": "RtCacheSettings",
"children": null,
"desc": "Change caching settings for DSS sites",
"navName": "Cache",
"type": "setting",
"contextDisplayItem": null,
"displayItems": [{
"__type": "SystemOptions_checkbox:#IngeniuxCMService",
"name": "Enable Cache",
"id": "rtCacheOn",
"defaultValue": null,
"displayItems": null,
"field": "isOn",
"groupName": null,
"type": "checkbox",
"validation": null,
"disable": [{
"disableIds": "rtCacheGroup",
"type": "IsFalse"
}]
}, {
"__type": "SystemOptions_group:#IngeniuxCMService",
"name": null,
"id": "rtCacheGroup",
"children": null,
"desc": "",
"navName": "",
"type": "group",
"contextDisplayItem": null,
"displayItems": [{
"__type": "SystemOptions_textbox:#IngeniuxCMService",
"name": "Trigger File:",
"id": "triggerFile",
"defaultValue": null,
"displayItems": null,
"field": "triggerFile",
"groupName": null,
"type": "textbox",
"validation": [{
"display": "notification",
"message": "Cannot be blank!",
"type": "IsEmpty"
}]
}, {
"__type": "SystemOptions_textbox:#IngeniuxCMService",
"name": "Cache Page Size (Bytes): ",
"id": "cachePageSize",
"defaultValue": null,
"displayItems": null,
"field": "cachePageSize",
"groupName": null,
"type": "textbox",
"validation": [{
"display": "notification",
"message": "Page Size must be a number.",
"type": "IsNotNum"
}, {
"display": "notification",
"message": "Cannot be blank!",
"type": "IsEmpty"
}]
}, {
"__type": "SystemOptions_numberspinner:#IngeniuxCMService",
"name": "Cache Page Count:",
"id": "cachePageCount",
"defaultValue": null,
"displayItems": null,
"field": "cachePageCount",
"groupName": null,
"type": "numberspinner",
"validation": null,
"delta": 1,
"max": 0,
"min": 0
}, {
"__type": "SystemOptions_horizontallayout:#IngeniuxCMService",
"name": null,
"id": "groupButtonLayoutSelector",
"children": null,
"desc": "",
"navName": "",
"type": "horizontallayout",
"contextDisplayItem": null,
"displayItems": [{
"__type": "SystemOptions_radiobutton:#IngeniuxCMService",
"name": "Never Expire",
"id": "rtChacheNeverExpire",
"defaultValue": null,
"displayItems": null,
"field": "neverExpire",
"groupName": null,
"type": "radiobutton",
"validation": null
}, {
"__type": "SystemOptions_radiobutton:#IngeniuxCMService",
"name": "Expire in (Seconds):",
"id": "expireTime",
"defaultValue": null,
"displayItems": [{
"__type": "SystemOptions_numberspinner:#IngeniuxCMService",
"name": null,
"id": "expireTimeNumSelector",
"defaultValue": null,
"displayItems": null,
"field": "expireTime",
"groupName": null,
"type": "numberspinner",
"validation": null,
"delta": 1,
"max": 0,
"min": 1
}],
"field": "doesExpire",
"groupName": null,
"type": "radiobutton",
"validation": null
}]
}]
}]
}, {
"__type": "SystemOptions_setting:#IngeniuxCMService",
"name": "Dynamic Site Server Logging",
"id": "rtLogging",
"children": null,
"desc": "Enter the path and file name of your DSS log. Example: C:\\IGXLogs\\igxxmlsrv.log",
"navName": "",
"type": "setting",
"contextDisplayItem": null,
"displayItems": [{
"__type": "SystemOptions_textbox:#IngeniuxCMService",
"name": "File Name:",
"id": "rtLoggingFileName",
"defaultValue": null,
"displayItems": null,
"field": "rtFileName",
"groupName": null,
"type": "textbox",
"validation": null
}, {
"__type": "SystemOptions_dropdown:#IngeniuxCMService",
"name": "Logging Level:",
"id": "rtLogLevel",
"defaultValue": null,
"displayItems": null,
"field": "logLevel",
"groupName": null,
"type": "dropdown",
"validation": null,
"ajaxArgs": null,
"ajaxName": null,
"identifier": null,
"returnName": null,
"sortable": false,
"dropDownData": [{
"name": "Errors",
"id": "0"
}, {
"name": "Warnings",
"id": "1"
}, {
"name": "Informational",
"id": "2"
}, {
"name": "Debug",
"id": "3"
}]
}]
}, {
"__type": "SystemOptions_setting:#IngeniuxCMService",
"name": "Allow Transform Configuration",
"id": "allowTFRM",
"children": null,
"desc": "Change whether XSL transformation is allowed.",
"navName": "Allow Transform",
"type": "setting",
"contextDisplayItem": null,
"displayItems": [{
"__type": "SystemOptions_checkbox:#IngeniuxCMService",
"name": "Allow Transform?",
"id": "allowTFRMCB",
"defaultValue": null,
"displayItems": null,
"field": "allowTFRM",
"groupName": null,
"type": "checkbox",
"validation": null,
"disable": null
}]
}],
"desc": "Configure the common settings for Dynamic Site Server published by this CMS instance.",
"navName": "Dynamic Site Server",
"type": "container"
}],
"desc": "Use the System Options tree on the left to select and configure CMS system settings. Each node in the System Options tree controls a specific part of the CMS.",
"navName": "",
"type": "container"
}
}See Also