Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This server-side API class allows extending provides methods to extend the Engine Management functionality.

getAllEngines()


This Use this method gets to get all engines in a list.

Return:

TypeDescription
Array of StringsThis method returns a A list of engines as a string array.

Example:

Code Block
languagejs
themeEclipse
titlegetAllEngines
linenumberstrue
ss.importIncludeScript('SimpleEngine'); 
ss.info(SimpleEngine.getAllEngines());

getEngineOption(optionName)


This Use this method returns to return the engine option by the specified name specified.

Parameter(s):

NameTypeMandatoryDefault value
optionNameStringYN

Return:

TypeDescription
SimpleEngine objectThe object containing This method returns the object that contains the engine option.

Example:

Code Block
languagejs
themeEclipse
titlegetEngineOption
linenumberstrue
ss.importIncludeScript('SimpleEngine'); 
const engine = new SimpleEngine('Following Engine')
ss.info(engine.getEngineOption('Active'))

getOptionValueForTable(optionName, tableName)


This Use this method gets to get the engine option values for the specified table specified.

Parameter(s):

NameTypeMandatoryDefault value
optionNameStringYN
tableNameStringYN

Return:

TypeDescription
StringThe This method returns the engine option value for the specified table specified.

Example:

Code Block
languagejs
themeEclipse
titlegetOptionValueForTable
linenumberstrue
ss.importIncludeScript('SimpleEngine'); 
const engine = new SimpleEngine('Following Engine')
ss.info(engine.getOptionValueForTable('Active', 'itsm_inquiry')) // TRUEtrue

isEngineEnable(tableName)


This Use this method verifies to verify if the engine is enabled for the specified table specified.

Parameter(s):

NameTypeMandatoryDefault value
tableNameStringYN

Return:

TypeDescription
BooleanIf an engine is enabled for the specified table is specified, the method returns true: otherwise, it returns false.

Example:

Code Block
languagejs
themeEclipse
titleisEngineEnable
linenumberstrue
ss.importIncludeScript('SimpleEngine'); 
const engine = new SimpleEngine('Following Engine')
if (engine.isEngineEnable('itsm_inquiry')) {
  ss.info('Following Engine enabled on itsm_inquiry');
} else {
  ss.info('Following Engine disabled on itsm_inquiry');
}


Table of Contents
absoluteUrltrue
classfixedPosition