Fields

The configuration options are stored in a hierarchically organized XML file, with settings in specific nodes and attribute values. Some nodes and settings interact with each other, and you link them by specifying the other node's Name attribute as an attribute value.

The logical interconnections between these nodes are shown below:

Information

The Information section contains general configuration information about the customer.

Attribute	Description	Values	Cross reference
CustomerName	The display name (or short name) of the customer. This field is not used in any other instances.	Type: String
CustomerNumber	The customer ID that Retarus assigned to this customer. It will be used in the DirSync Service to allot the upload data to the customer’s data segment in the Retarus backend.	Type: String

Options

The Options section contains configuration information on general, basic operation options of the service, i.e. logging, etc.

Attribute	Description	Values
LogRotation Days	The number of days for which old synchronization logs should be stored. Any logs older than the value specified here will be deleted.	Type: Integer
FileArchiving Days	The number of days that the copy of the sync data files created by the Windows service should be stored. Any files older than the value specified here will be deleted. The copies of these files may contain in some customer configurations information which might be subject to privacy regulations. Due to this fact, Retarus strongly recommends setting this value to 0 as soon as the implementation and test phase have been successfully completed to avoid any privacy violations	Type: Integer
ApplicationLog Level	The granularity of the information stored in the application’s log file on the local hard disk. The application’s log file is stored in the folder `%PROGRAMDATA%\Retarus\DirSync\Logs` or in the folder specified in the configuration. See UseApplicationDataPath and CustomDataPath for more information on customizing this log location. For detailed information about the various log levels available, see Logging.	NONE FATAL ERROR WARN INFO DEBUG FINETRACE
EventLogLevel	The granularity of the information stored in the system’s EVENT LOG. For detailed information about the various log levels available, see Logging.	NONE FATAL ERROR WARN INFO DEBUG TRACE FINETRACE
AdvancedTrace Logs	If set to `True`, additional directory information is written to text files for analysis purposes (e.g., AD objects, email addresses, groups, etc.). Due to the fact that this may result in privacy issues, use this option cautiously.	True False
ConfigFileType	Reserved for future purposes. Do not change.
ConfigFileVersion	Reserved for future purposes. Do not change.
UseApplication DataPath	If set to `False`, all log information will be stored in the same directory as the `RetarusDirSync.exe` is located. If set to `True`, the `%ProgramData%\Retarus\DirSync` folder will be used to store any log information. The default value is `True`.	True False
CustomDataPath	Specifies a custom folder where all log information should be stored. If empty, the settings of `UseApplicationPath` will be applied. If the folder specified here does not exist, it will be created.	String

EMailFeedback

The EMailFeedback section specifies if and how dedicated recipients should be informed about the operation of the service.

Attribute	Description	Values	Cross reference (XML Node)
ToAddress	The email address to which any notifications should be sent. This field may contain several email addresses that must then be separated by a semicolon (;).	Type: String
FromAddress	The email address that should be used as the sender for the notification emails.	Type: String
Type	The type of notifications that should be sent. OFF results in no notifications being sent. POSITIVE results in success reports only being sent. NEGATIVE results in error reports only being sent. BOTH results in both success and error reports being sent.	OFF POSITIVE NEGATIVE BOTH
CredentialName	If required, the mail server, username and password (Credential) of the mail server to which the mail should be relayed.	Type: String	Credential.Name

Servers

The Servers section specifies information on any directory servers, such as Microsoft Active Directory, Lotus Domino, Open LDAP, etc., that the service might have to contact. Multiple child nodes of type Server are possible, offering the following attribute options.

Attribute	Description	Values	Cross reference (XML Node)
Name	The name of the server for which information is specified here. This will be used in the config to identify the server that is to be contacted.	Type: String	SyncConfig.ServerName
Description	A description that helps identify the server, its purpose, etc.	Type: String
ServerAdress	The network address of the server.	Type: String
Port	The TCP/IP port to be used for this server.	Type: String
PageSize	If required, any paging that should be applied by the service (fetching a set number of results per query, repeating multiple queries). Applies only to the server responsible for Active Directory queries. If set to 0, the response of the AD server will contain only the number of records specified in the server’s AD settings as a default paging, but not more records even if they exist (MaxPageSize; Microsoft default is 1,000). Any value larger than 0 and smaller than or equal to the MaxPageSize of the server will result in a response consisting of various result pages (as many as required), containing all the records responding to the query. The recommended default value is 1,000. For IBM Domino, this value should be 0. If not specified, the default value is 0.	Type: Integer
CredentialName	If required, the username and password (Credential) to connect to the server.	Type: String	Credential.Name
AuthType	The means of authentication that this server requires. Anonymous. No authentication is performed. Delegation. Enables Active Directory Services Interface (ADSI) to delegate the user's security context, which is necessary for moving objects across domains. Encryption. Attaches a cryptographic signature to the message that identifies the sender and ensures that the message has not been modified in transit. FastBind. Specifies that ADSI will not attempt to query the Active Directory Domain Services objectClass property. Therefore, only the base interfaces that are supported by all ADSI objects will be exposed. Other interfaces that the object supports will not be available. A user can use this option to boost the performance in a series of object manipulations that involve only methods of the base interfaces. However, ADSI does not verify if any of the request objects actually exist on the server. For more information, see the topic "Fast Binding Option for Batch Write/Modify Operations" in the MSDN Library at http://msdn.microsoft.com/library. For more information about the objectClass property, see the Object-Class topic in the MSDN Library at http://msdn.microsoft.com/library. None. Equates to zero, which means using basic authentication (simple bind) in the LDAP provider. ReadonlyServer. For a WinNT provider, ADSI tries to connect to a domain controller. For Active Directory Domain Services, this flag indicates that a writable server is not required for serverless binding. Sealing. Encrypts data using Kerberos. The Secure flag must also be set to use sealing. Secure. Requests secure authentication. When this flag is set, the WinNT provider uses NTLM to authenticate the client. Active Directory Domain Services uses Kerberos, and possibly NTLM, to authenticate the client. When the user name and password are a null reference (Nothing in Visual Basic), ADSI binds to the object using the security context of the calling thread, which is either the security context of the user account under which the application is running or of the client user account that the calling thread is impersonating. SecureSocketsLayer. Attaches a cryptographic signature to the message that both identifies the sender and ensures that the message has not been modified in transit. Active Directory Domain Services requires the Certificate Server be installed to support Secure Sockets Layer (SSL) encryption. ServerBind. If your ADsPath includes a server name, specify this flag when using the LDAP provider. Do not use this flag for paths that include a domain name or for serverless paths. Specifying a server name without also specifying this flag results in unnecessary network traffic. Signing. Verifies data integrity to ensure that the data received is the same as the data sent. The Secure flag must also be set to use signing. For more information on the authentication types, see the Microsoft documentation at http://msdn.microsoft.com/en- us/library/system.directoryservices.authenticati ontypes(v=vs.110).aspx.	DEFAULT SECURE ENCRYPTION SECURESOCKETSLAYER READONLYSERVER ANONYMOUS FASTBIND SIGNING SEALING DELEGATION SERVERBIND

