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
	ecm.model.admin.SettingsConfig()

Field Summary

Field Attributes	Field Name and Description
	ADMIN_LDAP_GROUPS
	EDIT_FILES_CLEANUP_INTERVAL
	EDIT_SERVICE_CUSTOM_URL_ENABLED
	EDIT_SERVICE_DOWNLOAD_LINK_ENABLED
	ENCRYPTION_KEY
	HELP_URL
	OFFICE_ONLINE_ENABLED
	SSO_LOGOUT_METHOD_REDIRECT
	SSO_LOGOUT_URL

Method Summary

Method Attributes	Method Name and Description
	constructor(id, name)
	getAdminLdapGroupEnabled()
	getAdminLdapGroups()
	getAdminTeams()
	getAdminUsers()
	getAsperaEnabled()
	getAsperaFileLocation()
	getAsperaPassword()
	getAsperaServerUrl()
	getAsperaUserName()
	getBaseStyle()
	getCMCTTL() CMC time to live.
	getCulturalCollation()
	getCustomProperties()
	getCustomSettings()
	getDisableAutocomplete()
	getEditFilesCleanupInterval()
	getEditServiceCustomURL()
	getEditServiceCustomURLEnabled()
	getEditServiceDownloadLinkEnabled()
	getEncryptionKey() Gets the encryption key for the application.
	getFilePath()
	getFileTypeList(callback, params)
	getFileTypes()
	getHelpUrl() Gets the help url.
	getLdapBindUser()
	getLdapGroupAttribute()
	getLdapGroupBaseDn()
	getLdapGroupSearchFilter()
	getLdapPassword()
	getLdapUrl()
	getLdapUserBaseDn()
	getLdapUserMembershipSearchFilter()
	getLdapUserSearchFilter()
	getLimitedAdminUsers()
	getLoggingClassExcludes()
	getLoggingClassIncludes()
	getLoggingDebugHosts()
	getLoggingDebugUsers()
	getLoggingLevel()
	getMimeTypeExtensionFile()
	getNavigatorMode()
	getNavigatorModeGUI()
	getODAfp2pdfGenericTransform()
	getODAfp2pdfInstalldir()
	getODLanguage()
	getODMaxTraceFilesize()
	getODTempdir()
	getODTracedir()
	getODTracelevel()
	getOfficeLoggingClassExcludes()
	getOfficeLoggingClassIncludes()
	getOfficeLoggingDebugHosts()
	getOfficeLoggingDebugUsers()
	getOfficeLoggingFileSize()
	getOfficeLoggingLevel()
	getOfficeOnlineEnabled()
	getOfficeOnlineServiceURL()
	getOfficeOnlineServiceVerify()
	getOfficeShowStacktraceOnDialogs()
	getSettingsConfig(callback, params)
	getSsoLogOutMethodRedirect()
	getSSOLogOutURL()
	getTaskManagerAdminPassword()
	getTaskManagerAdminUserId()
	getTaskManagerHeartBeatMonitorEnabled()
	getTaskManagerLogDirectory()
	getTaskManagerServiceEnabled()
	getTaskManagerServiceURL()
	getTempfileCleanupInterval()
	getTempfileExpirationInterval()
	getUmsUrl()
	setAdminLdapGroupEnabled(value)
	setAdminLdapGroups(value)
	setAdminTeams(teams)
	setAdminUsers(users)
	setAsperaEnabled(enabled)
	setAsperaFileLocation(value)
	setAsperaPassword(value)
	setAsperaServerUrl(value)
	setAsperaUserName(value)
	setBaseStyle(baseStyle)
	setCMCTTL(cmcTTL)
	setCulturalCollation(culturalCollation)
	setCustomProperties(customProps)
	setCustomSettings(customSettings)
	setDisableAutocomplete(disableAutocomplete)
	setEditFilesCleanupInterval(value)
	setEditServiceCustomURL(url)
	setEditServiceCustomURLEnabled(value)
	setEditServiceDownloadLinkEnabled(value)
	setEncryptionKey(value) Sets the encryption key for the application.
	setFilePath(value)
	setFileTypes(fileTypes)
	setHelpUrl(value) Sets the help url.
	setLdapBindUser(value)
	setLdapGroupAttribute(value)
	setLdapGroupBaseDn(value)
	setLdapGroupSearchFilter(value)
	setLdapPassword(value)
	setLdapUrl(value)
	setLdapUserBaseDn(value)
	setLdapUserMembershipSearchFilter(value)
	setLdapUserSearchFilter(value)
	setLimitedAdminUsers(users)
	setLoggingClassExcludes(loggingClassExcludes)
	setLoggingClassIncludes(loggingClassIncludes)
	setLoggingDebugHosts(loggingDebugHosts)
	setLoggingDebugUsers(loggingDebugUsers)
	setLoggingLevel(loggingLevel)
	setMimeTypeExtensionFile(value)
	setNavigatorMode(mode)
	setNavigatorModeGUI(mode)
	setODAfp2pdfGenericTransform(afp2pdfGenericTransform)
	setODAfp2pdfInstalldir(afp2pdfInstalldir)
	setODLanguage(language)
	setODMaxTraceFilesize(maxTraceFilesize)
	setODTempdir(tempdir)
	setODTracedir(tracedir)
	setODTracelevel(tracelevel)
	setOfficeLoggingClassExcludes(officeLoggingClassExcludes)
	setOfficeLoggingClassIncludes(officeLoggingClassIncludes)
	setOfficeLoggingDebugHosts(officeLoggingDebugHosts)
	setOfficeLoggingDebugUsers(officeLoggingDebugUsers)
	setOfficeLoggingFileSize(officeLoggingFileSize)
	setOfficeLoggingLevel(officeLoggingLevel)
	setOfficeOnlineEnabled(enabled)
	setOfficeOnlineServiceURL(url)
	setOfficeOnlineServiceVerify(verify)
	setOfficeShowStacktraceOnDialogs(officeShowStacktraceOnDialogs)
	setSsoLogOutMethodRedirect(value)
	setSSOLogOutURL(value)
	setTaskManagerAdminPassword(password)
	setTaskManagerAdminUserId(userId)
	setTaskManagerHeartBeatMonitorEnabled(enabled)
	setTaskManagerLogDirectory(dir)
	setTaskManagerServiceEnabled(enabled)
	setTaskManagerServiceURL(url)
	setTempfileCleanupInterval(value)
	setTempfileExpirationInterval(value)
