System properties reference

Here you can find a reference of Jive system properties.

Fastpath: Admin Console: System > Management > System Properties
Note: This list is currently missing some entries and will be updated. For more information, see Undocumented Jive System Properties on Worx.

To make changes to system properties:

  • In the Admin Console, go to System > Management > System Properties.

Note that both property names and values are case-sensitive.

Warning: Changes to some system properties have a dramatic impact on the system — a wrong value can break the application. Generally, you should leave system properties unchanged unless you're asked to change it by Support. You might also change a system property value if the change is part of a more significant effort to customize the application.

The following is a list of system properties that are set by default when you install Jive.

System properties reference

System property Description Example
blog.searchComments.enabled Determines if comments on search are enabled. The following options are available:
  • true: enabled
  • false: disabled
true
bridge.connection.proxy.host The host name of the proxy server you specify so that Jive can bring information from the internet into the community for bridging. The proxy server must not require a username and password because it's not supported by the client used for bridging.  
bridge.connection.proxy.port The port for the proxy server for bridging.  
browse.main.docs.show.space.browser Set to true to have the Documents page use the original space browsing UI.  
browse.main.threads.show.space.browser Set to true to have the Discussions page use the original space browsing UI.  
checkmail.host The email server name used for verifying mail settings provided in the System > Settings > Email Server page in the Admin Console.  
checkmail.port The email server port used for verifying mail settings provided in the System > Settings > Email Server page in the Admin Console. 110
checkmail.protocol The email protocol used for verifying mail settings provided in the System > Settings > Email Server page in the Admin Console. pop3
communityThreadCount.updateInterval.seconds The interval, in seconds, between updates to the count of discussions displayed in the community, such as on the Discussions tab of a social group. 5
community.extended.property.value.blacklist.regex Rejects extended property value that matches the provided regex.  
document.searchComments.enabled Set to true to enable return of comments on search; set to false to disable it. true
documentmanager.correctdeletedusers.completed Determines if the CorrectDeletedUsersTask should run. This task finds all the documents in the system and checks to make sure that the original author of the document hasn't been deleted. If the author has been deleted, then this task sets the author to guest (id: -1)  
email.search.allowWhiteSpace Set to true if you want people search to allow white spaces in the email field. false
feeds.protected Determines whether or not feeds are protected by Basic Authentication.  
GroupManager.className Qualified class name for the default GroupManager implementation. Modify this property to identify a custom GroupManager implementation to associate users with various groups on the system.  
http.proxyHost Specify the host name of the proxy server so Jive can bring information from the internet into the community for certain features, such as RSS, bookmarks, and bridging.  
http.proxyPort Specify the port for the proxy server.  
http.proxyUsername Specify the username for your proxy server, if required.  
http.proxyPassword Specify the password for your proxy server, if required.  
i18n.allowedLanguages Not currently used  
i18n.defaultLanguage Not currently used  
ip.header.max.depth Specifies how many email jumps are secure from the X_FORWARDED_FOR email header. This is designed to reduce the possibility of a fake header when the header is set by a proxy. With this set, the application takes the IP at the position given to get to a known, trustworthy address. For example, if the value of X_FORWARDED_FOR is 127.0.0.5, 10.61.8.223, 10.61.201.116, 10.61.3.9 (there are four IPs in the list) and ip.header.max.depth is set to 2, then the remote address will be interpreted as 10.61.201.116. If this property is not set or is set to 0, the application takes the head of the list of addresses (the 0 position).  
jive.addons.upload.allow.signed.globally true allows globally signed add-ons to be directly uploaded. false disables the ability to upload globally signed add-ons directly. false
jive.APIThrowsClause.enabled Setting to true adds a security string to the beginning of every core V3 JSON response, and all data returned via API. Setting to false with no query parameters removes the security string, except for vulnerable arrays. When you set to false and add a noThrows=true query parameter, the security string is removed for all data, even vulnerable arrays. false with no parameters
jive.auth.disallowGuest Determines whether or not non-authenticated users are not allowed. When this property is set to true, any non-authenticated user will be redirected to the login page for all requests.  
jive.bodyConversionTask.completed Determines if the BodyConversionTask should run, which goes through all messages, documents, blog posts, comments, and announcements and converts their bodies to the new XML storage format, backing up the previous content if any changes were made.  
jive.container.category.tagcloudmax The maximum number of tags shown in a tag cloud when filtering content by categories and tags. This is an integer that defaults to 30. A very high number might impair performance or cause UI problems. 30
jive.cookies.secure When set to true, the cookie are transferred over HTTPS. When set to false, the cookie are transferred even on HTTP. For more information on secure cookie, see Setting up secure cookies.
Note: This value is required to be specified when upgrading to version 9.0.7.1 or later. For more information, see Preparing for upgrade to 9.0.7.1 or later.
  
