System Properties for SharePoint Integration

System properties provide a way to do additional configuration. To use system properties, you need to log into the Jive Admin Console and navigate to System > Management > System Properties. Keep in mind that both property names and values are case sensitive.

Jive for SharePoint uses several system properties that are used to configure global settings of the connector. For example, jiveURL, sharepoint.ip.restrictions, and sharepoint.serviceaccount.restrictions. Some of these settings are shared with other Jive functionality and others are exclusively used by the SharePoint Connector.

If the property does not exist in Jive, you can scroll to the bottom of the page to add a new system property, otherwise you can edit the existing property.

Note: You should make changes to system settings only under the guidance of Jive support or professional services teams.

The following is a list of system properties that can be used to fine-tune configuration.

In the examples shown below, assume that the configured service account is FooBar and the domain is EXAMPLE.LOCAL -- note that capitalization is very important!

Property Description
jiveURL A string used to construct absolute URLs for various resources. Must match the URL set in SharePoint Central Administration for this Jive instance. The jiveURL property is used as the base URL in communication with Jive for SharePoint. It is the URL users need to use to access Jive. Make sure this is a valid URL accessible by all Jive users. For example, http://jive.mycompany.com.
jive.usernames.case.insensitive Setting to false makes case sensitive comparisons when users
 register or log in, for example, bbrag is a different user than BBragg.
 When set to true, there is no disctinction between bbragg and BBragg.
 Default is true.
Note: For Jive systems that integrate with SharePoint, the Jive system property jive.usernames.case.insensitive must be set to true or not be specified, which defaults to true.
search.results.groupByThread true to have search results from Jive back to SharePoint collapsed into single result items. Default is true.
sharepoint.activity.polling.delay Delay in seconds before initial execution of the Activity Polling background task. Default is 60.
sharepoint.activity.polling.interval Delay in seconds between each subsequent execution of the Activity Polling background task. Default is 15.
sharepoint.activity.polling.request.initial.items Sets the number of items that can come across in the Activity Stream for new account activity feed requests. Default is 5000.
sharepoint.activity.polling.request.initial.timeLimitSeconds For the initial request, limits in seconds how long Jive can query SharePoint for items that will be shown in the Jive Activity stream. When you set this limit, it only applies to querying list items and processing the results. To ensure that more so more list items reach the Activity Stream, Jive does not query changes, such as deletes and permission changes, on the initial activity feed request. By setting an "abridged" flag in SharePoint's View Jive Activity Streams page, Jive uses subsequent queries to pick up items missed because of the time limit. Default is 60. See Best Practices for more on this.
sharepoint.activity.polling.request.items Sets the number of subsequent items that can come across in the Activity stream for subsequent activity feed requests. Default is 5000.
sharepoint.activity.polling.request.timeLimitSeconds Sets the limit in seconds for how long Jive continues to query SharePoint for items that will be shown in the Jive Activity stream. This property allows requests for changes, such as deletes and permission changes. By setting an "abridged" flag in SharePoint's View Jive Activity Streams page, Jive uses subsequent queries to pick up items missed because of the time limit. Default is 20. See Best Practices for more on this.
sharepoint.activity.polling.suspend true to globally suspend the Activity Polling background task; intended for temporary use. Default is false.
sharepoint.activity.processing.delay Delay (in seconds) before initial execution of the Activity Processing background task. Default is 65.
sharepoint.activity.processing.documentContentTypeOnly true sets this Boolean property so only files of contentType Document can stream to Jive. Default is false.
sharepoint.activity.processing.interval

Delay (in seconds) between each execution of the Activity Processing background task. Default is 60.

