Class ecm.model.admin.ApplicationConfig

Extends ecm.model.admin._ConfigurationObject.
Represents the configuration information for an application. This information identifies the following components that are used for the application:

Plug-ins
Desktops
Repositories
Menus
Viewers
Servers

In addition, this class maintains the object expiration time and thread sleep time for the application.

Defined in: <ecm\model\admin\ApplicationConfig.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.admin.ApplicationConfig()

Method Summary

Method Attributes	Method Name and Description
	addAdminRoleConfig(adminRoleConfig, callback, extraParams) Adds an admin role configuration object ecm.model.admin.AdminRoleConfig to the application object ecm.model.admin.ApplicationConfig.
	addApplicationDesktopConfig(desktopConfig, callback, desktopAccessConfig, params) Adds a desktop configuration object ecm.model.admin.DesktopConfig to the application object ecm.model.admin.ApplicationConfig.
	addApplicationMenuConfig(menuConfig, callback, extraParams) Adds a menu configuration object ecm.model.admin.MenuConfig to the application object ecm.model.admin.ApplicationConfig.
	addApplicationPluginConfig(pluginConfig, callback, extraParams) Adds a plugin configuration object ecm.model.admin.PluginConfig to the application object ecm.model.admin.ApplicationConfig.
	addApplicationRedactionReasonConfig(redactionReasonConfig, callback, extraParams) Adds a redaction reason configuration object ecm.model.admin.RedactionReasonConfig to the application object ecm.model.admin.ApplicationConfig.
	addApplicationRepositoryConfig(repositoryConfig, callback, extraParams) Adds a repository configuration object ecm.model.admin.RepositoryConfig to the application object ecm.model.admin.ApplicationConfig.
	addApplicationThemeConfig(themeConfig, callback, extraParams) Adds a theme configuration object ecm.model.admin.ThemeConfig to the application object ecm.model.admin.ApplicationConfig.
	addApplicationViewerConfig(viewerConfig, mapping, callback, extraParams) Adds a viewer mapping object ecm.model.admin.ViewerMappingConfig into a viewer configuration object ecm.model.admin.ViewerConfig.
	addChildPluginConfig(pluginConfig, parentId, callback, extraParams) Adds a child plugin configuration object ecm.model.admin.PluginConfig to the plugin object ecm.model.admin.PluginConfig.
	constructor(id, name, action) Constructs a application configuration object and its base class is ecm.model.admin._ConfigurationObject.
	deleteApplicationAdminRoleConfig(adminRoleConfigArray, callback, params) Deletes admin role configuration objects ecm.model.admin.AdminRoleConfig from the application object ecm.model.admin.AdminRoleConfig.
	deleteApplicationDesktopsConfig(desktopConfigArray, callback, params) Deletes desktop configuration objects ecm.model.admin.DekstopConfig from the application object ecm.model.admin.ApplicationConfig.
	deleteApplicationMenusConfig(menuConfigArray, callback, params) Deletes menu configuration objects ecm.model.admin.MenuConfig from the application object ecm.model.admin.ApplicationConfig.
	deleteApplicationPluginsConfig(pluginConfigArray, callback, params) Deletes plugin configuration objects ecm.model.admin.PluginConfig from the application object ecm.model.admin.ApplicationConfig.
	deleteApplicationRedactionReasonConfig(redactionReasonConfigArray, callback, params) Deletes redaction reason configuration objects ecm.model.admin.RedactionReasonConfig from the application object ecm.model.admin.RedactionReasonConfig.
	deleteApplicationRepositoriesConfig(repositoryConfigArray, callback, params) Deletes repository configuration objects ecm.model.admin.RepositoryConfig from the application object ecm.model.admin.ApplicationConfig.
	deleteApplicationThemesConfig(themeConfigArray, callback, params) Deletes theme configuration objects ecm.model.admin.ThemeConfig from the application object ecm.model.admin.ApplicationConfig.
	deleteApplicationViewersConfig(viewerConfigArray, callback, params) Deletes viewer configuration objects ecm.model.admin.ViewerConfig from the application object ecm.model.admin.ApplicationConfig.
	exportConfiguration(objects, callback, extraParams) Exports selected configuration object and associated configuraiton objects.
	getAccessRoleConfig()
	getAdminRoleObjects(callback, params) Gets an array of admin role objects, if any
	getAllLabels(callback, extraParams) Gets all the action labels.
	getApplicationConfig(callback, params) Retrieves the application configuration objects ecm.model.admin.ApplicationConfig.
	getApplicationVersion() Gets the application version number, for example 2.0.3
	getDefaultViewerData(callback, extraParams) Gets viewer definition, content type and mapping configuration to callback method.
	getDesktopName() Gets the default desktop name.
	getDesktopObjects(callback, params) Gets all desktop configuration objects defined in the application object.
	getFeaturesList(desktopId, callback, extraParams) Retrieves the mobile feature list ecm.model.admin.MobileFeatureConfig defined in a desktop configuration object.
	getIconObjects(callback, extraParams) Returns icon objects if any.
	getIconStatusObjects(callback, extraParams) Returns icon status objects if any.
	getInterfaceTextsObjects(callback, extraParams) Gets all ecm.model.admin.InterfaceTextConfig objects defined in the configuration.
	getMenuObjects(callback, params) Gets all menu configuration objects defined in the application object.
	getMenuTypeObjects(callback, extraParams) Gets all menu type configuration objects defined in the application object.
	getMimeAndStateIconObjects(callback, extraParams) Gets icon mapping and icon status objects.
	getObjectExpiration() Gets the object expiration time, unit in minutes.
	getPluginObjects(callback, params) Gets an array of plugin configuration objects if any.
	getRedactionReasonObjects(callback, params) Gets an array of theme configuration objects if any.
	getRepositoryObjects(callback, params) Gets all repository configuration objects defined in the application object.
	getServerObjects(callback, params) Gets an array of server configuration objects.
	getSettingsConfigObject(callback, extraParams) Gets the Settings configuration object.
	getThemeObjects(callback, params) Gets an array of theme configuration objects if any.
	getUIApplicationLabelObjects(callback, extraParams) Gets all ecm.model.admin.InterfaceTextConfig objects defined in the application.
	getViewersObjects(callback, params) Gets an array of viewer configuration objects if any.
	isInitialized() Return a boolean value represent if an application definition has been retrieved
	openNewHelpWindow(file)
	openSupport1HelpWindow(file)
	openSupport2HelpWindow(file)
	setAccessRoleConfig(userId, accessRights)
	setApplicationVersion(value)
	setObjectExpiration(value)
	updateApplicationDesktopConfig(desktopConfig, callback, desktopAccessConfig, params) Updates a desktop configuration object ecm.model.admin.DesktopConfig defined in the application object ecm.model.admin.ApplicationConfig.
	updateApplicationIconMapping(iconMimeMappingData, iconStatusData, callback, extraParams) Updates icon mapping and icon status objects in the same transaction.
	updateApplicationMenuConfig(menuConfig, callback, params) Update a menu configuration object ecm.model.admin.MenuConfig defined in the application object ecm.model.admin.ApplicationConfig.
	updateApplicationObjectExpiration(objectExpiration, callback, extraParams) Updates application's object expiration.
	updateApplicationPluginConfig(pluginConfig, callback, params) Updates a plugin configuration object ecm.model.admin.PluginConfig defined in the application object ecm.model.admin.ApplicationConfig.
	updateApplicationRedactionReasonConfig(redactionReasonConfig, callback, params) Updates a theme configuration object ecm.model.admin.RedactionReasonConfig defined in the application object ecm.model.admin.ApplicationConfig.
	updateApplicationRepositoryConfig(repositoryConfig, callback, params) Updates a repository configuration object ecm.model.admin.RepositoryConfig defined in the application object ecm.model.admin.ApplicationConfig.
	updateApplicationSettingsConfig(settingsConfig, callback, params) Updates a settings configuration object ecm.model.admin.SettingsConfig
	updateApplicationThemeConfig(themeConfig, callback, params) Updates a theme configuration object ecm.model.admin.ThemeConfig defined in the application object ecm.model.admin.ApplicationConfig.
	updateApplicationViewerConfig(viewerConfig, mappingData, callback, params) Updates a viewer configuration object ecm.model.admin.ViewerConfig defined in the application object ecm.model.admin.ApplicationConfig.
	updateFileTypesMapping(fileTypesMappingData, callback, extraParams) Updates file types mapping.