jive.coreapi.disable.binarydownloads.mobileonly Set to true to enable downloads for mobile devices. Default is true.  
jive.devMode Set to true to ensure that images, attachments, and binary documents are not cached. Also turns off page compression when set to false in conjunction with the jive.compressionFilter.enabled property is set to false.  
jive.digest.enabled false to disable the email digest feature. The feature is designed to send email to users with a summary of their activity in the community.  
jive.digest.email.sendHour Hour of the day at which digest emails are sent to users who have requested them in their preferences. The value should be a simple integer indicating the hours of the day. Examples are "10" for 10 a.m., "14" for 2 p.m., and "23" for 11 p.m. Default is 9.  
jive.dv.service.connection.verification true to have the application server test its connection with the document conversion machine before using the connection. You might want to set this to false if you're unable to open TCP port 7 (which is used for the test) on the conversion machine.  
jive.featuredcontent.enabled false to disable the featured content feature. The feature is enabled by default.  
jive.featuredcontent.objecttype.<typevalue> false to disable featuring for the specified kind of content. Append the objecttype value of the content you want to disable. For example, to disable documents set it this way: jive.featuredcontent.objecttype.102 = false. All types are enabled by default.  
jive.freemarker.templateUpdateDelay Set to 1 to tell the application to look for changes to theme files. When you're editing theme FTL files outside of the Admin Console, use this property and value to ensure that your changes are picked up as you make them. (Because it can slow performance, be sure to remove this property for your production instance.)  
jiveInstanceId The universally unique instance of the application cluster used to distinguish each server node in a clustered server configuration.  
jive.master.encryption.key.node This property represents one of the node.id files in the cluster. Remove the value in the event of a failover. Upon restart, the web applications populates it automatically with the correct value.
Note: This property must be deleted before upgrading to version 9.0.7.1 or later. For more information, see Preparing for upgrade to 9.0.7.1 or later.
  
jive.mobile.hipaa Set to true to require the mobile device is Health Insurance Portability and Accountability Act of 1996 (HIPAA) compliant.  
jive.mobile.places.tiles.htmlSupport Set to true if you want your mobile app to support HTML tiles. Default is true.  
jive.module.video.enabled Set to true if you want to enable the video feature by default with only the Embed a Video option (not upload or record). Default is true.
Note: You can use video.upload.enabled and video.webcam.enabled to enable or disable those features (both are true by default).
 true