sharepoint.activity.processing.perDocumentMaxRetries Sets the maximum number of retries, on a per document basis, that Jive will try to process a document in the stream. Default is 10.
sharepoint.activity.processing.perDocumentMaxRetries.delete When maximum number of retries is reach delete activity. Default is true.
sharepoint.activity.processing.per_cycle Maximum number of activities to process on each execution of the Activity Processing background task. Default is 30.
sharepoint.activity.processing.suspend true to globally suspend the Activity Processing background task; intended for temporary use. Default is false.
sharepoint.calendar.maxEventsPerMonth Maximum number of events per month available in the SharePoint calendar widget. Default is 1000.
sharepoint.calendar.monthsWindow Maximum number of months containing events available in the SharePoint Calendar widget. Default is 12.
sharepoint.calendar.monthsPrevious Number of previous months containing events available in the SharePoint Calendar widget. Default is 3. This number is used to determined the number of future events you can see in the calendar by subtracting it from sharepoint.calendar.monthsWindow.
sharepoint.connection.monitor.timeout Sets the connection timeout in milliseconds for SharePoint monitor polling service. Default is 10000.
sharepoint.connection.timeout.millis Sets the connection timeout in milliseconds Default is 90000.
sharepoint.document.migrateToSharePointOption true to enable the "Migrate to SharePoint" feature; false to disable it. Default is true.
sharepoint.document.convertToJive.removeSPOrigins When and if SharePoint streamed documents are converted to Jive documents, setting to true removes all remnants of the document's' SharePoint origins. Default is false.
sharepoint.freshdocument.threshold If the newly streamed document is older than this number of seconds then no email notifications will be sent. Default is 86400 (seconds in a day).
sharepoint.groupMembershipChange.check.delay Identifies the delay (in seconds) before initial execution of the SharePoint group membership changed background task. Default is 180.
sharepoint.groupMembershipChange.check.interval Identifies the delay (in seconds) between each execution of the SharePoint group membership changed background task. Default is 300.
sharepoint.groupMembershipChange.check.skip true specifies that the SharePoint group membership changed background task should should be skipped. Default is false.
sharepoint.identity.composite.formatProvider.username.regex.pattern Default is (.+), which means match 1 or more of anything.
sharepoint.identity.composite.formatProvider.username.regex.group Default is 1, which means group 1 is the value.
sharepoint.identity.composite.formatProvider.domain.regex.extract.lookupMap Provides a JSON representation of a lookup associative array and a default value. Property string must be a valid JSON string. The following string is the default value.
{
                            "lookup": {
                            "key1": "value1",
                            "key2": "value2"
                            },
                            "defaultValue": "default"
                            }
                            

The lowercase value of the raw profile field or, in this case, the extracted value based on the regex, will be looked up against the lookup map property.

  1. If a value is found in the lookup map then it will be used.
  2. If no value is found in the lookup map and the "defaultValue" property is defined that value will be used.
  3. Otherwise the raw profile field or the extracted value will be used.
Note: Lookup functionality is only available for the SharePoint Domain Name profile field. An ERROR log entry will result if Jive cannot interpret JSON as a lookup associative array and a default value.
sharepoint.identity.composite.formatProvider.domain.regex.group Default is 1, which means group 1 is the value.
sharepoint.identity.composite.formatProvider.domain.regex.pattern Default is (.+), which means match 1 or more of anything.
sharepoint.identity.fieldname.override.sp-external-id Use to override the Simple Set - SharePoint External ID profile with an existing profile field containing the same expected values: user@NetBIOSDomain or NetBIOSDomain\username or claimsUser@claimsIdentityProvider. No default and no restart is required. Because this is an existing field, you'll need to run SharePoint Identity Synchronization once.
sharepoint.identity.formatProvider.restart.required false allows Jive administrator to change the regex and group definitions without a system restart because it forces the Jive plugin to recompile the regex each time before the transformation is applied. Default is true. In production environment, compile should only happen at startup; therefore, set this property to true in production environments or remove the property completely since default is true.
sharepoint.identity.simple.fields.enabled true to activate the external identity mapping field, "SharePoint External ID" in a Jive profile (identity simple) if you have multi-domain requirements or if the SharePoint username is different from the Jive username ; false to disable it. Governs whether or not the fields are active and created. The default for this property is false. An application restart is required for changes to this property to take effect.
Note: If this property was switched from true to false, you should manually delete the custom profile field(s) that were created when set to true.