Credentials

The Credentials section contains information on authentication information that the service may be required to use. Multiple child nodes of type Credential are possible, offering the following attribute options.

You may store passwords in plaintext (unencrypted) in the config file, but it is recommended to use the “Password Tool” included in the setup and described in Password tool.

Attribute	Description	Values	Cross reference (XML Node)
Name	The name of the credentials set for which information is specified here. This will be used in the config to identify the credentials which are to be applied.	Type: String	Credential.Proxy CredentialName EMailFeedback. CredentialName Server.Credential Name SyncConfig. CredentialName
Description	A description that helps identify the credentials, their purpose, etc.	Type: String
UserId	The user name of the credentials set.	Type: String
Password	The password of the credentials set.	Type: String
ServerAddress	The server address associated with the credentials set. This is required for any servers that are not directory servers (e.g., proxy server, mail servers, Retarus Gateway, etc.).	Type: String
Port	The TCP/IP port to be used for this server address (attribute ServerAddress). If set to “0”, the default port for the type of the service will be used (i.e. 389 for Active Directory, 25 for SMTP, 3268 for GC, etc.). This is commonly used if the credentials are required for a web proxy (i.e. 8080).	Type: Integer
EnableSSL	Defines if the network connection established via this credentials’ set should use SSL for encryption. This is commonly used if the credentials are required for the https proxy or the SMTP relay server.	True False
UseDefault Credentials	Defines if the user credentials associated with the user in whose context the DirSync Client is executed should be used. Will not work if the windows service is running in system security contexts such as LOCAL SYSTEM, etc.	True False
Compression	Defines if the data sent via connections using this credentials set should be compressed or not. To allow for GZIP compression, this option needs also to be enabled within the Retarus infrastructure. Enabling it in this config only does not suffice.	OFF GZIP
ProxyCredential Name	Defines which credentials configuration CredentialName should be used to upload the data via a web proxy to Retarus.	True False	Credential.Name
Retries	Specifies how many retries the service should attempt uploading the same data to Retarus. If unsuccessful, the next upload attempt with new data will follow at the specified interval. Default value is 0.	Integer
HTTPVersion	Specifies which version of the HTTP protocol should be used for the upload. Default value is HTTP11.	HTTP10 HTTP11
AddtionalOption Name	Specifies the name of the AdditionalOptionSet that should be applied in addition to this credentials set.	String	AdditonalOption Set.Name

Password tool

In order to avoid storing passwords in plain text in your local configuration file, you may use the Retarus DirSync “Password Tool” included in the setup files.

The tool has to be started within the context of a user having read and write permissions to the DirSync xml configuration file.

To store your passwords encrypted, follow the steps below:

Execute RetarusDirSync_PasswordTool.exe.
To encrypt passwords of an already existing configuration file, click on Import passwords from configuration file. Existing passwords are displayed in plain text or with asterisks (*****) if they have been encrypted already. If you click on Store passwords, all passwords are encrypted and stored in the configuration file.
If you enter a password for the first time, choose the correct line (entity), insert the corresponding password in the column on the right side and click on Store passwords. All passwords are encrypted and stored in the configuration file.

DirectoryRequests

The DirectoryRequests section specifies information on how directory services or servers should be contacted/queried for user information. Multiple child nodes of type DirectoryRequest are possible, offering the following attribute options:

Attribute	Description	Values	Cross reference (XML Node)
Name	The name of the directory request for which information is specified here. This will be used in the config to identify the directory requests which are be executed.	Type: String	SyncConfig. DirectoryRequest Name
Description	A description that helps identifying the directory request, their purpose, etc.	Type: String
Path	Defines the means by which the directory should be queried. LDAP queries the directory in a standard way common for the Lightweight Directory Access Protocol. GC queries the directory based on the Microsoft Active Directory Global Catalog. Recommended for Microsoft Active Directory. The default value is LDAP.	LDAP GC
SearchFilter	Defines a filter that should be applied in this directory request. Standard LDAP filter syntax is to be applied here. Please note: The typical LDAP search character “&” must be escaped as an HTML entity “&”. This applies also to any characters in your filter string that might be interpreted as HTML or XML code characters (i.e. “<”, “>” etc.)	Type: String
TrailingFilter Name	Specifies the name of the additional filter TrailingFilter that should be applied onto the result set after it has been received by the directory request.	Type: String	FilterTable. Name
SendDigestTo GroupManager	For Retarus Email Security services only and if the current object is a distribution group: Specifies if the Antispam Report notification email should be sent to all recpients of a distribution group, or to the manager of a distribution group only (AD field “managed by”). If set to True, only the group manager will receive antispam reports by mail, and all mails quarantined will be moved to the antispam quarantine of the manager.	True False
AlternativeManaged ByDataSourceField Name	For Retarus Email Security services only and if SendDigestToGroupManager is set to True. If an AD data source field is specified here, the DirSync will not use the AD’s ManagedBy field. Instead, it will check if the field specified here contains the DN of a valid AD object and will then use this object’s mail address as the digest recipient address. Example `extensionAttribute10 = "CN=John` `Doe,OU=Sales,OU=DE,OU=Contoso,DC=cor p,DC=local"`	String
GroupFilter Name	Specifies the name of the GroupTable that should be applied to the result set of the directory request.	String	GroupTable. Name
UserAccount Checks	Verifies if a user is disabled in the AD (AD attribute userAccountControl) or mail-enabled in Exchange (Exchange attribute msExchRecipientTypeDetails). The values used for these attributes are the original Microsoft values. For some of these values, the DirSync will return true if the respective flag is not set. Therefore, the flag name may e.g. include the text “disabled”, but in fact the opposite is checked, if the user is enabled. For more information on these attributes, please visit User-Account-Control attribute or Archived MSDN and TechNet Blogs. NOCHECKS is the default value, resulting in the Dirsync to always include users in the Dirsync regardless of them being disabled in the AD or in Exchange. The other values can be combined to achieve extended validation. When combining the available options, use the blank character to separate the values. If all the conditions specified apply, the user will be included in the Dirsync export. The following values can be used: EXCHMAILENABLED verifies if the user is mail-enabled in Exchange. EXCHUSERDISABLED verifies if the user is disabled in Exchange. The user will only be synced if this flag returns false. ACCOUNTDISABLED verifies if the user is disabled in the AD. The user will only be synced if this flag returns false. ACCOUNTLOCKED verifies if the user account is locked in the AD. The user will only be synced if this flag returns false. Example If you want to include only users whose AD account is enabled and who are mail-enabled in Exchange, add the following attribute to the DirectoryRequest tag: `UserAccountChecks="EXCHMAILENABLED ACCOUNTDISABLED"`	String

SyncConfigs

The SyncConfigs section specifies information on what synchronization configurations should be executed. Multiple child nodes of type SyncConfig are possible, offering the following attribute options.

Attribute	Description	Values	Cross reference (XML Node)
Name	The name of the dirsync config for which information is specified here. This will be used in the config to identify the dirsyncs which are be executed.	Type: String
Description	A description that helps identify the dirsync, its purpose, etc.	Type: String
Active	Defines if this synchronization configuration should be executed or should not be executed.	True False
SyncType	Specifies the type of service for which the data should be synchronization.	UNDEFINED MANAGEDMAIL MAIL2FAX FAXINBOUND MAIL2SMS USERMAILREF
CredentialName	Specifies the name of the Credential set to be used for this synchronization set (upload to Retarus).	Type: String	Credential.Name
ServerName	Specifies the name of the Server config to be used for this synchronization set (the directory server).	Type: String	Server.Name
DirectoryRequestName	Specifies the name of the DirectoryRequest config to be used for this synchronization set.	Type: String	DirectoryRequest.Name
MappingName	Specifies the name of the Mapping config to be used for this synchronization set.	Type: String	Mapping.Name
WriteToFileName	Specifies the name of the map file that should be written to some accessible storage location.	Type: String
IntervalName	Specifies the name of the Interval config to be used for this synchronization set.	Type: String	Interval.Name
EOFMarker	Defines the text string to be used for indicating that the end of the file has been reached. Should be empty. If empty, the default value will be applied depending on the specified SyncType (i.e. for Managed Mail, it is ++++).	Type: String
DisableDigestMapping	For Email Security only. Specifies if the alias addresses from the directory should not be mapped to the primary mail address so that every email address, even alias addresses, receive their individual quarantine and spam report notification by mail.	True False
CustomerNumber	The customer number assigned by Retarus. This is important for accounting. It is possible to have several SyncConfig records with differing customer numbers.	String
Separator	The character used to separate values for CSV export. Typically, possible chars are comma or semicolon.	Char
IncludeFileName	Specifies a file that should be included into the synchronization data. Only one file can be specified, and its full path should be provided. The file’s information will be appended at the end of the data right before the End-of-file marker (EOFMarker). With Managed Email data, the information in the file must conform to the Retarus MAP File Format. With other services such as Fax or SMS, the data in the file must be in the correct CSV format corresponding to the service using the appropriate delimiter char, column sequence, data type for each column, and field content escaping (double- quotes, etc.). The file’s CSV data must not contain a header line, but start with the data right away in the first line. For more information about these formats, see Appendix.	Type: String