<static>	ecm.model.admin.SettingsConfig.SettingsConfig.createSettingsConfig(id) Static function that constructs a application setting config object.
	setUmsUrl(value)
	updateSettingsConfig(callback, params)

Constructor Detail

ecm.model.admin.SettingsConfig()

Field Detail

ADMIN_LDAP_GROUPS

Since:: 3.0.9

EDIT_FILES_CLEANUP_INTERVAL

Since:: 3.0.1

EDIT_SERVICE_CUSTOM_URL_ENABLED

Since:: 3.0.8

EDIT_SERVICE_DOWNLOAD_LINK_ENABLED

Since:: 3.0.7

ENCRYPTION_KEY

Since:: 2.0.3

HELP_URL

Since:: 2.0.3

OFFICE_ONLINE_ENABLED

Since:: 3.0.0

SSO_LOGOUT_METHOD_REDIRECT

Since:: 3.0.9

SSO_LOGOUT_URL

Since:: 3.0.6 ifix006, 3.0.7 ifix002 and 3.0.8

Method Detail

constructor(id, name)

Parameters:
id
name

getAdminLdapGroupEnabled()

getAdminLdapGroups()

Since:: 3.0.9

getAdminTeams()

getAdminUsers()

getAsperaEnabled()

Since:: 3.0.4

getAsperaFileLocation()

Since:: 3.0.4

getAsperaPassword()

Since:: 3.0.4

getAsperaServerUrl()

Since:: 3.0.4

getAsperaUserName()

Since:: 3.0.4

getBaseStyle()

getCMCTTL()

CMC time to live. unit in seconds default is 10 hours.

getCulturalCollation()

getCustomProperties()

getCustomSettings()

getDisableAutocomplete()

getEditFilesCleanupInterval()

Since:: 3.0.1

getEditServiceCustomURL()

Since:: 3.0.8

getEditServiceCustomURLEnabled()

Since:: 3.0.8

getEditServiceDownloadLinkEnabled()

Since:: 3.0.7

getEncryptionKey()

Gets the encryption key for the application.

Since:: 2.0.3

Returns:: a string value of the encryption key.

getFilePath()

getFileTypeList(callback, params)

Parameters:
callback
params

getFileTypes()

getHelpUrl()

Gets the help url.

Since:: 2.0.3

getLdapBindUser()

getLdapGroupAttribute()

getLdapGroupBaseDn()

getLdapGroupSearchFilter()

getLdapPassword()

getLdapUrl()

getLdapUserBaseDn()

getLdapUserMembershipSearchFilter()

getLdapUserSearchFilter()

getLimitedAdminUsers()

getLoggingClassExcludes()

getLoggingClassIncludes()

getLoggingDebugHosts()

getLoggingDebugUsers()

getLoggingLevel()

getMimeTypeExtensionFile()

getNavigatorMode()

getNavigatorModeGUI()

getODAfp2pdfGenericTransform()

getODAfp2pdfInstalldir()

getODLanguage()

getODMaxTraceFilesize()

getODTempdir()

getODTracedir()

getODTracelevel()

getOfficeLoggingClassExcludes()

getOfficeLoggingClassIncludes()

getOfficeLoggingDebugHosts()

getOfficeLoggingDebugUsers()

getOfficeLoggingFileSize()

getOfficeLoggingLevel()

