System Parameters GW

For basic information on using system parameters, see the System Parameters chapter in the manual for the "Portal & Organization" module.

Webdesk supports the following groupware systems (symbolic names in parentheses): Microsoft Exchange via Exchange Web Services (ExchangeWS_v2), Microsoft 365 / Exchange Online via Microsoft Graph (Graph), Lotus Notes/Domino (LotusNotes), Zimbra (Zimbra), and GroupWise (Groupwise).

Some parameters are only the system-wide default value: If the option "Local configuration" is active in the groupware settings of the client ("Groupware" tab) and a value is set, it takes precedence (noted in the table). Microsoft Graph is configured exclusively in the groupware settings of the client (external APIs) and has no system parameters of its own.

Reference of the Relevant System Parameters for the GW Module

Module	Bean	Property	Explanation	Possible value(s)
gw	GwOptions	serviceImplementationDefault	Groupware system that is used for a person if neither the client (local configuration) nor customSystemImplementationSelectorBean nor mailDomainServiceImplementationMapping determines a system. The previously possible value ExchangeWS (Exchange 2007-2013) no longer exists and is ignored; ExchangeWS_v2 then applies.	ExchangeWS_v2 (default), Graph, LotusNotes, Zimbra, Groupwise
gw	GwOptions	mailDomainServiceImplementationMapping	Mapping of a person's mail domain to the groupware system (per entry @domain = system). Used if the client has no local configuration with a groupware system and no customSystemImplementationSelectorBean supplies a system. The entries supplied are examples.	e.g., @company.at = ExchangeWS_v2
gw	GwOptions	customSystemImplementationSelectorBean	Name of a bean that determines the groupware system per person (e.g., in mixed operation of Exchange and Microsoft 365). GwLdapAttributeBasedSystemImplementationSelector is supplied: it looks up the person in LDAP by their email address (parameters ldapProviderUrl, ldapUser, ldapPassword, ldapBaseDn of this bean) and evaluates the entries in expressions (per entry JavaScript expression;system). The local configuration of the client takes precedence.	Bean name (default: empty)
gw	GwOptions	generalUser	Technical user for access to the groupware system. Can be used in the server parameter lists as $generalUser. A user in the groupware settings of the client takes precedence.
gw	GwOptions	generalPassword	Password of the technical user (stored encrypted). Can be used in the server parameter lists as $generalPassword. A password in the groupware settings of the client takes precedence.	*****
gw	GwOptions	groupsToCheck	Short names of the groups whose persons are enabled for the groupware integration (reading and synchronizing appointments). If a short name ends with +, the persons of all subgroups are also taken into account; * enables all persons. In addition, all persons of a client are enabled if "Enabled for all persons" is set in its groupware settings. For Microsoft Graph, the activation is controlled per person via the external API.	List of group short names (default: empty)
gw	GwOptions	personsNotToCheck	Persons whose groupware calendar is never read or written (specified by user name).	List of user names (default: dek)
gw	GwOptions	wfFlagValueForWrittenAppointments	Category used to mark appointments that Webdesk writes to the groupware calendar (formerly wfFlag).	Text (default: Webdesk3)
gw	GwOptions	monthsToCheckInPast	Time span in months into the past in which the job "DeleteCalendarDates" deletes appointments written by Webdesk. The job "syncCalendarDates" uses its own job parameters.	Number (default: 1)
gw	GwOptions	monthsToCheckInFuture	Time span in months into the future in which the job "DeleteCalendarDates" deletes appointments written by Webdesk.	Number (default: 4)
gw	GwOptions	userMappingStrategy	Determination of a person's groupware user: USERNAME = user name of the person, EMAIL = email address of the person, LDAP = lookup in LDAP (see GwADLdapClient). The client setting "User mapping strategy" takes precedence.	LDAP (default), EMAIL, USERNAME
gw	GwOptions	userMappingField	Field of the person used for the search when userMappingStrategy is LDAP. The client setting "Field from master record for groupware user" takes precedence.	USERNAME (default), MAILADDRESS, EMPLOYEEID
gw	GwOptions	allowEditOfMailForwardingAsAdmin	If true, administrators can also change another person's email forwarding in the groupware settings (absence) when editing that person. One's own settings can always be edited.	true/false (default: false)
gw	GwADLdapClient	ldapProviderUrl	URL of the LDAP server used to determine the person's groupware data when userMappingStrategy is LDAP. The LDAP settings in the groupware settings of the client (local configuration) take precedence.	ldap://testserver (must be adapted)
gw	GwADLdapClient	ldapUser	User for the LDAP query.	sadmin
gw	GwADLdapClient	ldapPassword	Password for the LDAP query (stored encrypted).	*********
gw	GwADLdapClient	ldapBaseDn	Base DN(s) under which to search.	o=zeit
gw	GwADLdapClient	ldapSearchQuery	LDAP search query; {0} is replaced by the value of the field userMappingField.	(&(objectclass=person)(uid={0}))
gw	GwADLdapClient	ldapSearchSubTree	Also search in child nodes of the base DN.	true/false (default: true)
gw	GwADLdapClient	cutDomain	If true, the domain part of the user name is not taken into account in the LDAP search.	true/false (default: true)
gw	GwLegacyLdapFieldNameConfiguration	ldapFieldNameHomeServer, ldapFieldNameMailboxName, ldapFieldNamePrincipalName, ldapFieldNameMailAddress	LDAP field names for home server, mailbox/mail file, principal name, and email address (formerly in the bean GwADLdapClient). Only used if all four fields are populated; otherwise the default values of the respective groupware system apply (Exchange: msExchHomeServerName, mailNickname, userPrincipalName, mail; Notes: mailserver, mailfile, displayname, mail; Zimbra: zimbraMailHost, mail, mail, mail).	LDAP field name (default: empty)
gw	GwServerParamListExchange2016Ws, GwServerParamListLotusNotes, GwServerParamListZimbra, GwServerParamListGroupwise	elements	Connection data per groupware server of the respective system (formerly bean GwServerParamList), per entry server name;URL;port;user;password. $generalUser and $generalPassword can be used for user and password; otherwise the password is stored here unencrypted. The connection data in the groupware settings of the client (local configuration) take precedence.	e.g., server1;https://server1/EWS/Exchange.asmx;;$generalUser;$generalPassword
gw	GwCalendarServiceNotesImpl	deliverAllAppointmentTypes	If true, all Notes appointment types are read; if false, only appointments, all-day events, and meetings (no anniversaries and reminders).	true/false (default: true)
gw	GwCalendarServiceNotesImpl	freeBusyServerParams	Separate server for free/busy queries in Notes, in the format server name;URL;port;user;password. Empty: free/busy is queried via the normal connection.	Default: empty
gw	GwCalendarServiceNotesImpl	secondsToLiveDominoFreeBusyCache	Duration in seconds until the free/busy cache is renewed between queries; 0 or empty switches the cache off.	900
gw	GwCalendarServiceExchangeImpl	absenceReasonsToSync, allowedEntriesPostfix, alternateFreeBusyServer, busyStatus, descPrefix, groupsToCheck, monthsToCheckInFuture, monthsToCheckInPast, notAllowedEntriesPostfix, personsNotToCheck, syncType, useSpecialMapiProperties	Removed. The connection to Exchange via WebDAV (Exchange 2000-2007) no longer exists. Exchange is connected via ExchangeWS_v2 or Microsoft Graph.	-
gw	GwCalendarServiceExchangeWSImpl	absenceReasonsToSync, allowedEntriesPostfix, busyStatus, descPrefix, disableChunkedEncoding, groupsToCheck, monthsToCheckInFuture, monthsToCheckInPast, notAllowedEntriesPostfix, ntlmDomain, ntlmDomainController, personsNotToCheck, recreateServiceStubOnEveryCall, syncType, useNtlmAuthenticationScheme, useOnlyBasicAuthenticationScheme, wfFlag	Removed. The connection to Exchange 2007-2013 via the old Exchange web service interface (system ExchangeWS) no longer exists. Exchange is connected via ExchangeWS_v2 or Microsoft Graph.	-
gw	GwCalendarServiceNotesImpl	absenceReasonsToSync, allowedEntriesPostfix, descPrefix, groupsToCheck, monthsToCheckInFuture, monthsToCheckInPast, notAllowedEntriesPostfix, personsNotToCheck, syncType, userdataLocation, wfFlag	Removed. These parameters no longer exist per groupware system. Replacement: groupsToCheck, personsNotToCheck, monthsToCheckInPast, monthsToCheckInFuture, and wfFlag (now wfFlagValueForWrittenAppointments) in the bean GwOptions; syncType, absenceReasonsToSync, descPrefix, allowedEntriesPostfix, and notAllowedEntriesPostfix are parameters of the job "syncCalendarDates" (default values for descPrefix, allowedEntriesPostfix, notAllowedEntriesPostfix, and the absence reasons in the bean TaSyncCalendarDatesDefaultSettings). userdataLocation is dropped without replacement.	-
gw	GwRefreshableCalendarServiceTargetSource	beanId, defaultBeanId, generalInterface	Removed. The groupware system is defined via GwOptions.serviceImplementationDefault, GwOptions.mailDomainServiceImplementationMapping, or the groupware settings of the client.	-