Constructor Detail

ecm.model.admin.ApplicationConfig()

Method Detail

addAdminRoleConfig(adminRoleConfig, callback, extraParams)

Adds an admin role configuration object ecm.model.admin.AdminRoleConfig to the application object ecm.model.admin.ApplicationConfig.

Parameters:
adminRoleConfig: A redaction reason configuration object ecm.model.admin.AdminRoleConfig. It contains an admin role definition.
callback: A callback method if provided will be called with response
extraParams

Since:: 3.0.3

addApplicationDesktopConfig(desktopConfig, callback, desktopAccessConfig, params)

Adds a desktop configuration object ecm.model.admin.DesktopConfig to the application object ecm.model.admin.ApplicationConfig.

Parameters:
desktopConfig: An desktop configuration object ecm.model.admin.DesktopConfig. It contains a desktop definition.
callback: A callback method if provided will be called with response
desktopAccessConfig
params

Since:: 2.0.2 A desktop access configuration object {@link ecm.model.admin.DesktopAccessConfig}. It contains a desktop access definition., ICN 2.0.3.4 passing extra parameters to mid-tier

addApplicationMenuConfig(menuConfig, callback, extraParams)

Adds a menu configuration object ecm.model.admin.MenuConfig to the application object ecm.model.admin.ApplicationConfig.