FaxInboundOptions

FaxInboundOptions contains information specific to the Retarus Fax Inbound Services in a separate XML child node within the SyncConfig node. Within every SyncConfig node, there may only be one FaxInboundOptions tag.

Attribute	Description	Values	Cross reference (XML Node)
MaximumEMail Length	Specifies the size of the field containing the recipients’ email addresses to which the faxes would be forwarded by mail. The size is specified in bytes, the default value is 900. This also is the maximum size supported by Retarus. This field is used if an inbound fax number is assigned to more than one email address. To avoid that too many people get the same fax, all email addresses exceeding the maximum size of the field are skipped.	Integer
ErrorHandling	Specifies how the error should be handled if the maximum number of 900 bytes for the recipients of a fax inbound number is exceeded. Possible values are: DROPFILE results in the entire upload file not being uploaded. DROPENTRY results in the affected record being dropped only. In both cases, a log file with the skipped entries is written into the directory where the service logs are stored.	DROPFILE DROPENTRY
Option	Specifies how to verify if an inbound fax number that is to be uploaded does already exist or has already been configured. NOMATCH results in no verification being completed. It is the responsibility of the customer’s administrator to ensure no double records for inbound fax numbers exist. BLOCKNUMBER results in the first part of the fax number, the block number, being compared (not including the extension). If the number to upload already exists in this comparison, the target email address for recipients is added to already existing email recipients for this fax inbound number. EXTENSION results in the extension of the fax number being compared (not including the block number). If the number to upload already exists in this comparison, the target email address for recipients is added to already existing email recipients for this fax inbound number. BLOCKEXTENSION results in the entire fax number, both the block number and the extension, being compared. If the number to upload already exists in this comparison, the target email address for recipients is added to already existing email recipients for this fax inbound number.	NOMATCH BLOCKNUMBER EXTENSION BLOCKEXTENSION

Mappings

The Mappings section specifies information on various mapping configurations for mapping directory information to the fields required by the Retarus service. Multiple child nodes of type Mapping are possible, offering the following attribute options:

Attribute	Description	Values	Cross reference (XML Node)
Name	The name of the mapping set for which information is specified here. This will be used in the configuration to identify the mapping which is to be applied.	Type: String
Description	A description that helps identifying the credentials, their purpose, etc.	Type: String
SyncType	Specifies the type of service for which the data should be synchronization. MANAGEDMAIL specifies that the data uploaded with this sync is for the Retarus Email Security services. MAIL2FAX specifies that the data uploaded with this sync is for the Retarus Fax Outbound Services (Mail to Fax, Faxolution for Exchange, Faxolution for Lotus Notes). FAXINBOUND specifies that the data uploaded with this sync is for the Retarus Fax Inbound Services (Fax-to-Email, Fax-to-FTP). MAIL2SMS specifies that the data uploaded with this sync is for the Retarus Mail to SMS Services (Mail to SMS, SMS for Exchange). USERMAILREF specifies that the data uploaded consists only of the value pair of the AD sAMAccountName and the primary email address associated with the sAMAccountName. Used for special services (i.e. with multi-function devices).	MANAGEDMAIL MAIL2FAX FAXINBOUND MAIL2SMS USERMAILREF

FieldMappings

The FieldMappings section are child nodes of a node Mapping and specify information on how data from the directory should be mapped to the information/fields required by the Retarus service. Multiple child nodes of type FieldMapping are possible, then specifying in detail each individual value mapping, offering the following attribute options.