Module

Bean

Property

Explanation

Possible value(s)

GwOptions

serviceImplementationDefault

Groupware system that is used for a person if neither the client (local configuration) nor customSystemImplementationSelectorBean nor mailDomainServiceImplementationMapping determines a system. The previously possible value ExchangeWS (Exchange 2007-2013) no longer exists and is ignored; ExchangeWS_v2 then applies.

ExchangeWS_v2 (default), Graph, LotusNotes, Zimbra, Groupwise

GwOptions

mailDomainServiceImplementationMapping

Mapping of a person's mail domain to the groupware system (per entry @domain = system). Used if the client has no local configuration with a groupware system and no customSystemImplementationSelectorBean supplies a system. The entries supplied are examples.

e.g., @company.at = ExchangeWS_v2

GwOptions

customSystemImplementationSelectorBean

Name of a bean that determines the groupware system per person (e.g., in mixed operation of Exchange and Microsoft 365). GwLdapAttributeBasedSystemImplementationSelector is supplied: it looks up the person in LDAP by their email address (parameters ldapProviderUrl, ldapUser, ldapPassword, ldapBaseDn of this bean) and evaluates the entries in expressions (per entry JavaScript expression;system). The local configuration of the client takes precedence.

Bean name (default: empty)

GwOptions

generalUser

