Class ecm.model.admin.SettingsConfig
Extends
ecm.model.admin._ConfigurationObject.
Represents the configuration information for an application setting. These settings encompass global
settings beyond the scope of a desktop or a repository. For example, this class can represent the
following settings:
- Logging settings including the level, the classes to be included and excluded, the debug users, and the debug hosts.
- A flag that indicates whether autocomplete is disabled
- A list of the administrators
For an IBM Content Manager OnDemand application, the ConfigurationObject
class can also
represent:
- The language
- The temporary directory
- The trace directory, level, and maximum file size
- A list of custom properties
Defined in: <ecm\model\admin\SettingsConfig.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
Method Summary
Method Attributes | Method Name and Description |
---|---|
constructor(id, name)
|
|
CMC time to live.
|
|
Gets the encryption key for the application.
|
|
getFileTypeList(callback, params)
|
|
Gets the help url.
|
|
getSettingsConfig(callback, params)
|
|
setAdminUsers(users)
|
|
setCMCTTL(cmcTTL)
|
|
setCulturalCollation(culturalCollation)
|
|
setCustomProperties(customProps)
|
|
setDaejaRedactionLogFile(daejaRedactionLogFile)
|
|
setDaejaRedactionTrace(daejaRedactionTrace)
|
|
setDaejaRedactionTraceNet(daejaRedactionTraceNet)
|
|
setDaejaStreamerLogFile(daejaStreamerLogFile)
|
|
setDaejaStreamerTrace(daejaStreamerTrace)
|
|
setDaejaStreamerTraceNet(daejaStreamerTraceNet)
|
|
setDaejaViewONEProTrace(daejaViewONEProTrace)
|
|
setDaejaViewONEProTraceAnnotations(daejaViewONEProTraceAnnotations)
|
|
setDaejaViewONEProTraceNet(daejaViewONEProTraceNet)
|
|
setDaejaVirtualLogFile(daejaVirtualLogFile)
|
|
setDaejaVirtualTrace(daejaVirtualTrace)
|
|
setDaejaVirtualTraceAnnotations(daejaVirtualTraceAnnotations)
|
|
setDaejaVirtualTraceNet(daejaVirtualTraceNet)
|
|
setDisableAutocomplete(disableAutocomplete)
|
|
setEncryptionKey(value)
Sets the encryption key for the application.
|
|
setFileTypes(fileTypes)
|
|
setHelpUrl(value)
Sets the help url.
|
|
setLoggingClassExcludes(loggingClassExcludes)
|
|
setLoggingClassIncludes(loggingClassIncludes)
|
|
setLoggingDebugHosts(loggingDebugHosts)
|
|
setLoggingDebugUsers(loggingDebugUsers)
|
|
setLoggingLevel(loggingLevel)
|
|
setODAfp2pdfInstalldir(afp2pdfInstalldir)
|
|
setODLanguage(language)
|
|
setODMaxTraceFilesize(maxTraceFilesize)
|
|
setODTempdir(tempdir)
|
|
setODTracedir(tracedir)
|
|
setODTracelevel(tracelevel)
|
|
setOfficeLoggingClassExcludes(officeLoggingClassExcludes)
|
|
setOfficeLoggingClassIncludes(officeLoggingClassIncludes)
|
|
setOfficeLoggingDebugHosts(officeLoggingDebugHosts)
|
|
setOfficeLoggingDebugUsers(officeLoggingDebugUsers)
|
|
setOfficeLoggingFileSize(officeLoggingFileSize)
|
|
setOfficeLoggingLevel(officeLoggingLevel)
|
|
setOfficeShowStacktraceOnDialogs(officeShowStacktraceOnDialogs)
|
|
setTaskManagerServiceEnabled(enabled)
|
|
setTempfileCleanupInterval(value)
|
|
<static> |
ecm.model.admin.SettingsConfig.SettingsConfig.createSettingsConfig(id)
Static function that constructs a application setting config object.
|
updateSettingsConfig(callback, params)
|
Field Detail
ENCRYPTION_KEY
- Since:
- 2.0.3
HELP_URL
- Since:
- 2.0.3
Method Detail
constructor(id, name)
- Parameters:
- id
- name
getAdminUsers()
getCMCTTL()
CMC time to live. unit in seconds default is 10 hours.
getCulturalCollation()
getCustomProperties()
getDaejaRedactionLogFile()
getDaejaRedactionTrace()
getDaejaRedactionTraceNet()
getDaejaStreamerLogFile()
getDaejaStreamerTrace()
getDaejaStreamerTraceNet()
getDaejaViewONEProTrace()
getDaejaViewONEProTraceAnnotations()
getDaejaViewONEProTraceNet()
getDaejaVirtualLogFile()
getDaejaVirtualTrace()
getDaejaVirtualTraceAnnotations()
getDaejaVirtualTraceNet()
getDisableAutocomplete()
getEncryptionKey()
Gets the encryption key for the application.
- Since:
- 2.0.3
- Returns:
- a string value of the encryption key.
getFileTypeList(callback, params)
- Parameters:
- callback
- params
getFileTypes()
getHelpUrl()
Gets the help url.
- Since:
- 2.0.3
getLoggingClassExcludes()
getLoggingClassIncludes()
getLoggingDebugHosts()
getLoggingDebugUsers()
getLoggingLevel()
getODAfp2pdfInstalldir()
getODLanguage()
getODMaxTraceFilesize()
getODTempdir()
getODTracedir()
getODTracelevel()
getOfficeLoggingClassExcludes()
getOfficeLoggingClassIncludes()
getOfficeLoggingDebugHosts()
getOfficeLoggingDebugUsers()
getOfficeLoggingFileSize()
getOfficeLoggingLevel()
getOfficeShowStacktraceOnDialogs()
getSettingsConfig(callback, params)
- Parameters:
- callback
- params
getTaskManagerHeartBeatMonitorEnabled()
- Since:
- 2.0.3
getTaskManagerLogDirectory()
- Since:
- 2.0.3
getTaskManagerServiceEnabled()
- Since:
- 2.0.3
getTaskManagerServiceURL()
- Since:
- 2.0.3
getTempfileCleanupInterval()
getTempfileExpirationInterval()
setAdminUsers(users)
- Parameters:
- users
setCMCTTL(cmcTTL)
- Parameters:
- cmcTTL
setCulturalCollation(culturalCollation)
- Parameters:
- culturalCollation
setCustomProperties(customProps)
- Parameters:
- customProps
setDaejaRedactionLogFile(daejaRedactionLogFile)
- Parameters:
- daejaRedactionLogFile
setDaejaRedactionTrace(daejaRedactionTrace)
- Parameters:
- daejaRedactionTrace
setDaejaRedactionTraceNet(daejaRedactionTraceNet)
- Parameters:
- daejaRedactionTraceNet
setDaejaStreamerLogFile(daejaStreamerLogFile)
- Parameters:
- daejaStreamerLogFile
setDaejaStreamerTrace(daejaStreamerTrace)
- Parameters:
- daejaStreamerTrace
setDaejaStreamerTraceNet(daejaStreamerTraceNet)
- Parameters:
- daejaStreamerTraceNet
setDaejaViewONEProTrace(daejaViewONEProTrace)
- Parameters:
- daejaViewONEProTrace
setDaejaViewONEProTraceAnnotations(daejaViewONEProTraceAnnotations)
- Parameters:
- daejaViewONEProTraceAnnotations
setDaejaViewONEProTraceNet(daejaViewONEProTraceNet)
- Parameters:
- daejaViewONEProTraceNet
setDaejaVirtualLogFile(daejaVirtualLogFile)
- Parameters:
- daejaVirtualLogFile
setDaejaVirtualTrace(daejaVirtualTrace)
- Parameters:
- daejaVirtualTrace
setDaejaVirtualTraceAnnotations(daejaVirtualTraceAnnotations)
- Parameters:
- daejaVirtualTraceAnnotations
setDaejaVirtualTraceNet(daejaVirtualTraceNet)
- Parameters:
- daejaVirtualTraceNet
setDisableAutocomplete(disableAutocomplete)
- Parameters:
- disableAutocomplete
setEncryptionKey(value)
Sets the encryption key for the application.
- Parameters:
- value
- Since:
- 2.0.3
setFileTypes(fileTypes)
- Parameters:
- fileTypes
setHelpUrl(value)
Sets the help url.
- Parameters:
- value
- Since:
- 2.0.3
setLoggingClassExcludes(loggingClassExcludes)
- Parameters:
- loggingClassExcludes
setLoggingClassIncludes(loggingClassIncludes)
- Parameters:
- loggingClassIncludes
setLoggingDebugHosts(loggingDebugHosts)
- Parameters:
- loggingDebugHosts
setLoggingDebugUsers(loggingDebugUsers)
- Parameters:
- loggingDebugUsers
setLoggingLevel(loggingLevel)
- Parameters:
- loggingLevel
setODAfp2pdfInstalldir(afp2pdfInstalldir)
- Parameters:
- afp2pdfInstalldir
setODLanguage(language)
- Parameters:
- language
setODMaxTraceFilesize(maxTraceFilesize)
- Parameters:
- maxTraceFilesize
setODTempdir(tempdir)
- Parameters:
- tempdir
setODTracedir(tracedir)
- Parameters:
- tracedir
setODTracelevel(tracelevel)
- Parameters:
- tracelevel
setOfficeLoggingClassExcludes(officeLoggingClassExcludes)
- Parameters:
- officeLoggingClassExcludes
setOfficeLoggingClassIncludes(officeLoggingClassIncludes)
- Parameters:
- officeLoggingClassIncludes
setOfficeLoggingDebugHosts(officeLoggingDebugHosts)
- Parameters:
- officeLoggingDebugHosts
setOfficeLoggingDebugUsers(officeLoggingDebugUsers)
- Parameters:
- officeLoggingDebugUsers
setOfficeLoggingFileSize(officeLoggingFileSize)
- Parameters:
- officeLoggingFileSize
setOfficeLoggingLevel(officeLoggingLevel)
- Parameters:
- officeLoggingLevel
setOfficeShowStacktraceOnDialogs(officeShowStacktraceOnDialogs)
- Parameters:
- officeShowStacktraceOnDialogs
setTaskManagerHeartBeatMonitorEnabled(enabled)
- Parameters:
- enabled
- Since:
- 2.0.3
setTaskManagerLogDirectory(dir)
- Parameters:
- dir
- Since:
- 2.0.3
setTaskManagerServiceEnabled(enabled)
- Parameters:
- enabled
- Since:
- 2.0.3
setTaskManagerServiceURL(url)
- Parameters:
- url
- Since:
- 2.0.3
setTempfileCleanupInterval(value)
- Parameters:
- value
setTempfileExpirationInterval(value)
- Parameters:
- value
<static> ecm.model.admin.SettingsConfig.SettingsConfig.createSettingsConfig(id)
Static function that constructs a application setting config object.
- Parameters:
- id
- Settings identifier
updateSettingsConfig(callback, params)
- Parameters:
- callback
- params