Attribute	Description	Values	Cross reference (XML Node)
Name	The name of the mapping that is configured here. This is for informational purposes only.	Type: String	SyncConfig.MappingName
Active	Defines if this synchronization configuration should be executed or should not be executed.	True False
Type	Specifies the type of data mapped in this mapping. PRIMARYADDRESS is used in all products using email and specifies that this field is the primary email address. This field is mandatory and must not be omitted. ALIASADDRESS is used in the service MANAGED MAIL and specifies that this field contains one or multiple alias email addresses. PROFILE is used in all services offering user profiles (i.e., Email Security, Email-to-Fax, Fax-to-Email), and specifies that this field contains information to which profile this data record should be mapped to. USERID is used for sync type USERMAILREF and specifies that this record contains the sAMAccountName. BILLINGCODE is used in the SMS and Fax services and specifies the billing code (or cost center) that this record should be mapped to. The data type of this field is a String. CSID is used in the fax inbound, fax outbound and SMS outbound services and specifies what phone number should be used as the user’s phone or fax number. The possible value with which the data field may then be populated is a phone number, preferably in international format preceded with “+” (i.e., +199987654321); however, it may also contain a text string such as a name. Note that with SMS outbound services, the message may not be deliverable in some countries if this string is not a valid phone number. This is due to legal regulations in some countries. For more information, refer to the detailed documentation “Country-specific SMS Features and Restrictions” available via the Retarus myEAS portal. ADD_CSID is available for Fax Inbound and allows to specify an additional CSID to be used for this user. This way, a user may have multiple fax inbound connections. BUSYRETRIES is used in Fax outbound and specifies the number of retries that this account should attempt in case the recipient station is busy. Possible values with which the data field may be populated are integers from 0 to 10. ERRORRETRIES is used in Fax Outbound and specifies the number of retries that this account should attempt in case the recipient station reports an error during transmission. Possible values with which the data field may be populated are integers from 0 to 10. RESOLUTION is used in the Fax Outbound and specifies the resolution to be used with this account per default. Possible values with which the data field may then be populated are HIGH and LOW. BLACKLIST is used in Fay Outbound and specifies if national black lists, such as the German Robinson list, should be applied when sending out faxes. Currently, the only blacklist supported is the German Robinson list. DEFAULTCOUNTRYCODE is used in Fax Outbound and specifies the default country code that should be assumed in case the country code is not specified in the individual Fax send job. Possible values with which the data field may be populated are Strings containing a compliant country code (i.e. “+1” or “+49”). DEFAULTAREACODE is used in Fax Outbound and specifies the default area code that should be assumed in case the area code is not specified in the individual Fax send job. Possible values with which the data field may be populated are Strings containing a compliant area code, usually without any preceding zeros (i.e. “89” or “601”). REPLYTO is used in Email-to-Fax and specifies what email address any status reports should be sent to. Possible vales are: NOBODY, resulting in no status reports being sent; SENDER, resulting in the sender receiving the status report; or any valid email address to which any status reports will then be sent to. REPLYCC is used in Email-to-Fax and specifies what email address any copies of status reports should be sent to. Possible vales are: NOBODY, resulting in no status reports being sent; SENDER, resulting in the sender receiving the status report; or any valid email address to which any status reports will then be sent to. ERRORTO is used in Email-to-Fax and specifies what email address any error reports should be sent to. Possible vales are: NOBODY, resulting in no error reports being sent; SENDER, resulting in the sender receiving the error report; or any valid email address to which any error reports will then be sent to. LANGUAGE is used in both Fax and SMS services and specifies the language of the result report that the user will receive at the end of the Fax or SMS job. Possible values are DE, EN, ES, FR, and IT. REPLYFORMAT is used in Fax and SMS services and specifies if the report sent to the user should be in plain text or in formatted HTML. Possible values are SHORT, LONG, HTML, HTMLCMT. For more information about the difference between these values, consult the Fax documentation. ONLYATTACHMENTS is used in Fax Outbound and specifies if only the attachments in the email should be sent via fax, or if the email’s body should also be included. Possible values are True or False. ATTACHTIFTOREPORT is used in Fax Outbound and specifies if the send report sent to the user should contain a TIF file of the faxed document at the end of a successful job. Possible values with which the data field may then be populated are True and False. ATTACHERRORTIFTOREPORT is used in FAX outbound services and specifies if the send report sent to the user should contain a TIF file of the faxed document at the end of both a successful and a failed job. Possible values are True and False. REPLYSTATUSSORTING is used in Fax Outbound and specifies if the status report should be sorted by job status, listing all error or failed jobs at the top of the report. Possible values are True and False. ADDPLUSPREFIXTOFAXNO is used in Fax Outbound and specifies if the plus sign (“+”) should be prepended to the recipient fax number if it is missing and if the recipient number does not start with 0. Possible values are True and False. BLOCKNAME is used in Fax Inbound and is mandatory there. It specifies an identifying string for the fax number block or the entire fax number. The fax number (block) itself may be used here, but it is also possible to specify a descriptive name. The block name used here must be identical to the block name specified in the EAS portal to whose configuration this entry should be assigned. ADD_BLOCKNAME is available with Fax Inbound and allows to specify an additional BLOCKNAME that should be used for the user. This way, a user may have multiple fax inbound connections. USERNUMBER is used in Fax Inbound for informational purposes only. Here you can specify from what source fax number in your PBX the fax is routed or redirected to this specific Retarus fax number. It simplifies documentation. ADD_USERNUMBER is available for Fax Inbound and allows to specify an additional USERNUMBER that should be used with this user. This way, a user may have multiple fax inbound connections. EXTENSION is used in Fax Inbound and is used only if the fax number configured in this record is member of a number block. Then the extension to this number block is specified here. ADD_EXTENSION is available for Fax Inbound and allows to specify an additional EXTENSION that should be used with this user. This way, a user may have multiple fax inbound connections. DOCUMENTFORMAT is used in Fax Inbound and specifies in what file format the received fax should be forwarded to the recipient. Possible values are TIFF, TIFFG4, or PDF. ACTIVE is used in Fax Inbound and specifies if the number should be active or inactive. Possible values are True or False. COMMENT is used in Fax Inbound and allows for specifying additional information regarding this configuration record/fax number. SMSSOURCE is used in Email-to-SMS and specifies which part of the email should be used for sending the text, either only the body of the email, only the subject line of the email, or both. Possible values are BODY, SUBJECT, and BOTH. MAXPARTS is used in SMS Outbound and specifies how many SMS messages may be concatenated at max, in order to send long texts via SMS. Possible values are an integer ranging between 1 and 64. EMAILASPREFIX is used in Email-to-SMS and specifies if the sender’s email address should be used as the prefix of the SMS message. Possible values are True and False. The email address will only be added to the message if this does not result in a second SMS message due to length restrictions. So, this option will not result in additional SMS messages being sent involuntarily. REPLACEWITHSPACES is used in SMS Outbound and specifies if any characters that cannot be displayed in the defined character set should be replaced with spaces. Possible values are True and False. SENDASFLASH is used in SMS Outbound and specifies if the message should be sent as a FLASH SMS message. Possible values are True and False. REQUESTSTATUSREPORT is used in SMS Outbound and specifies if a status report should be requested from the mobile network regarding the successful transmission of the message to the recipient(s). Possible values are True and False. CLIENTNAME is used in Email-to-Fax and specifies the name of the client as specified in the EAS portal. This value must be identical to client names listed in the EAS portal for Email-to-Fax. It may also be empty; then the value of the client name specified in the EAS section DirSync will be used. TEMPLATENAME is used in Email-to-Fax and specifies which template should be used for rendering the cover page from the email’s body. DATEFORMAT is used in Email-to-Fax and specifies in what date format the date should be rendered on the cover page. Possible values are dd.MM.yyyy, dd/MM/yyyy, MM/dd/yyyy, yyyy-MM-dd. For more information, consult the Fax documentation. TIMEFORMAT is used in Email-to-Fax and specifies in what time format the date should be rendered on the cover page. Possible values are HH:mm:ss, HH.mm.ss, h:mm a. For more information, consult the Fax documentation. TIMEZONE is used in Email-to-Fax and specifies to what time zone the date on the cover page should be translated to. For a complete list of possible time zone values, see the EAS portal or check the Fax documentation. P13N is used in Email Security and Email-to-Fax and specifies that the field will contain personalization information that may i.e. be used for a personalized signature. For more information about how to configure personalization information, see P13N. UCFG is used in Email Security and specifies that the field will contain individual user configuration information for the mapped email address that may be used i.e. to specify a spam report template, spam report send times, or additional customized information. For more information about how to configure UCFG information, see UCFG.	PRIMARYADDRESS ALIASADDRESS PROFILE USERID BILLINGCODE CSID HEADER BUSYRETRIES ERRORRETRIES RESOLUTION BLACKLIST DEFAULTCOUNTRYCODE DEFAULTAREACODE REPLYTO REPLYCC ERRORTO LANGUAGE REPLYFORMAT ONLYATTACHMENTS ATTACHTIFTOREPORT ATTACHERRORTIFTOREPORT REPLYSTATUSSORTING ADDPLUSPREFIXTOFAXNO BLOCKNAME USERNUMBER EXTENSION DOCUMENTFORMAT ACTIVE COMMENT SMSSOURCE MAXPARTS EMAILASPREFIX REPLACEWITHSPACES SENDASFLASH REQUESTSTATUSREPORT CLIENTNAME TEMPLATENAME DATEFORMAT TIMEFORMAT TIMEZONE P13N UCFG ADD_CSID ADD_BLOCKNAME ADD_USERNUMBER ADD_EXTENSION
ContentType	Specifies what type of information the field mapped contains. FIELDCONTENT specifies that the content of the data received from the data source is regular field content. FIELDCONTENT_SMTP specifies that the content of the data received from the data source is to be interpreted as an SMTP email address. The data in this field therefore may consist of several email addresses. It is expected that every email address uses the string SMTP: as a prefix, ignoring if the text prefix SMTP: is in upper or lower case. FIELDCONTENT_SMTP_LC is identical to FIELDCONTENT_SMTP, differing only in the fact that the value(s) will only be accepted as email addresses if the prefix smtp: is in lower case. FIELDCONTENT_SMTP_UC is identical to FIELDCONTENT_SMTP, differing only in the fact that the value(s) will only be accepted as email addresses if the prefix SMTP: is in upper case. FIELDBUILDER specifies that the content of the data received from various fields will be transformed into some new “combined” information. For more information on how to use the FIELDBUILDER functionality, see FIELDBUILDER. FIELDCONTENT_PARAM_FM specifies that the first match from an array with one or more entries is overtaken. A corresponding search term in the Builder attribute of the same FieldMapping node specifies which entries are to be overtaken. Possible values in the Builder attribute for fax processes are FAX, csid:, or BLOCK:. In the corresponding Type node, you can use the values CSID, DEFAULTCOUNTRYCODE, DEFAULTAREACODE, BLOCKNAME, USERNUMBER, or EXTENSION. FIELDCONTENT_PARAM_LM specifies that the last match from an array with one or more entries is overtaken. A corresponding search term in the Builder attribute of the same FieldMapping node specifies which entries are to be overtaken. Possible values in the Builder attribute for fax processes are FAX:, csid:, or BLOCK:. In the corresponding Type node, you can use the values CSID, DEFAULTCOUNTRYCODE, DEFAULTAREACODE, BLOCKNAME, USERNUMBER, or EXTENSION.	FIELDCONTENT FIELDCONTENT_SMTP FIELDCONTENT_SMTP_LC FIELDCONTENT_SMTP_UC FIELDBUILDER
DataSourceField Name	Specifies the name of the data field in the source directory whose value should be used and mapped as defined here.	Type: String
Builder	Specifies the syntax according to which the field should be constructed. Requires the ContentType to be set to FieldBuilder. For more information on how to use the FIELDBUILDER functionality, see FIELDBUILDER.	Type: String
DefaultValue	Specifies the default value that should be used for this field in case the data source does not contain any value.	Type: String
FieldName	FieldName is for personalization purposes and therefore is used only if the Type is UCFG or P13N and specifies the name of the destination field to which the data should be mapped.	Type: String
ConversionName	Specifies the name of an additional conversion that should be applied to the value of the field.	Type: String	Conversion.Name
Separator	Specifies what separator is used to separate multiple values within the field in case the data source field contains multiple, separated values.	Type: Char
Delimiter	Specifies the delimiter to be used for the value. Possible values are DEFAULT (which equates to DOUBLEQOUTES) NODELIMITER SINGLEQUOTES ' DOUBLEQUOTES " CURLYBRACKETS{} SQUAREBRACKETS [] ANGLEBRACKETS <>	Type: String
EMailValidationLevel	Specifies how thoroughly the application verifies the validity of email addresses in case the Fieldmapping.Type is PRIMARYADDRESS or ALIASADDRESS. In case the DirSync has to process a large number of email addresses, this may have performance impacts. NONE results in no email address verification to be performed. QUICK results in the email address to be verified only for containing an @ symbol and a second level and a top level domain, separated by a period. STRICT results the email address to be verified typical criteria less tolerant than RFC822 and thus faster in validation speed performance. This is also the DEFAULT value. RFC822 performs a validation against all the complex variations possible according to RFC822, resulting in a comprehensive and thus more time consuming validation. CUSTOM allows you to specify your own REGEX validation. The REGEX pattern to be applied must be placed into a plain text file named EMailValidationRegex.txt located at the same location as the configuration XML file. If the FieldMapping.EMailValidation tag is not specified, the DEFAULT value will be applied which is STRICT.	NONE QUICK STRICT RFC822 CUSTOM DEFAULT

