You are here

JMX editable management beans

JMX values (Managed Bean or MBean attributes) are exposed in the Admin Console and with internal tools (Alfresco JMX Dump) or external tools like JConsole. The editable management beans are described here with their default values where attributes are not already explained in the Admin Console.

The default values given are the defaults for an installer-installed instance of Alfresco Content Services on Windows. These values can differ if you are using a different install method or operating system.

CAUTION:
Be aware that any changes you make to attributes in the live system are written to the database. The next time that Alfresco Content Services starts, these values will take precedence over any values specified in properties files, for example, alfresco-global.properties.
Alfresco:Type=Configuration, Category=ActivitiesFeed, Object Type=ActivitiesFeed$default

This MBean provides information about the Activities Feed configuration, including whether the feed is enabled and how often users will receive Activities Feed emails.

See the Admin Console Repository Services - Activities Feed for information about these editable attributes: http://<hostname>:<portnumber>/alfresco/service/enterprise/admin/admin-activitiesfeed.

Alfresco:Type=Configuration, Category=Audit, Object Type=Audit$default

This MBean provides information about the audit configuration, namely which audit capabilities are enabled.

Attribute name Example value
audit.alfresco-access.enabled false
audit.cmischangelog.enabled false
audit.enabled true
audit.sync.enabled true
audit.tagging.enabled true
Alfresco:Type=Configuration, Category=Authentication, Object Type=Authentication$managed$alfrescoNtlm1

This MBean provides information about the authentication configuration.

See the Admin Console Directories - Directory Management for information about these editable attributes: http://<hostname>:<portnumber>/alfresco/service/enterprise/admin/admin-directorymanagement.

Alfresco:Type=Configuration, Category=ContentStore, Object Type=ContentStore$managed$encrypted or Object Type=ContentStore$managed$unencrypted

This MBean provides information about the type of ContentStore used and its configuration. For more information, see Set up encryption properties using JMX client and Encrypted Content Store properties.

Alfresco:Type=Configuration, Category=Events, Object Type=Events$default

This MBean provides information about the type of events that are used for monitoring.

Attribute name Values
alfresco.events.include CONTENTPUT, NODEADDED, NODEREMOVED, NODEMOVED, NODERENAMED, NODECHECKOUTCANCELLED, NODECHECKEDOUT, NODECHECKEDIN
Alfresco:Type=Configuration, Category=OOoDirect, Object Type=OOoDirect$default

This MBean provides information about the Open Office configuration.

Attribute name Example value
ooo.enabled false
ooo.exe C:/Alfresco/libreoffice/App/libreoffice/program/soffice.exe
ooo.host localhost
ooo.port 8100
Alfresco:Type=Configuration, Category=OOoJodconverter, Object Type=OOoJodconverter$default

This MBean provides information about JODConverter configuration, which automates conversions between office document formats.

Attribute name Example value
jodconverter.enabled true
jodconverter.maxTasksPerProcess 200
jodconverter.officeHome C:/Alfresco/libreoffice/App/libreoffice
jodconverter.portNumbers 8100
jodconverter.taskExecutionTimeout 120000
jodconverter.taskQueueTimeout 30000
jodconverter.templateProfileDir  
Alfresco:Type=Configuration, Category=Replication, Object Type=Replication$default

This MBean provides information about the replication settings between repositories, and the replication configuration.

See the Admin Console Repository Services - Replication Service for information about these editable attributes: http://<hostname>:<portnumber>/alfresco/service/enterprise/admin/admin-replicationservice.

Alfresco:Type=Configuration, Category=Search, Object Types=Search$*

This MBean provides information about the search service in use (Solr, Solr 4 or no index) and the configuration for that search.

See the Admin Console Repository Services - Search Service for information about these editable attributes: http://<hostname>:<portnumber>/alfresco/service/enterprise/admin/admin-searchservice.