jive.news.enabled Set to true to enable the news feature; set to false to disable it. true
jive.pageCached.enabled FreeMarker pages are cached by default in versions 2.0 and greater (default is true even if not set in the Admin Console). Set this property to false to turn off caching for development purposes, which will allow theme changes to be reflected immediately in the UI without restarting the server. However, page caching should be enabled for production instances to increase performance. true
jive.pdf.paper.size Specifies the default paper size for PDF files generated from content. The following values are supported: ANSI_A, ANSI_B, ANSI_C, ANSI_D, ANSI_E, ISO_A0, ISO_A1, ISO_A2, ISO_A3, ISO_A4, ISO_A5, ISO_A6, ISO_A7, ISO_A8, ISO_A9, ISO_A10, ISO_B0, ISO_B1, ISO_B2, ISO_B3, ISO_B4, ISO_B5, ISO_B6, ISO_B7, ISO_B8, ISO_B9, ISO_B10, ISO_C0, ISO_C1, ISO_C2, ISO_C3, ISO_C4, ISO_C5, ISO_C6, ISO_C7, ISO_C8, ISO_C9, ISO_C10, JIS_0, JIS_1, JIS_2, JIS_3, JIS_4, JIS_5, JIS_6, JIS_7, JIS_8, JIS_9, JIS_10, JIS_11, JIS_12.  
jive.sync.profile.ldap.login Determines whether LDAP-provided user profile fields should be refreshed when users log in. Set to false for external communities where LDAP is not commonly used. true
jive.sync.relationships.ldap Set to true to use LDAP to build the organizational chart and specify reporting relationships.  
jiveURL The base URL of the installation. This must be set in order for the application to work correctly.  
jive.user.lastname.firstname.enabled Determines whether user names are stored as two values — one each for first and last names. If the value is false, then user names are stored as a single value combining first and last names. This is set during application setup.  
jive.usercontainer.document.enabled false to turn off the Your Documents feature.  
jive.usercontainer.thread.enabled false to turn off the Private Discussions feature.  
jive.xmpp.enabled Determines whether the XMPP service is enabled.  
ldap.adminPassword.key The private key used to decrypt the LDAP password in the database.  
ldap.searchFilter No longer used  
log4j.threshold The level at which logging messages will be recorded. ERROR
mail.smtp.host Mail server used for sending notifications and messages to users.  
mail.smtp.port Mail server port used for mail notifications.  
     
officeintegration.enabled Set to true to enable support for a preview view of some documents, including PDFs and those from Microsoft Office. false
opensearch.key A unique ID used for external search engine integration  
passwordReset.caseSensitive Set to true to allow case-sensitive lookup of usernames when setting a password. Set this to false to allow for case-insensitive username lookup when resetting a password. When this is set to false, if two username values differ only by case, a password reset may fail with an error message until distinct usernames are created. To avoid this, you need to manually change one of the usernames to make the usernames different for case insensitivity. true
polls.voting.private true to exclude poll votes from visible activity. The default value — false — will allow poll votes to appear among other recent activity. false
profile.security.collagues.mgr.enabled true to specify that a person's manager is included in the Colleagues option when the person is setting visibility for a profile field. If you change this property, you must rebuild the user search index for the changes to take effect. For more information, see Configuring user search. true
profile.security.collagues.drpts.enabled true to specify that a person's direct reports are included in the Colleagues option when the person is setting visibility for a profile field. If you change this property, you must rebuild the user search index for the changes to take effect. For more information, see Configuring user search. true
search.indexCreated Tracks the last time the search index was created (set by the system).  
search.indexVersion The version of the currently used user index.  
skin.default.displayFullNames Set to true to display the full names of users, or false to use their username.  
skin.default.newAccountCreationEnabled Determines whether users are allowed to register to create a new account. true
stream.websocket.enabled When true, the stream notification indicator is active and you see a notification dot next to streams with unread content. false
system.adminuser.email The default email address that the system will use when sending email notifications.  
system.adminuser.fromName The default From name that the system will use when sending email notifications.  
update.lastCheck Tracks the last time the system checked for updates to plugins or the server (set by the system). New versions of plugins can be downloaded and installed. However, new server releases should be manually installed.  
ur.graph.hier.default.ID The ID of the default (hierarchical) org chart graph.  
ur.graph.mesh.default.ID The ID of the default (mesh) friends or connections graph.  
user.default.displayEmailAddress Determines whether or not to display a user's email address.  
webservices.rest.enabled Determines whether or not REST-style web services are enabled.  
webservices.soap.accessType The access type for SOAP web services. Possible values are:
  • all: For all users
  • registered: For registered users only
  • specificUsers: For specifically named users only
  • specificGroups: For specifically named groups only
  