ConversionTables

The ConversionTables section specifies information on how to convert field data of a response to a LDAP search to a required value or format. Multiple child nodes of type ConversionTable are possible, offering the following attribute options:

Attribute	Description	Values	Cross reference (XML Node)
Name	The name of the conversion table set for which information is specified here. This will be used in the config to identify the converstion table which is to be applied.	Type: String	Mapping.Conversion Name
Description	A description that helps identify the credentials, their purpose, etc.	Type: String

Conversions

The Conversions section specifies information on how to convert the data of a specific field to a required value or format. Multiple child nodes of type Conversion are possible, offering the following attribute options:

Attribute

Description

Values

Cross reference
(XML Node)

Type

This specifes what sort of conversion should be applied by this config.

OFF specifies that the conversion is not actively used / no conversion is applied.
EXACT specifies that an exact, case-insensitive comparison of the compared strings is applied.
EXACTCASE specifies that an exact, case-sensitive comparison of the compared strings is applied.
ALL specifies that every instance of the defined search string is replaced by the specified target string. This replace mechanism is case-insensitive.
LOWER specifies that the string value is converted to lower case.
UPPER specifies that the string value is converted to upper case.
SETDEFAULT specifies that the default value is to be manipulated. There are two scenarios in which different manipulations can occur. If the option SETDEFAULT is set and no previous conversions were applied and the attribute From contains no value, then the Mapping’s DefaultValue is enforced regardless if the data field is empty or not.
If the option SETDEFAULT is set and conversions were previously applied in the current conversion and the attribute From is set to Left or Right, then the result of the previous conversion will be prepended or appended to the Mapping’s DefaultValue. If From is Left, it will be prepended. If From is Right, it will be appended.
CUT specifies that only the specified number of characters specified in the attribute To will be used for the field’s value. If the number specified is negative, the characters at the end of the string will be used, if the value is positive, the characters at the beginning of the string will be used.
REGEX will result in the specified REGEX being applied. The From attribute contains the pattern that must be matched. If only the From field is specified and the To field is empty, only a match will be performed, and the result of the REGEX will be returned. If the To field is specified, as well, the matched result will be replaced with the value specified in the To field.
REGEXREPLACE results in the match from the REGEX always to be replaced with the To value, i.e. if empty the result would be deleted.
CONVERSION specifies that another conversion should be applied to the current value, thus allowing for nested conversions. This next conversion in the sequence is specified in the From attribute.
SHRINK removes the specified characters from the source string, starting from the right of the source string. The characters that should be eliminated are specified in the From attribute, without any separator chars. The length to which the string should be reduced at max is specified in the To attribute.
INSERT creates a new string for the mapping by inserting into the string specified in the To attribute the value of the mapping’s data source field. The location where the datasource value is to be inserted into the To value is defined by the maker {CONTENT} in the source field. So, basically {CONTENT} in the To attribute is replaced by the data source value.