To delete these fields, navigate to:

Admin Console: People > Setting > Profile and Homepage > Custom Profile fields and delete the following fields.
  • SharePoint External ID
sharepoint.identity.composite.fields.enabled true to activate the external identity mapping fields, "SharePoint External Username" and "SharePoint External Domain" in a Jive profile (identity composite) if you have multi-domain requirements or if the SharePoint username is different from the Jive username; false to disable it. Governs whether or not the fields are active and created. Set this to true if you have multi-domain requirements or if the SharePoint username is different from the jive username. The default for this property is false. An application restart is required for changes to this property to take effect.
Note: If this property was switched from true to false, you should manually delete the custom profile field(s) that were created when set to true.

To delete these fields, navigate to:

Admin Console: People > Setting > Profile and Homepage > Custom Profile fields and delete the following fields.
  • SharePoint Username
  • SharePoint Domain Name
sharepoint.identity.profilefield.externallyManaged.domainName true to enable whether or not the SharePoint Connector Domain Name custom identity field is Externally Managed. Set to true (which is default) when the field is populated by LDAP or SSO. Default is true. An application restart is required for changes to this property to take effect. Set to false when the Jive admin will be setting the domain name value in the Admin Console. Setting this value to false is only meant for UAT and POC testing. In general, this profile values should be set by an external mechanism.
Note: If the SharePoint Domain Name field is mapped to an attribute and then this externally managed option is set to false, any preexisting mapping to attribute will be cleared out. Navigate to Admin Console: People > Settings > Profile and Homepage > Custom Profile fields > Mapping to see mapping for a field.
sharepoint.identity.profilefield.externallyManaged.externalID true to enable whether or not the SharePoint Connector External ID custom identity field is Externally Managed. Set to true (which is default) when the field is populated by LDAP or SSO. Default is true. An application restart is required for changes to this property to take effect. Set to false when the Jive admin will be setting the external ID value in the Admin Console. Setting this value to false is only meant for UAT and POC testing. In general, this profile values should be set by an external mechanism.
Note: If the SharePoint External ID field is mapped to an attribute and then this externally managed option is set to false, any preexisting mapping to attribute will be cleared out. Navigate to Admin Console: People > Setting > Profile and Homepage > Custom Profile fields > Mapping to see mapping for a field.
sharepoint.identity.profilefield.externallyManaged.externalUsername true to enable whether or not the SharePoint Connector Username custom identity field is Externally Managed. Set to true (which is default) when the field is populated by LDAP or SSO. Default is true. An application restart is required for changes to this property to take effect. Set to false when the Jive admin will be setting the username value in the Admin Console. Setting this value to false is only meant for UAT and POC testing. In general, this profile values should be set by an external mechanism.
Note: If the SharePoint External Username field is mapped to an attribute and then this externally managed option is set to false, any preexisting mapping to attribute will be cleared out. Navigate to Admin Console: People > Setting > Profile and Homepage > Custom Profile fields > Mapping to see mapping for a field.
sharepoint.identity.simple.formatProvider.regex.pattern Default is (.+), which means match 1 or more of anything.
sharepoint.identity.simple.formatProvider.regex.group Default is 1, which means group 1 is the value.
sharepoint.ip.restrictions Comma-delimited list of IP addresses for SharePoint servers. If configured, only accepts web service calls from IP addresses on this list, or for IP addresses reported by DNS resolution of the hostname of a SharePoint Location external URL. If this property isn't in place, no restrictions are enforced. Make sure you are using the correct IPv4 and/or IPv6 addresses of the SharePoint web front end (WFE).

For debugging purposes, the IP filter will log what the currently configured list of IP addresses if it rejects a request. It will also log the address that the request came in from. If the request is supposed to be legitimate, add that address to the list in the property's value.