Parameters:
menuConfig: A menu configuration object ecm.model.admin.MenuConfig. It contains a menu definition.
callback: A callback method if provided will be called with response
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

addApplicationPluginConfig(pluginConfig, callback, extraParams)

Adds a plugin configuration object ecm.model.admin.PluginConfig to the application object ecm.model.admin.ApplicationConfig.

Parameters:
pluginConfig: A plugin configuration object ecm.model.admin.PluginConfig. It contains a plugin definition.
callback: A callback method if provided will be called with response
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

addApplicationRedactionReasonConfig(redactionReasonConfig, callback, extraParams)

Adds a redaction reason configuration object ecm.model.admin.RedactionReasonConfig to the application object ecm.model.admin.ApplicationConfig.

Parameters:
redactionReasonConfig: A redaction reason configuration object ecm.model.admin.RedactionReasonConfig. It contains a redaction reason definition.
callback: A callback method if provided will be called with response
extraParams

Since:: 3.0

addApplicationRepositoryConfig(repositoryConfig, callback, extraParams)

Adds a repository configuration object ecm.model.admin.RepositoryConfig to the application object ecm.model.admin.ApplicationConfig.

Parameters:
repositoryConfig: A Repository configuration object ecm.model.admin.RepositoryConfig. It contains a repository definition.
callback: A callback method if provided will be called with response
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

addApplicationThemeConfig(themeConfig, callback, extraParams)

Adds a theme configuration object ecm.model.admin.ThemeConfig to the application object ecm.model.admin.ApplicationConfig.

Parameters:
themeConfig: A theme configuration object ecm.model.admin.ThemeConfig. It contains a theme definition.
callback: A callback method if provided will be called with response
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier, 2.0.3 *

addApplicationViewerConfig(viewerConfig, mapping, callback, extraParams)

Adds a viewer mapping object ecm.model.admin.ViewerMappingConfig into a viewer configuration object ecm.model.admin.ViewerConfig.

Parameters:
viewerConfig: A Viewer configuration object ecm.model.admin.ViewerConfig. It contains a collection of mapping objects this viewer can handle.
mapping: A Viewer mapping configuration object ecm.model.admin.ViewerMappingConfig.
callback: A callback method if provided will be called with response
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

addChildPluginConfig(pluginConfig, parentId, callback, extraParams)

Adds a child plugin configuration object ecm.model.admin.PluginConfig to the plugin object ecm.model.admin.PluginConfig.

Parameters:
pluginConfig: A plugin configuration object ecm.model.admin.PluginConfig. It contains a plugin definition.
parentId: parent object id.
callback: A callback method if provided will be called with response
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

constructor(id, name, action)

Constructs a application configuration object and its base class is ecm.model.admin._ConfigurationObject.

Parameters:
id: The configuration object id
name: The configuration object name (ie, "ApplicationConfig" or "DesktopConfig")
action: The parameter is omitted therefore using default "admin/configuration".

deleteApplicationAdminRoleConfig(adminRoleConfigArray, callback, params)

Deletes admin role configuration objects ecm.model.admin.AdminRoleConfig from the application object ecm.model.admin.AdminRoleConfig.

Parameters:
adminRoleConfigArray: An array of redaction reason configuration objects ecm.model.admin.RedactionReasonConfig.
callback: A callback method if provided will be called with response
params: Passing extra parameters to mid-tier

Since:: 3.0.3

deleteApplicationDesktopsConfig(desktopConfigArray, callback, params)