getOfficeOnlineEnabled()

Since:: 3.0.0

getOfficeOnlineServiceURL()

Since:: 3.0.0

getOfficeOnlineServiceVerify()

Since:: 3.0.1

getOfficeShowStacktraceOnDialogs()

getSettingsConfig(callback, params)

Parameters:
callback
params

getSsoLogOutMethodRedirect()

getSSOLogOutURL()

getTaskManagerAdminPassword()

Since:: 3.0.5.1

getTaskManagerAdminUserId()

Since:: 3.0.5.1

getTaskManagerHeartBeatMonitorEnabled()

Since:: 2.0.3

getTaskManagerLogDirectory()

Since:: 2.0.3

getTaskManagerServiceEnabled()

Since:: 2.0.3

getTaskManagerServiceURL()

Since:: 2.0.3

getTempfileCleanupInterval()

getTempfileExpirationInterval()

getUmsUrl()

setAdminLdapGroupEnabled(value)

Parameters:
value

setAdminLdapGroups(value)

Parameters:
value

setAdminTeams(teams)

Parameters:
teams

setAdminUsers(users)

Parameters:
users

setAsperaEnabled(enabled)

Parameters:
enabled

Since:: 3.0.4

setAsperaFileLocation(value)

Parameters:
value

Since:: 3.0.4

setAsperaPassword(value)

Parameters:
value

Since:: 3.0.4

setAsperaServerUrl(value)

Parameters:
value

Since:: 3.0.4

setAsperaUserName(value)

Parameters:
value

Since:: 3.0.4

setBaseStyle(baseStyle)

Parameters:
baseStyle

setCMCTTL(cmcTTL)

Parameters:
cmcTTL

setCulturalCollation(culturalCollation)

Parameters:
culturalCollation

setCustomProperties(customProps)

Parameters:
customProps

setCustomSettings(customSettings)

Parameters:
customSettings

setDisableAutocomplete(disableAutocomplete)

Parameters:
disableAutocomplete

setEditFilesCleanupInterval(value)

Parameters:
value

Since:: 3.0.1

setEditServiceCustomURL(url)

Parameters:
url

Since:: 3.0.8

setEditServiceCustomURLEnabled(value)

Parameters:
value

Since:: 3.0.8

setEditServiceDownloadLinkEnabled(value)

Parameters:
value

Since:: 3.0.7

setEncryptionKey(value)

Sets the encryption key for the application.

Parameters:
value

Since:: 2.0.3

setFilePath(value)

Parameters:
value

setFileTypes(fileTypes)

Parameters:
fileTypes

setHelpUrl(value)

Sets the help url.

Parameters:
value

Since:: 2.0.3

setLdapBindUser(value)

Parameters:
value

setLdapGroupAttribute(value)

Parameters:
value

setLdapGroupBaseDn(value)

Parameters:
value

setLdapGroupSearchFilter(value)

Parameters:
value

setLdapPassword(value)

Parameters:
value

setLdapUrl(value)

Parameters:
value

setLdapUserBaseDn(value)

Parameters:
value

setLdapUserMembershipSearchFilter(value)

Parameters:
value

setLdapUserSearchFilter(value)

Parameters:
value

setLimitedAdminUsers(users)

Parameters:
users

setLoggingClassExcludes(loggingClassExcludes)

Parameters:
loggingClassExcludes

setLoggingClassIncludes(loggingClassIncludes)

Parameters:
loggingClassIncludes

setLoggingDebugHosts(loggingDebugHosts)

Parameters:
loggingDebugHosts

setLoggingDebugUsers(loggingDebugUsers)

Parameters:
loggingDebugUsers

setLoggingLevel(loggingLevel)

Parameters:
loggingLevel

setMimeTypeExtensionFile(value)

Parameters:
value

setNavigatorMode(mode)

Parameters:
mode

setNavigatorModeGUI(mode)

Parameters:
mode

setODAfp2pdfGenericTransform(afp2pdfGenericTransform)

Parameters:
afp2pdfGenericTransform

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

setOfficeOnlineEnabled(enabled)

Parameters:
enabled

Since:: 3.0.0

setOfficeOnlineServiceURL(url)

Parameters:
url

Since:: 3.0.0

setOfficeOnlineServiceVerify(verify)

Parameters:
verify

Since:: 3.0.1

setOfficeShowStacktraceOnDialogs(officeShowStacktraceOnDialogs)

Parameters:
officeShowStacktraceOnDialogs

setSsoLogOutMethodRedirect(value)

Parameters:
value

setSSOLogOutURL(value)

Parameters:
value

setTaskManagerAdminPassword(password)

Parameters:
password

Since:: 3.0.5.1

setTaskManagerAdminUserId(userId)

Parameters:
userId

Since:: 3.0.5.1

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

setUmsUrl(value)

Parameters:
value

updateSettingsConfig(callback, params)

Parameters:
callback
params