OFF
EXACT
EXACTCASE
ALL
LOWER
UPPER
SETDEFAULT
CUT
REGEX
CONVERSION
SHRINK
INSERT

Mapping.Conversion
Name

FilterTables

The FilterTables section specifies information on how to filter response data of a DirectoryRequest. This way it is possible to explicitly exclude information from the DirSync even though it was included in the response of the directory search. Multiple child nodes of type FilterTable are possible, offering the following attribute options:

Attribute	Description	Values	Cross reference (XML Node)
Name	The name of the filter table set for which information is specified here. This will be used in the config to identify the filter table which is to be applied.	Type: String	Mapping.Trailing FilterName
Description	A description that helps identify the credentials, their purpose, etc.	Type: String
DefaultPermission	Specifies if the record should by default be permitted or omitted (filtered) if none of the individual Filter rules return True.	ALLOW DENY

Filters

The Filters section specifies an explicit filter for data of a DirectoryRequest. If a condition matches, the corresponding value will be filtered, i.e. not be included in the data synched to Retarus. Multiple child nodes of type Filter are possible, offering the attribute options described below. If several Filter rules are specified and if more than one of these rules returns True, the first rule in the sequence will be applied:

Attribute	Description	Values	Cross reference (XML Node)
Permission	Specifies if the record should be permitted or omitted (filtered) if rule’s condition (Method) is met.	ALLOW DENY
Method	Specifies what sort of filtering method should be applied. If the filter matches the method and returns True, the filter will be applied (exclude the record from the result set). The comparisons if the condition is matched are case- sensitive. CONTAINS specifies that the filter should be applied if the comparison string specified in Pattern exists somewhere in the data field specified in DirectoryAttribute. STARTSWITH specifies that the filter should be applied if the value of the data field specified in DirectoryAttribute starts with the comparison string specified in Pattern. ENDSWITH specifies that the filter should be applied if the value of the data field specified in DirectoryAttribute ends with the comparison string specified in Pattern. REGEX specifies that the filter should be applied if the value of the data in the DirectoryAttribute field matches the REGEX condition specified the field Pattern.	CONTAINS STARTSWITH ENDSWITH REGEX
DirectoryAttribute	Specifies which field of the directory request should be used for the comparison/filtering.
Pattern	Specifies the string (or REGEX expression)