Technical user for access to the groupware system. Can be used in the server parameter lists as $generalUser. A user in the groupware settings of the client takes precedence.

GwOptions

generalPassword

Password of the technical user (stored encrypted). Can be used in the server parameter lists as $generalPassword. A password in the groupware settings of the client takes precedence.

*****

GwOptions

groupsToCheck

Short names of the groups whose persons are enabled for the groupware integration (reading and synchronizing appointments). If a short name ends with +, the persons of all subgroups are also taken into account; * enables all persons. In addition, all persons of a client are enabled if "Enabled for all persons" is set in its groupware settings. For Microsoft Graph, the activation is controlled per person via the external API.

List of group short names (default: empty)

GwOptions

personsNotToCheck

Persons whose groupware calendar is never read or written (specified by user name).

List of user names (default: dek)

GwOptions

wfFlagValueForWrittenAppointments

Category used to mark appointments that Webdesk writes to the groupware calendar (formerly wfFlag).

Text (default: Webdesk3)

GwOptions

monthsToCheckInPast

Time span in months into the past in which the job "DeleteCalendarDates" deletes appointments written by Webdesk. The job "syncCalendarDates" uses its own job parameters.

Number (default: 1)

GwOptions

monthsToCheckInFuture

Time span in months into the future in which the job "DeleteCalendarDates" deletes appointments written by Webdesk.

Number (default: 4)

GwOptions

userMappingStrategy

Determination of a person's groupware user: USERNAME = user name of the person, EMAIL = email address of the person, LDAP = lookup in LDAP (see GwADLdapClient). The client setting "User mapping strategy" takes precedence.

LDAP (default), EMAIL, USERNAME

GwOptions

userMappingField

Field of the person used for the search when userMappingStrategy is LDAP. The client setting "Field from master record for groupware user" takes precedence.

USERNAME (default), MAILADDRESS, EMPLOYEEID

GwOptions

allowEditOfMailForwardingAsAdmin

If true, administrators can also change another person's email forwarding in the groupware settings (absence) when editing that person. One's own settings can always be edited.

true/false (default: false)

GwADLdapClient

ldapProviderUrl

URL of the LDAP server used to determine the person's groupware data when userMappingStrategy is LDAP. The LDAP settings in the groupware settings of the client (local configuration) take precedence.

ldap://testserver (must be adapted)

GwADLdapClient

ldapUser

User for the LDAP query.

sadmin

GwADLdapClient

ldapPassword

Password for the LDAP query (stored encrypted).

*********

GwADLdapClient

ldapBaseDn

Base DN(s) under which to search.

o=zeit

GwADLdapClient

ldapSearchQuery

LDAP search query; {0} is replaced by the value of the field userMappingField.