For example, 192.168.1.11, 192.168.1.12,3ffe:1900:4545:3:200:f8ff:fe21:67cf.
Note: If load balancers are used in front of Jive, restricting the incoming IP addresses is not as beneficial because the load balancer IP addresses may have to be entered into this field.

For more information, see Impersonation Restriction Validation

sharepoint.list.macro.showViewNames Boolean property that controls how the document list macro displays lists. Set to true and individual views can be selected instead of just getting the default view for a list. Default is false.
sharepoint.list.timezone.option Calendar Widget time zone option. Default is jive_timezone.
sharepoint.monitor.check.delay Sets the delay (in seconds) before initial execution of the SharePoint monitor background task. Default is 60.
sharepoint.monitor.check.interval Sets the delay (in seconds) between each execution of the SharePoint monitor background task. Default is 5.
sharepoint.monitor.check.skip Determines whether or not the SharePoint monitor background task should be skipped. Default is false.
sharepoint.macro.list.errors.show Show macro errors when Jive for SharePoint List macro is unable to render SharePoint content. Default is false.
sharepoint.macro.list.render.calendarAsList Within the context of Jive for SharePoint List macros, render SharePoint calendars as lists. Default is true.
sharepoint.page.size Number of items returned for paged web service requests. Default is 30.
sharepoint.place.document.count.threshold.enabled Enables accurate counting of documents in socialized Jive places. Default true.
sharepoint.project.document.count.threshold Identifies threshold to accurately count documents in socialized projects. Default 30.
sharepoint.remoteEntitlement.visibilityCheck.enabled true to specify that Jive should perform a SharePoint permission check to determine document visibility in Jive. Default is true.
sharepoint.remoteEntitlement.hideAllStreamed Globally hides all SharePoint streamed documents. Default is false.
sharepoint.serviceaccount.restrictions Accepts a comma-delimited list of Jive user accounts. If configured, Jive for SharePoint only accepts web service calls from Jive accounts in this list. The service accounts used by SharePoint to access Jive as defined in Managing Jive Installations. This is used to limit the accounts that can authenticate to Jive for SharePoint custom web services for impersonation. Separate multiple accounts with commas and do not enter a domain name. If this property isn't in place, no restrictions are enforced. For example, jivesvcacct.

For more information, see Impersonation Restriction Validation

sharepoint.socket.monitor.timeout Sets the socket timeout in milliseconds for SharePoint monitor polling service. Default is 10000.
sharepoint.socket.timeout.millis Sets the socket timeout in milliseconds. Default is 90000.
sharepoint.socialgroup.document.count.threshold Identifies threshold to accurately count documents in socialized groups. Default 30.
sharepoint.space.document.count.threshold Identifies threshold to accurately count documents in socialized spaces. Default 30.
sharepoint.synchronize.blockSize Sets the number for the blocks of users to be processed during the SharePoint identity synchronization task. Default is 1000.
sharepoint.synchronize.yield true indicates that the background SharePoint identity synchronization task should yield CPU between processing blocks of users. Default is true.
sharepoint.viewDocuments.filter.spManaged.option true to enable users to filter documents by files managed in SharePoint. This filter shows documents that live in SharePoint, but can be viewed in Jive. When users select Files Managed by SharePoint as the filter in the Documents tab of a group, space, or projects, they see all documents managed by SharePoint. Default is true.
sharepoint.viewDocuments.filter.spCopied.option true to enable users to filter documents by files copied from SharePoint into Jive. This filter shows documents now live in Jive, but they started in SharePoint. When users select Files Copied from SharePoint as the filter in the Documents tab of a group, space, or projects, they see all documents copied from SharePoint. Default is true.
sharepoint.widget.list.render.calendarAsList Renders SharePoint calendars as lists within the context of the SJive for SharePoint list widget. Default is true.
sharepoint.widget.list.refreshOnValidate When set to true, Jive requests a complete refresh of the SharePoint taxonomy when SharePoint list widgets are saved. Default is true.