GroupTables

The GroupTables section specifies, based on LDAP syntax, if specific directory user groups (i.e. security groups), should be permitted in the result set or not. Multiple child nodes of type GroupTable are possible, offering the following attribute options:

Attribute	Description	Values	Cross reference (XML Node)
Name	The name of the GroupTable set for which information is specified here. This will be used in the config to identify the filter table which is to be applied.	Type: String	DirectoryRequest. GroupFilterName
Description	A description that helps identify the credentials, their purpose, etc.	Type: String
DefaultPermission	Specifies if the record should by default be permitted or omitted (filtered) if none of the individual Group rules apply.	ALLOW DENY

Groups

The Groups section specifies a filter for groups within a directory DirectoryRequest to explicitly include or exclude users that belong to such a group. Multiple child nodes of type Group are possible, offering the attribute options described below. If several Group rules are specified and if more than one of these rules returns True, the first rule in sequence will be applied:

Attribute	Description	Values	Cross reference (XML Node)
Permission	Specifies if the record should be permitted or omitted (filtered) if the search condition is matched.	ALLOW DENY
GroupDN	Specifies the LDAP name or canonical name of the group in question. If the user is a member of this group, the specified Permission action will be applied.	Type: String
RecursiveGroup Lookup	Specifies if users in nested groups should be searched recursively, i.e. if the user is a member of a group which in turn itself is a member of a group, and so on.	True False
FieldType	If set, the DirSync field specified here is actively overridden if the group condition is matched.	PROFILE BILLINGCODE CSID HEADER RESOLUTION BLACKLIST REPLYTO REPLYCC ERRORTO LANGUAGE ONLYATTACHMENTS CLIENTNAME TEMPLATENAME
FieldValue	Specifies the value that should be set for the FieldType.	Type: String

Intervals

The Intervals section specifies how often and at what points in time the synchronization should be performed. Multiple child nodes of type Interval are possible, offering the attribute options described below:

Attribute	Description	Values	Cross reference (XML Node)
Name	The name of the interval set for which information is specified here. This will be used in the config to identify the filter table which is to be applied.	ALLOW DENY	SyncConfig. IntervalName
Description	A description that helps identify the interval set, its purpose, etc.	Type: String
Type	Specifies the time unit at which the tasks associated with this interval should be executed. MINUTE specifies that the tasks should be executed every n minutes, where n is the value specified in field Value. HOUR specifies that the tasks should be executed every n hours, where n is the value specified in field Value. WEEKDAY specifies that the tasks should be executed every n weekdays (excluding weekends), where n is the value specified in field Value. DAY specifies that the tasks should be executed every n days including weekends, where n is the value specified in field Value.	MINUTE HOUR WEEKDAY DAY
Value	Specifies the repeat value for field Type.	Type: Int
InitialTime	Specifies the start time at which the job should be executed the first time. So, if the Type would be HOUR, the Value would be 2 and the InitialTime would be 08:00, then starting at 08:00 h, the task would be started every two hours.	Type: String

AdditionalOptions

The AdditionalOptions section specifies additional options, allowing for more granular control of the DirSync service and its behavior. Multiple child nodes of type AdditionalOptionSet are possible, offering the attribute options described below:

Attribute	Description	Values	Cross reference (XML Node)
Name	The name of the AdditionalOptionSet for which information is specified here. This will be used in the config to identify the filter table which is to be applied.	Type: String	Credential.Additonal OptionName
RedundancyCheck	Specifies if the system should only upload new or changed data to Retarus. If the data has not changed since the last successful upload, no new upload would be initiated. True specifies that the redundancy check should be performed. False specifies that no redundancy check should be performed.	True False
ForceUpload	Specifies that the upload should be performed even if the RedundanyCheck would prevent the data from being uploaded. It can be specified after how many suppressed attempts the upload should be enforced. The interval for this is specified with a single char D (days), H (hours), M (minutes), or C (count). It is preceded by the digit # that indicates the counter trigger for this interval. For example, 3D 5C would result in the upload being enforced every three days or every 5th upload attempt.	#D #H #M #C
DuplicateMail Addr essesAllowed	Specifies that the DirSync should ignore if identical mail addresses for a service are received from different directory sources. If set to false, only the first record containing a duplicate email address would be processed.	True False