Configuration API
KbaEntryRest
| Field name | Description |
|---|---|
| id | the kba unique identifier |
| name | the name given ti to the kba |
| modifiedBy | the user name of the last person who modified the kb |
| modifiedOn | the time in milisenconds when the kb was modified the last time |
| modifiedOnH | the time in a readable format when the kb was modified the last time |
| processKb | the id of the kb used in this kba |
| comment | a user comment to describe this kba |
| categories | the list of categories related to this kba |
| visibilty | indicates if the kba is visible for every one (PUBLIC) or if it just visible for authorised users (RESTRICTED) |
| summaryCheckListType | the type of summary panel it uses (NONE, PANEL, HIDDEN_PANEL or POPUP) |
| extensionConfiguration | the configuration of the extensions at kba level, this configuration can override the extension configuration at server level |
| serverSideSave | boolean value that indicates if this kba allows the pause consultation functionality where the state of the consultation is saved on the server |
| xmlImportStrategy | strategy to load the bookmark, it can be NONE, the bookmark is disabled, AUTO_PROCESS, it opens the bookmark and takes you to the first non answered question or PREFILL, it shows you all the questions with the prefilled value |
| bookmarkConfiguration | is a list of variables names confgured to be saved on the bookmark everytime a bookmark is generated |
| processKbName | the name of the kb used in this kba |
| visualizationConfiguration | ui configurations to render the view in a specific way |
| feedbackConfiguration | the configuration to be able to send feedback emails |
| uiConfiguration | it defines some properties that alter the way the UI is rendered |
Example:
{
"id":"031d33e3-22c6-4589-bedb-b7709250a8b3",
"name":"Test Summary",
"processKb":"fa3753d0-b204-4411-9bb8-8e1edff80bf3",
"comment":null,
"modifiedBy":"admin",
"modifiedOn":1441360475924,
"modifiedOnH":"2015-09-04 11:54:35",
"categories":[
],
"visibility":"RESTRICTED",
"summaryChecklistType":"PANEL",
"extensionConfiguration":{
"MatchBackendExtension":{
"icon":null,
"name":"Match Database Extension",
"version":1,
"applicationConfigurationItem":[
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"document":{
"icon":null,
"name":"documentConf",
"version":1,
"applicationConfigurationItem":[
{
"name":"pageMargins",
"explanation":"Configuration items related to the page margins",
"subOptions":[
{
"name":"HtmlWidth",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
},
{
"name":"MarginBottom",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
},
{
"name":"MarginLeft",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
},
{
"name":"MarginRight",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
},
{
"name":"MarginTop",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":null,
"mandatory":true,
"type":null
}
]
}
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"forwardExtension":{
"icon":null,
"name":"forwardExtension",
"version":1,
"applicationConfigurationItem":[
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"dashboard":{
"icon":null,
"name":"Dashboard Extension",
"version":3,
"applicationConfigurationItem":[
{
"name":"Prefix",
"value":null,
"defaultValue":null,
"explanation":"Prefix to acces diferent schema",
"validationRegex":null,
"mandatory":false,
"type":null
},
{
"name":"Database name",
"value":null,
"defaultValue":null,
"explanation":"Name of the database",
"validationRegex":null,
"mandatory":false,
"type":null
}
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
},
"email":{
"icon":null,
"name":"SmtpServer",
"version":1,
"applicationConfigurationItem":[
{
"name":"pageMargins",
"explanation":"Configuration items related to the page margins",
"subOptions":[
{
"name":"HtmlWidth",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
},
{
"name":"MarginBottom",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
},
{
"name":"MarginLeft",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
},
{
"name":"MarginRight",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
},
{
"name":"MarginTop",
"value":"0",
"defaultValue":"0",
"explanation":"",
"validationRegex":"^[0-9]{1,}$",
"mandatory":true,
"type":null
}
]
}
],
"serverConfigurationItem":null,
"mappingFiles":null,
"disabled":false
}
},
"serverSideSave":null,
"xmlImportStrategy":"PREFILL",
"bookmarkConfiguration":null,
"processKbName":"Test summary.mplx",
"visualizationConfiguration":null,
"feedback":null,
"uiConfiguration":null
}