Alfresco:Type=Configuration, Category=Subscriptions, Object Type=Subscriptions$default

This MBean provides information about settings for subscriptions, including whether subscriptions are enabled and any template paths.

See the Admin Console Repository Services - Subscription Service for information about these editable attributes: http://<hostname>:<portnumber>/alfresco/service/enterprise/admin/admin-subscriptionservice.

Alfresco:Type=Configuration, Category=Synchronization, Object Type=Synchronization$default

This MBean provides information about the synchronization settings in, including when to synchronize and logging intervals.

Attribute name Example value
synchronization.allowDeletions true
synchronization.autoCreatePeopleOnLogin true
synchronization.import.cron 0 0 0 * * ?
synchronization.loggingInterval 100
synchronization.syncOnStartup true
synchronization.syncWhenMissingPeopleLogIn true
synchronization.synchronizeChangesOnly true
synchronization.workerThreads 1
Alfresco:Type=Configuration, Category=Transformers, Object Type=Transformers$default

This MBean provides information about the transformation service setting for converting between different file formats.

See the Admin Console Repository Services - Transformation Services for information about these editable attributes: http://<hostname>:<portnumber>/alfresco/service/enterprise/admin/admin-transformations.

Alfresco:Type=Configuration, Category=WebDav, Object Type=org.alfresco.enterprise.repo.management.WebDav

This MBean provides information about whether WebDav is enabled or disabled.

Attribute name Example value
Enabled true
Alfresco:Type=Configuration, Category=email, Object Types=email$inbound, email$outbound

This MBean provides information about the inbound and outbound email configuration, including server, protocol and encoding information.

See the Admin Console Email Services - Inbound Email and Email Services - Outbound Email for information about these editable attributes: http://<hostname>:<portnumber>/alfresco/service/enterprise/admin/admin-inboundemail and http://<hostname>:<portnumber>/alfresco/service/enterprise/admin/admin-outboundemail.

Alfresco:Type=Configuration, Category=fileServers, Object Type=fileServers$default

This MBean provides information about the CIFS and FTP servers configured.

See the Admin Console Virtual File Systems - File Servers for information about these editable attributes: http://<hostname>:<portnumber>/alfresco/service/enterprise/admin/admin-fileservers.

Alfresco:Type=Configuration, Category=googledocs, Object Type=googledocs$v2

This MBean provides information about the Google Docs configuration.

Attribute name Example value
googledocs.enabled true
googledocs.idleThresholdSeconds 600
googledocs.version 2.0.6-12ent
Alfresco:Type=Configuration, Category=imap, Object Types=imap$default, imap$default$imap.config.server.mountPoints$AlfrescoIMAP

This MBean provides information about the IMAP mail and server configuration.

See the Admin Console Virtual File Systems - IMAP Service for information about these editable attributes: http://<hostname>:<portnumber>/alfresco/service/enterprise/admin/admin-imap.

Alfresco:Type=Configuration, Category=sysAdmin, Object Type=sysAdmin$default

This MBean provides information about the administration settings for the Alfresco Share.

Attribute name Example value
alfresco.context alfresco
alfresco.host 127.0.0.1
alfresco.port 8080
alfresco.protocol http
server.allowWrite true
server.allowedusers
server.maxusers -1
share.context share
share.host 127.0.0.1
share.port 8080
share.protocol http
site.public.group GROUP_EVERYONE
Alfresco:Type=Configuration, Category=thirdParty, Object Type=thirdparty$default

This MBean provides information about the third party modules configured.

Attribute name Example value
img.coders C:\Alfresco\imagemagick\modules\coders
img.config C:\Alfresco\imagemagick\config
img.dyn C:\Alfresco\imagemagick/lib
img.exe C:\Alfresco\imagemagick\convert.exe
img.gslib C:\Alfresco\imagemagick\lib
img.root C:\Alfresco\imagemagick
Alfresco:Name=FileServerConfig, Object Type=com.sun.proxy$Proxy108