Deletes desktop configuration objects ecm.model.admin.DekstopConfig from the application object ecm.model.admin.ApplicationConfig.

Parameters:
desktopConfigArray: An array of desktop configuration objects ecm.model.admin.DekstopConfig.
callback: A callback method if provided will be called with response
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

deleteApplicationMenusConfig(menuConfigArray, callback, params)

Deletes menu configuration objects ecm.model.admin.MenuConfig from the application object ecm.model.admin.ApplicationConfig.

Parameters:
menuConfigArray: An array of menu configuration objects ecm.model.admin.MenuConfig.
callback: A callback method if provided will be called with response
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

deleteApplicationPluginsConfig(pluginConfigArray, callback, params)

Deletes plugin configuration objects ecm.model.admin.PluginConfig from the application object ecm.model.admin.ApplicationConfig.

Parameters:
pluginConfigArray: An array of plugin configuration objects ecm.model.admin.PluginConfig.
callback: A callback method if provided will be called with response
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

deleteApplicationRedactionReasonConfig(redactionReasonConfigArray, callback, params)

Deletes redaction reason configuration objects ecm.model.admin.RedactionReasonConfig from the application object ecm.model.admin.RedactionReasonConfig.

Parameters:
redactionReasonConfigArray: An array of redaction reason configuration objects ecm.model.admin.RedactionReasonConfig.
callback: A callback method if provided will be called with response
params: Passing extra parameters to mid-tier

Since:: 3.0

deleteApplicationRepositoriesConfig(repositoryConfigArray, callback, params)

Deletes repository configuration objects ecm.model.admin.RepositoryConfig from the application object ecm.model.admin.ApplicationConfig.

Parameters:
repositoryConfigArray: An array of repository configuration objects ecm.model.admin.RepositoryConfig.
callback: A callback method if provided will be called with response
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

deleteApplicationThemesConfig(themeConfigArray, callback, params)

Deletes theme configuration objects ecm.model.admin.ThemeConfig from the application object ecm.model.admin.ApplicationConfig.

Parameters:
themeConfigArray: An array of theme configuration objects ecm.model.admin.ThemeConfig.
callback: A callback method if provided will be called with response
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier, 2.0.3

deleteApplicationViewersConfig(viewerConfigArray, callback, params)

Deletes viewer configuration objects ecm.model.admin.ViewerConfig from the application object ecm.model.admin.ApplicationConfig.

Parameters:
viewerConfigArray: An array of viewer configuration objects ecm.model.admin.ViewerConfig.
callback: A callback method if provided will be called with response
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

exportConfiguration(objects, callback, extraParams)

Exports selected configuration object and associated configuraiton objects.

Parameters:
objects: An object with three attributes: desktops, repositories, and plugins. Each contains an array of IDs.
callback: A callback method if provided will be called with returned response.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getAccessRoleConfig()

getAdminRoleObjects(callback, params)

Gets an array of admin role objects, if any

Parameters:
callback: A call back method. Callback method will be called and pass in an array of theme objects ecm.model.admin.AdminRoleConfig as a parameter if provided.
params

Since:: 3.0.3

getAllLabels(callback, extraParams)

Gets all the action labels.

Parameters:
callback: A callback method if provided will be called with an array of ecm.model.Action.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getApplicationConfig(callback, params)

Retrieves the application configuration objects ecm.model.admin.ApplicationConfig.

Parameters:
callback: A callback method if provided will be called with application object as parameter.
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getApplicationVersion()

Gets the application version number, for example 2.0.3

Returns:: a string value of application version number.

getDefaultViewerData(callback, extraParams)

Gets viewer definition, content type and mapping configuration to callback method.

Parameters:
callback: A call back method. Callback method will be called and pass in an array of viewer definition objects ecm.model.admin.ViewerDefConfig, an array of viewer content type objects ecm.model.admin.ViewerContentTypeConfig, and an array of viewer mapping configuration objects ecm.model.admin.ViewerMappingConfig as parameters if provided.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getDesktopName()

Gets the default desktop name.

Returns:: A string value of desktop name.

getDesktopObjects(callback, params)

Gets all desktop configuration objects defined in the application object.

Parameters:
callback: A callback method if provided will be called with an array of ecm.model.admin.DesktopConfig
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getFeaturesList(desktopId, callback, extraParams)

Retrieves the mobile feature list ecm.model.admin.MobileFeatureConfig defined in a desktop configuration object.