(&(objectclass=person)(uid={0}))

GwADLdapClient

ldapSearchSubTree

Also search in child nodes of the base DN.

true/false (default: true)

GwADLdapClient

cutDomain

If true, the domain part of the user name is not taken into account in the LDAP search.

true/false (default: true)

GwLegacyLdapFieldNameConfiguration

ldapFieldNameHomeServer, ldapFieldNameMailboxName, ldapFieldNamePrincipalName, ldapFieldNameMailAddress

LDAP field names for home server, mailbox/mail file, principal name, and email address (formerly in the bean GwADLdapClient). Only used if all four fields are populated; otherwise the default values of the respective groupware system apply (Exchange: msExchHomeServerName, mailNickname, userPrincipalName, mail; Notes: mailserver, mailfile, displayname, mail; Zimbra: zimbraMailHost, mail, mail, mail).

LDAP field name (default: empty)

GwServerParamListExchange2016Ws, GwServerParamListLotusNotes, GwServerParamListZimbra, GwServerParamListGroupwise

elements

Connection data per groupware server of the respective system (formerly bean GwServerParamList), per entry server name;URL;port;user;password. $generalUser and $generalPassword can be used for user and password; otherwise the password is stored here unencrypted. The connection data in the groupware settings of the client (local configuration) take precedence.

e.g., server1;https://server1/EWS/Exchange.asmx;;$generalUser;$generalPassword

GwCalendarServiceNotesImpl

deliverAllAppointmentTypes

If true, all Notes appointment types are read; if false, only appointments, all-day events, and meetings (no anniversaries and reminders).

true/false (default: true)

GwCalendarServiceNotesImpl

freeBusyServerParams

Separate server for free/busy queries in Notes, in the format server name;URL;port;user;password. Empty: free/busy is queried via the normal connection.

Default: empty

GwCalendarServiceNotesImpl

secondsToLiveDominoFreeBusyCache

Duration in seconds until the free/busy cache is renewed between queries; 0 or empty switches the cache off.

900

GwCalendarServiceExchangeImpl

absenceReasonsToSync, allowedEntriesPostfix, alternateFreeBusyServer, busyStatus, descPrefix, groupsToCheck, monthsToCheckInFuture, monthsToCheckInPast, notAllowedEntriesPostfix, personsNotToCheck, syncType, useSpecialMapiProperties

Removed. The connection to Exchange via WebDAV (Exchange 2000-2007) no longer exists. Exchange is connected via ExchangeWS_v2 or Microsoft Graph.

GwCalendarServiceExchangeWSImpl

absenceReasonsToSync, allowedEntriesPostfix, busyStatus, descPrefix, disableChunkedEncoding, groupsToCheck, monthsToCheckInFuture, monthsToCheckInPast, notAllowedEntriesPostfix, ntlmDomain, ntlmDomainController, personsNotToCheck, recreateServiceStubOnEveryCall, syncType, useNtlmAuthenticationScheme, useOnlyBasicAuthenticationScheme, wfFlag

Removed. The connection to Exchange 2007-2013 via the old Exchange web service interface (system ExchangeWS) no longer exists. Exchange is connected via ExchangeWS_v2 or Microsoft Graph.

GwCalendarServiceNotesImpl

absenceReasonsToSync, allowedEntriesPostfix, descPrefix, groupsToCheck, monthsToCheckInFuture, monthsToCheckInPast, notAllowedEntriesPostfix, personsNotToCheck, syncType, userdataLocation, wfFlag

Removed. These parameters no longer exist per groupware system. Replacement: groupsToCheck, personsNotToCheck, monthsToCheckInPast, monthsToCheckInFuture, and wfFlag (now wfFlagValueForWrittenAppointments) in the bean GwOptions; syncType, absenceReasonsToSync, descPrefix, allowedEntriesPostfix, and notAllowedEntriesPostfix are parameters of the job "syncCalendarDates" (default values for descPrefix, allowedEntriesPostfix, notAllowedEntriesPostfix, and the absence reasons in the bean TaSyncCalendarDatesDefaultSettings). userdataLocation is dropped without replacement.

GwRefreshableCalendarServiceTargetSource

beanId, defaultBeanId, generalInterface

Removed. The groupware system is defined via GwOptions.serviceImplementationDefault, GwOptions.mailDomainServiceImplementationMapping, or the groupware settings of the client.

System Parameters GW

General

Reference of the Relevant System Parameters for the GW Module