This MBean allows management and monitoring of the CIFS and FTP servers configured. See the Admin Console Virtual File Systems - File Servers for information about these editable attributes: http://<hostname>:<portnumber>/alfresco/service/enterprise/admin/admin-fileservers.

Alfresco:Name=Log4jHierarchy, Object Type=org.apache.log4j.jmx.HierarchyDynamicMBean

This MBean is an instance of the HierarchyDynamicMBean class provided with log4j that allows adjustments to be made to the level of detail included in the server logs. Not all attributes for Alfresco:Name=Log4jHierarchy are editable; only those that are editable are shown in this table.

Attribute name Example value
threshold ALL
Threshold is a special attribute that controls the server-wide logging threshold. It is not cluster aware. Its value must be the name of one of the log4j logging levels.
CAUTION:
Any messages logged with a priority lower than this threshold will be filtered from the logs. The default value is ALL, which means no messages are filtered, and the highest level of filtering is OFF which turns off logging altogether (not recommended).

You can add a new logger to Log4jHierarchy by selecting the Operations > addLoggerMBean operation in JConsole and specify the string and priority for the new logger MBean. The bean will be given an additional read-only property for that logger and a new MBean will be registered in the #log4j:logger=* tree, allowing management of that logger.

It is not normally necessary to use this operation, because the server pre-registers all loggers initialized during startup. However, if the logger you are interested in was not initialized at this point, you will have to add a logger. Add the fully qualified name of the logger as an argument and if successful, the object name of the newly registered MBean for managing that logger is returned. The logger is then displayed in the attribute list of log4j loggers.

For example, if in Java class org.alfresco.repo.admin.patch.PatchExecuter the logger is initialized as follows:

private static Log logger = LogFactory.getLog(PatchExecuter.class); 

Then the logger name would be org.alfresco.repo.admin.patch.PatchExecuter.

Alfresco:Name=Schedule, Object Type=org.alfresco.enterprise.scheduler.MonitoredRAMJobStore$MonitoredCronTrigger

This MBean provides information on the triggers that are configured, for example, those that are started by cron jobs or other events. You can fire a trigger by selecting the required MBean trigger and Operations > executeNow. The selected trigger is started.

Alfresco:Name=WorkflowInformation, Object Type=org.alfresco.enterprise.repo.management.Workflow

Exposes information about the workflow management interface for Activiti definitions and tasks. The attributes for Alfresco:Name=WorkflowInformation are shown in this table.

Attribute name Example value
ActivitiEngineEnabled true
ActivitiWorkflowDefinitionsVisible true
NumberOfActivitiTaskInstances 0
NumberOfActivitiWorkflowDefinitionsDeployed 9
NumberOfActivitiWorkflowInstances 0
Important: The ActivitiEngineEnabled attribute is enabled by default. It is recommended that you do not change (or disable) this property via the JMX client.

See the Admin Console Repository Services - Process Engines for information about these editable attributes: http://<hostname>:<portnumber>/alfresco/service/enterprise/admin/admin-processengines.

log4j:logger=*

An instance of the LoggerDynamicMBean class provided with log4j that allows adjustments to be made to the level of detail included in the logs from an individual logger.

Not all attributes for log4j:logger=* are editable; only those that are editable are shown in this table.

Attribute name Example value
priority WARN

Priority is a special attribute that specifies the minimum log4j logging level of messages from this logger to include in the logs. For example, a value of ERROR would mean that messages logged at lower levels such as WARN and INFO would not be included.

You can change the priority of any log4j attribute by selecting the required MBean and Attributes > priority. The new value does not prevail after a shutdown. For a list of possible priority values, see Log4j priority settings.

Sending feedback to the Alfresco documentation team

You don't appear to have JavaScript enabled in your browser. With JavaScript enabled, you can provide feedback to us using our simple form. Here are some instructions on how to enable JavaScript in your web browser.