Parameters:
desktopId: A desktop id.
callback: A callback method if provided will be called with returned mobiel feature object ecm.model.admin.MobileFeatureConfig as parameter.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getIconObjects(callback, extraParams)

Returns icon objects if any.

Parameters:
callback: A call back method. Call back method will be called and pass in an array of ecm.model.admin.IconConfig objects as a parameter if provided.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getIconStatusObjects(callback, extraParams)

Returns icon status objects if any.

Parameters:
callback: A call back method. Call back method will be called and pass in an array of ecm.model.admin.IconStatusConfig objects as a parameter if provided.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getInterfaceTextsObjects(callback, extraParams)

Gets all ecm.model.admin.InterfaceTextConfig objects defined in the configuration.

Parameters:
callback: A callback method if provided will be called with an array of ecm.model.admin.InterfaceTextConfig
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getMenuObjects(callback, params)

Gets all menu configuration objects defined in the application object.

Parameters:
callback: A callback method if provided will be called with an array of ecm.model.admin.MenuConfig.
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getMenuTypeObjects(callback, extraParams)

Gets all menu type configuration objects defined in the application object.

Parameters:
callback: A callback method if provided will be called with an array of ecm.model.admin.MenuTypeConfig.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getMimeAndStateIconObjects(callback, extraParams)

Gets icon mapping and icon status objects.

Parameters:
callback: A call back method. Callback method will be called and pass in an array of icon MIME mapping object ecm.model.admin.IconConfig, and an array of icon status object ecm.model.admin.IconStatusConfig as parameters if provided.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getObjectExpiration()

Gets the object expiration time, unit in minutes. This value controls when the object will be removed from the Cache object in server side.

Returns:: a string value of expiration time unit in minute.

getPluginObjects(callback, params)

Gets an array of plugin configuration objects if any.

Parameters:
callback: A call back method. Callback method will be called and pass in an array of plugin objects ecm.model.admin.PluginConfig as a parameter if provided.
params

Since:: ICN 2.0.3.4 passing parameters to mid-tier

getRedactionReasonObjects(callback, params)

Gets an array of theme configuration objects if any.

Parameters:
callback: A call back method. Callback method will be called and pass in an array of theme objects ecm.model.admin.RedactionReasonConfig as a parameter if provided.
params

Since:: 3.0

getRepositoryObjects(callback, params)

Gets all repository configuration objects defined in the application object.

Parameters:
callback: A callback method if provided will be called with an array of ecm.model.admin.RepositoryConfig
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getServerObjects(callback, params)

Gets an array of server configuration objects. This is a read-only object. There is no set method to update/delete serverConfig. There will be a server configuration object provided as default for each supported server type(ie P8, CM, CMIS, OD...). There will also be a server configuration object provided for each plug-in provided repository type.

Parameters:
callback: A call back method. Callback method will be called and pass in an array of ServerConfig objects ecm.model.admin.ServerConfig as a parameter if provided.
params

Since:: ICN 2.0.3.4 passing parameters to mid-tier

getSettingsConfigObject(callback, extraParams)

Gets the Settings configuration object.

Parameters:
callback: A call back method. Callback method will be called and pass in a SettingsConfiguration object as a parameter if provided.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getThemeObjects(callback, params)

Gets an array of theme configuration objects if any.

Parameters:
callback: A call back method. Callback method will be called and pass in an array of theme objects ecm.model.admin.ThemeConfig as a parameter if provided.
params

Since:: 2.0.3, ICN 2.0.3.4 passing parameters to mid-tier

getUIApplicationLabelObjects(callback, extraParams)

Gets all ecm.model.admin.InterfaceTextConfig objects defined in the application.

Parameters:
callback: A callback method if provided will be called with an array of ecm.model.admin.InterfaceTextConfig
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

getViewersObjects(callback, params)

Gets an array of viewer configuration objects if any.

Parameters:
callback: A call back method. Callback method will be called and pass in an array of viewer objects ecm.model.admin.ViewerDefConfig as a parameter if provided.
params

Since:: ICN 2.0.3.4 passing parameters to mid-tier

isInitialized()

Return a boolean value represent if an application definition has been retrieved

Returns:: Return a boolean value represent if an application definition has been retrieved

openNewHelpWindow(file)

Parameters:
file

openSupport1HelpWindow(file)

Parameters:
file

openSupport2HelpWindow(file)

Parameters:
file

setAccessRoleConfig(userId, accessRights)

Parameters:
userId
accessRights

setApplicationVersion(value)

Parameters:
value

setObjectExpiration(value)

