System properties configure Clearspace with application-wide settings. Some of the settings correspond to configuration elements in the admin console user interface.
To make changes to system properties, in the admin console go to System > Management > System Properties. Keep in mind that both property names and values are case-sensitive.
Note: Changing system property values can have a dramatic effect on how Clearspace works. Some settings and values can even severely debilitate the application. You should only make changes to system settings under the guidance of Jive's support or professional services teams.
The following is a list of system properties that are set by default when you install Clearspace.
| Property Name | Description |
|---|---|
| checkmail.host | Email server name used for verifying mail settings provided in the System - Settings - Email Server screen in the admin console. |
| checkmail.port | Email server port used for verifying mail settings provided in the System - Settings - Email Server screen in the admin console (default: 110) |
| checkmail.protocol | Email protocol used for verifying mail settings provided in the System - Settings - Email Server screen in the admin console (default: pop3) |
| documentmanager.correctdeletedusers.completed | Determines if the CorrectDeletedUsersTask should run, which finds all the documents in the system and check 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) |
| 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. |
| i18n.allowedLanguages | not currently used |
| i18n.defaultLanguage | not currently used |
| 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. Default: true on Clearspace; false in Clearspace Community. |
| jive.bodyConversionTask.completed | Determines if the BodyConversionTask should run, which goes through all messages, documents, blog posts, comments, announcements and private messages and converts their bodies to the new xml storage format, backing up the previous content if any changes were made. |
| 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 (default: true) |
| jive.sync.relationships.ldap | true to use LDAP to build the organizational chart and specify reporting relationships. |
| 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.xmpp.enabled | Determines whether the XMPP service is enabled. |
| jiveURL | The base URL of the Clearspace installation. This must be set in order for the application to work correctly. Default: http://localhost:8080/clearspace_community |
| 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 (default: ERROR) |
| mail.smtp.host | Mail server used for sending notifications and messages to users |
| mail.smtp.port | Mail server port used for mail notifications |
| opensearch.key | Unique ID used for external search engine integration |
| privateMessages.enabled | true to enable private messaging. |
| skin.default.displayFullNames | Set to true to display the full names of users, or false to use their username (default: false for internal Clearspace; true for external Clearspace Community) |
| skin.default.newAccountCreationEnabled | Determines whether users are allowed to register to create a new account (default: true) |
| 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/connections graph. |
| user.default.displayEmailAddress | Determines whether or not to display a user's email address. |
| user.allowEmailVisibilityToggle | Determines whether the user can choose the visibility of their email address. |
| user.allowNameVisibilityToggle | Determines whether the user can choose the visibility of their name. |
| 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 include all (for all users), registered (for registered users only), specificUsers (for specifically named users only), and specificGroups (for specifically named groups only). |
| Property Name | Description |
|---|---|
| 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 being set to false. |
| jive.freemarker.templateUpdateDelay | Set to 1 to tell Clearspace 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.) |
| 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. |
| privateMessages.notification.enabled | If private messaging has been enabled, then this property determines whether the system will send email notifications when users receive a private message (default: true) |
| 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 unchecked 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. Values(true,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. Values(true,false). |
| skin.default.recentHistoryEnabled | Set to false to hide the History menu on the userbar (defaults to 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 instance, such as "Acme Community Admin Console". |
| task.pendingDueNotification.enabled | true to disable task due notification emails. |
| webservices.soap.enabled | Whether or not SOAP webservices are enabled (default: false) |
| webservices.soap.accessType | Sets how users can access webservices possible values are
(default: all) |
| webservices.soap.allowedUsers | Comma seperated list of allowed users by username (see property: webservices.soap.accessType) |
| webservices.soap.allowedGroups | Comma seperated list of allowed groups by group name (see property: webservices.soap.accessType) |
| webservices.soap.forceSSL | If this property is set requests that are not over SSL will fail. (default: false) |
| webservices.soap.permissionHandler.className | Override this property to customize the inbound Handler for XFire. (default:com.jivesoftware.community.webservices.server.xfire.PermissionHandler) |