macros.unproxyobjects Set to true to render the link — rather than an error message — even when the user might not have permission to view the linked content. This is false by default in order to prevent potentially sensitive content (such as the linked document's title) from being seen by those who don't have permission to view the content. false
people.search.pagesize The number of results per page in people search.  
polls.enabled Turns on polls, and displays the Create a poll link in the Actions sidebar if the user has been given permissions to create polls.  
questions.markThreadAsQuestionByDefault Set to true to mark discussions as questions by default (display the Mark thread as question checkbox in new discussions as checked), or set to false to leave it cleared by default. Often users do not even notice that the checkbox is there, and turning it on by default allows users to give points to other users when they provide a correct or helpful answer.  
skin.default.changePasswordEnabled Determines whether users can change their password. Possible values are true and false.  
skin.default.headerHTML Replaces the header logo for the entire application with the HTML entered in this system property.  
skin.default.newAccountCreationEnabled Determines whether users can register their own user accounts. Possible values are true and false.  
skin.default.recentHistoryEnabled Set to false to hide the History menu on the userbar. true
system.console.custom.title The value that should be used in the page title for the Admin Console. Typically, this matches the title of your community, such as Acme Community Admin Console.  
video.download.enabled Set to true if you want users to download uploaded or recorded videos from Perceptive. true
video.upload.enabled Set to true if you want users to upload or record videos to Perceptive. true
webservices.soap.enabled Whether or not SOAP webservices are enabled. false
webservices.xmlrpc.enabled Whether or not XML-RPC webservices are enabled. false
webservices.soap.accessType Sets how users can access webservices. Possible values are:
  • all: Any users.
  • registeredUsers: Disallow anonymous access.
  • specificUsers: Only allow specific users. Use the webservices.soap.allowedUsers property to set.
  • specificGroups: Only allow specific groups. Use the webservices.soap.allowedGroups property to set.
all
webservices.soap.allowedUsers Comma separated list of allowed users by username. For more information, see the webservices.soap.accessType property.  
webservices.soap.allowedGroups Comma separated list of allowed groups by group name. For more information, see the webservices.soap.accessType property.  
webservices.soap.forceSSL If this property is set requests that are not over SSL will fail. false
mail.valid.tld.pattern

Identifies the valid TLDs pattern used to validate email addresses. The default pattern is the following: 

com|net|org|edu|int|mil|gov|arpa|biz|aero|name|coop|info|pro|museum|mobi|cat|jobs|asia|tel|travel

It accepts email addresses ending in these suffixes, for example, user@email.travel. This can be changed by adding the new supported TLD to the end of the list.

For example, to support qlat append |qlat to the property to make it the following: 

com|net|org|edu|int|mil|gov|arpa|biz|aero|name|coop|info|pro|museum|mobi|cat|jobs|asia|tel|travel|qlat
  
webservices.soap.permissionHandler.className Override this property to customize the inbound Handler for XFire. 
com.jivesoftware.community.webservices.server.xfire.PermissionHandler
jive.password.expiration.enabled Determines if the password expiration feature is enabled. The following options are available:
  • true: enabled
  • false: disabled

The default setting is false. For more information, see Password expiration.

 true
jive.password.expiration.days The number of days that a password can be used before it must be changed. This setting is applied when jive.password.expiration.enabled is set to true.

By default, this parameter is not set. Possible values are zero and natural numbers. The default setting is 60. For more information, see Password expiration.

 200
jive.password.expiration.notification.days The number of days before the password expiration date when a notification about the expiration is sent to a user. This setting is applied when jive.password.expiration.enabled is set to true.

The default setting is 7. Possible values are zero and natural numbers. For more information, see Password expiration.

 7
jive.password.min.life.days The number of days during which a password cannot be changed after a successful password update.

The default setting is 1. Possible values are zero and natural numbers. For more information, see Password expiration.

 1
jive.password.reset.enabled Determines how community administrators can update passwords for users. When enabled, administrators can only initiate password resets. When disabled, administrators can manually change passwords for the users. The following options are available:
  • true: enabled
  • false: disabled

The default setting is false. For more information, see Manual password reset.

 false