Parameters:
value

updateApplicationDesktopConfig(desktopConfig, callback, desktopAccessConfig, params)

Updates a desktop configuration object ecm.model.admin.DesktopConfig defined in the application object ecm.model.admin.ApplicationConfig.

Parameters:
desktopConfig: A desktop configuration object ecm.model.admin.DesktopConfig. It contains a desktop definition.
callback: A callback method if provided will be called with response
desktopAccessConfig
params

Since:: 2.0.2 A desktop access configuration object {@link ecm.model.admin.DesktopAccessConfig}. It contains a desktop access definition., ICN 2.0.3.4 passing extra parameters to mid-tier

updateApplicationIconMapping(iconMimeMappingData, iconStatusData, callback, extraParams)

Updates icon mapping and icon status objects in the same transaction.

Parameters:
iconMimeMappingData: A collection of icon MIME mapping object ecm.model.admin.IconConfig
iconStatusData: A collection of icon status object ecm.model.admin.IconStatusConfig
callback: A call back method. Call back method will be called and pass in a response object as a parameter if provided.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

updateApplicationMenuConfig(menuConfig, callback, params)

Update a menu configuration object ecm.model.admin.MenuConfig defined in the application object ecm.model.admin.ApplicationConfig.

Parameters:
menuConfig: A desktop configuration object ecm.model.admin.MenuConfig. It contains a menu definition.
callback: A callback method if provided will be called with response
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

updateApplicationObjectExpiration(objectExpiration, callback, extraParams)

Updates application's object expiration.

Parameters:
objectExpiration: A value, unit in minutes.
callback: A call back method. Call back method will be called and pass in a response object as a parameter if provided.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

updateApplicationPluginConfig(pluginConfig, callback, params)

Updates a plugin configuration object ecm.model.admin.PluginConfig defined in the application object ecm.model.admin.ApplicationConfig.

Parameters:
pluginConfig: A plugin configuration object ecm.model.admin.PluginConfig. It contains a plugin definition.
callback: A callback method if provided will be called with response
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

updateApplicationRedactionReasonConfig(redactionReasonConfig, callback, params)

Updates a theme configuration object ecm.model.admin.RedactionReasonConfig defined in the application object ecm.model.admin.ApplicationConfig.

Parameters:
redactionReasonConfig: A redaction reason configuration object ecm.model.admin.RedactionReasonConfig. It contains a redaction reason definition.
callback: A callback method if provided will be called with response
params

Since:: 3.0

updateApplicationRepositoryConfig(repositoryConfig, callback, params)

Updates a repository configuration object ecm.model.admin.RepositoryConfig defined in the application object ecm.model.admin.ApplicationConfig.

Parameters:
repositoryConfig: A desktop configuration object ecm.model.admin.RepositoryConfig. It contains a repository definition.
callback: A callback method if provided will be called with response
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

updateApplicationSettingsConfig(settingsConfig, callback, params)

Updates a settings configuration object ecm.model.admin.SettingsConfig

Parameters:
settingsConfig: A plugin configuration object ecm.model.admin.SettingsConfig. It contains an application settings definition.
callback: A callback method if provided will be called with response
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

updateApplicationThemeConfig(themeConfig, callback, params)

Updates a theme configuration object ecm.model.admin.ThemeConfig defined in the application object ecm.model.admin.ApplicationConfig.

Parameters:
themeConfig: A theme configuration object ecm.model.admin.ThemeConfig. It contains a theme definition.
callback: A callback method if provided will be called with response
params

Since:: 2.0.3, ICN 2.0.3.4 passing extra parameters to mid-tier

updateApplicationViewerConfig(viewerConfig, mappingData, callback, params)

Updates a viewer configuration object ecm.model.admin.ViewerConfig defined in the application object ecm.model.admin.ApplicationConfig.

Parameters:
viewerConfig: A desktop configuration object ecm.model.admin.ViewerConfig. It contains a viewer definition.
mappingData: A viewer mapping configuration object ecm.model.admin.ViwerMappingConfig. It contains mapping information.
callback: A callback method if provided will be called with response
params

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier

updateFileTypesMapping(fileTypesMappingData, callback, extraParams)

Updates file types mapping.

Parameters:
fileTypesMappingData: A collection of file types mapping objects ecm.model.admin.FileTypeConfig
callback: A call back method. Call back method will be called and pass in a response object as a parameter if provided.
extraParams

Since:: ICN 2.0.3.4 passing extra parameters to mid-tier