Chat now with support
Chat with Support

Integration for Notes 20.12.01 - User Guide - BTCal

Section 1: Introduction Section 2: Features and Advantages Section 3: Scope Section 4: Recommended Installer Prerequisites Section 5: Pre-installation Requirements Section 6: Configure the Domino Environment Section 7: Configure Integration for Notes BTCal in Exchange or Office 365 Section 8: Licenses Section 9: Installing Integration for Notes Section 10: Create and Configure Domino Databases Section 11: Modify the Notes.ini File Section 12: Re-start BTCal Domino server to bring it online Section 13: Verification Section 14: On-going Administration Appendix A: ZApp Appendix B: Configure GRIP Appendix C: On the Fly Encryption and Decryption Appendix D: Disable Encrypted Message Routing Appendix E: High Availability/Redundancy Mail and Calendar Routing for Foreign Domains Appendix F: Notes.ini Parameter Descriptions Appendix G: Notes.ini Parameter Values Appendix H: Considerations for Domino SMTP Domain Exposure Appendix I: Processing Repeating Meetings Appendix J: Deployment Quick Reference Appendix K: Customizable Non Delivery Report (NDR) Reason Codes Appendix L: Cross Platform Delegation Appendix M: BT Stats Database

Domino Mail Routing to Exchange

BTEXCHANGEDOMAIN

Accepted Value: <domain name>

Default: Required

This parameter specifies the Foreign Domain associated with BTCal. It must match the Domain value in the Foreign Domain Document set up in Domino Directory. This parameter must be specified; if it is not found, BTCal will terminate.

Using the example above, NOTES.INI would be configured as follows:

BTEXCHANGEDOMAIN=Exchange


The value of this parameter should be similar to the value of the Notes Domain to enhance the transparency of transitioning users from Domino to Exchange.

 

BTALTEXCHANGEDOMAINS

Accepted Value: <comma-separated domain names>

Default: None

This parameter specifies additional (alternate) Foreign Domains associated with BTCal. This parameter is optional, and if specified, the value(s) must match the Domain value in the Foreign Domain Document(s) set up in Domino Directory.

Using the example above, NOTES.INI would be configured as follows:

BTALTEXCHANGEDOMAINs=Exchange-1


If the recipient address does not contain a domain specified by either BTEXCHANGEDOMAIN or BTALTEXCHANGEDOMAINS, then a Non-Delivery Report (NDR) is returned to the originator.

 

BTEXCHANGEDB

Accepted Value: <mailbox name>

Default: Required

This parameter specifies the Foreign Domain mailbox associated with BTCal. It must match the Gateway Mail File Name on the Mail Information tab and Calendar System on the Calendar Information tab in the Foreign Domain Document set up in Domino Directory. This parameter must be specified; if it is not found, BTCal will terminate.

The BTEXCHANGEDB database must be created on the Domino Coexistence Server using the Mail Router template. The Domino Server must have Manager Access to this database; it is recommended that the Default access be set as Manager.

Using the example above, NOTES.INI would be configured as follows:

BTEXCHANGEDB=otherexchange.box

BTRECIPCONVERTFIELD

Accepted Value: shortname/internetaddress-local/internetaddress-full

Default: shortname

This parameter defines which Domino Directory field is used for generating SMTP address for recipients of mail items from Domino to Exchange. Based on the value of the field, the SMTP address for each recipient is generated as follows:

Each Recipient value is matched against all Domino Directories defined by Directory Cascading or Directory Assistance. If a unique match is not found, an NDR is generated and sent to the originator.

If the value of the BTRECIPCONVERTFIELD parameter is shortname or the field is not present in NOTES.INI, the first value of the ShortName field of the matched Domino Directory Entry is used. If the value represents a valid SMTP address, then it will be used as the new recipient value; otherwise, the value will be appended with "@" + <BTEXCHANGESERVER> (see below).

If the value of the BTRECIPCONVERTFIELD parameter is internetaddress-local, the value of the InternetAddress field of the matched Domino Directory Entry is used. The string to the left of the “@” sign will be appended with "@" + <BTEXCHANGESERVER>.

If the value of the BTRECIPCONVERTFIELD parameter is internetaddress-full, the value of the InternetAddress field of the matched Domino Directory Entry is used as the new recipient value.

If the value of the field is internetaddress-full or internetaddress-local and InternetAddress is blank, it is treated as an invalid recipient address.

The BTRECIPCONVERTFIELD parameter setting applies to all mail items and is always used for Person objects unless one or more of the following parameters is set:

  • BTRECIPCONVERTFIELDMI – Mail-In Databases

  • BTRECIPCONVERTFIELDRR – Rooms and Resources

  • BTRECIPCONVERTFIELDGR - Groups


The internet address-full option must be used very carefully due to possible looping dangers. This option is only practical when the SMTP domain(s) of the Domino environment are different from that of the Exchange environment.

Domino does not apply a ShortName field to Mail-In Databases, Rooms/Resources or Groups by default. internetAddress-local should be used for these object types and must be unique in the target mail system for the Internet Domain used for forwarding unless the Domino Directory is customized to have a ShortName on these object types.

BTRECIPCONVERTFIELDMI

Accepted Value: shortname/internetaddress-local/internetaddress-full

Default: None, this option is not used unless it is set

This parameter defines which Domino Directory field is used for generating SMTP address for recipients of Mail-In Databases from Domino to Exchange. Based on the value of the field, the SMTP address for each recipient is generated as follows:

Each Recipient value is matched against all Domino Directories defined by Directory Cascading or Directory Assistance. If a unique match is not found, an NDR is generated and sent to the originator.

If the value of the BTRECIPCONVERTFIELDMI parameter is shortname or the field is not present in NOTES.INI, the first value of the ShortName field of the matched Domino Directory Entry is used. If the value represents a valid SMTP address, then it will be used as the new recipient value; otherwise, the value will be appended with "@" + <BTEXCHANGESERVER> (see below).

If the value of the BTRECIPCONVERTFIELDMI parameter is internetaddress-local, the value of the InternetAddress field of the matched Domino Directory Entry is used. The string to the left of the “@” sign will be appended with "@" + <BTEXCHANGESERVER>.

If the value of the BTRECIPCONVERTFIELDMI parameter is internetaddress-full, the value of the InternetAddress field of the matched Domino Directory Entry is used as the new recipient value.

If the value of the field is internetaddress-full or internetaddress-local and InternetAddress is blank, it is treated as an invalid recipient address.

The BTRECIPCONVERTFIELD parameter setting applies to Mail-In Databases if the BTRECIPCONVERTFIELDMI parameter is not set.


The internet address-full option must be used very carefully due to possible looping dangers. This option is only practical when the SMTP domain(s) of the Domino environment are different from that of the Exchange environment.

BTRECIPCONVERTFIELDRR

Accepted Value: shortname/internetaddress-local/internetaddress-full

Default: None, this option is not used unless it is set

This parameter defines which Domino Directory field is used for generating SMTP address for recipients of Rooms and Resources from Domino to Exchange. Based on the value of the field, the SMTP address for each recipient is generated as follows:

Each Recipient value is matched against all Domino Directories defined by Directory Cascading or Directory Assistance. If a unique match is not found, an NDR is generated and sent to the originator.

If the value of the BTRECIPCONVERTFIELDRR parameter is shortname or the field is not present in NOTES.INI, the first value of the ShortName field of the matched Domino Directory Entry is used. If the value represents a valid SMTP address, then it will be used as the new recipient value; otherwise, the value will be appended with "@" + <BTEXCHANGESERVER> (see below).

If the value of the BTRECIPCONVERTFIELDRR parameter is internetaddress-local, the value of the InternetAddress field of the matched Domino Directory Entry is used. The string to the left of the “@” sign will be appended with "@" + <BTEXCHANGESERVER>.

If the value of the BTRECIPCONVERTFIELDRR parameter is internetaddress-full, the value of the InternetAddress field of the matched Domino Directory Entry is used as the new recipient value.

If the value of the field is internetaddress-full or internetaddress-local and InternetAddress is blank, it is treated as an invalid recipient address.

The BTRECIPCONVERTFIELD parameter setting applies to Rooms and Resources if the BTRECIPCONVERTFIELDRR parameter is not set.


The internet address-full option must be used very carefully due to possible looping dangers. This option is only practical when the SMTP domain(s) of the Domino environment are different from that of the Exchange environment.

BTRECIPCONVERTFIELDGR

Accepted Value: shortname/internetaddress-local/internetaddress-full

Default: None, this option is not used unless it is set

This parameter defines which Domino Directory field is used for generating SMTP address for recipients of Groups from Domino to Exchange. This is only used if groups are not set to be expanded for the group membership forwarding to be used (e.g. BTEXPANDMAILGROUPS=N is set).

Based on the value of the field, the SMTP address for each recipient is generated as follows:

Each Recipient value is matched against all Domino Directories defined by Directory Cascading or Directory Assistance. If a unique match is not found, an NDR is generated and sent to the originator.

If the value of the BTRECIPCONVERTFIELDGR parameter is shortname or the field is not present in NOTES.INI, the first value of the ShortName field of the matched Domino Directory Entry is used. If the value represents a valid SMTP address, then it will be used as the new recipient value; otherwise, the value will be appended with "@" + <BTEXCHANGESERVER> (see below).

If the value of the BTRECIPCONVERTFIELDGR parameter is internetaddress-local, the value of the InternetAddress field of the matched Domino Directory Entry is used. The string to the left of the “@” sign will be appended with "@" + <BTEXCHANGESERVER>.

If the value of the BTRECIPCONVERTFIELDGR parameter is internetaddress-full, the value of the InternetAddress field of the matched Domino Directory Entry is used as the new recipient value.

If the value of the field is internetaddress-full or internetaddress-local and InternetAddress is blank, it is treated as an invalid recipient address.

The BTRECIPCONVERTFIELD parameter setting applies to Groups if the BTRECIPCONVERTFIELDGR parameter is not set.


The internet address-full option must be used very carefully due to possible looping dangers. This option is only practical when the SMTP domain(s) of the Domino environment are different from that of the Exchange environment.

Domino Security and Multi-Purpose Groups cannot have a ShortName applied as this will prevent Domino from performing ACL lookups. For these group types Interentaddress-local is recommended but must be unique in the target mail system for the Internet Domain used for forwarding.

BTEXCHANGESERVER

Accepted Value: <SMTP address>

Default: Required

This parameter specifies the value in the Foreign SMTP Domain document and Connection Document defined in the Domino Directory.


The first token in the route cannot match the Foreign Domain value defined above.

Using the example above, NOTES.INI would be configured as follows:

BTEXCHANGESERVER=exchange1.binarytree.com

BTPROCESSDOMAIN

Accepted Value: <SMTP address1, SMTP address2,……,SMTP address15>

Default: Required

OR

BTPROCESSDOMAIN1

Accepted Value: <SMTP address1, SMTP address2,……,SMTP address15>

BTPROCESSDOMAIN2

Accepted Value: <SMTP address1, SMTP address2,……,SMTP address15>

This parameter contains a list of SMTP domains representing true Internet addresses of Exchange users as well as direct SMTP routes from Exchange to Domino and from Domino to Exchange. This is the only parameter used by BTEx module to determine whether to translate the From:, To:, Cc:, or Bcc: values from SMTP to Notes format for e-mails from Exchange to Domino. It is important to ask the customer about all the domain names being used in their environment and ensure that those names are listed in this field. Issues with names not being properly converted from SMTP format are most likely due to a domain not being listed in this parameter.

  • BTPROCESSDOMAIN, without a trailing number, can be used for a single line of domains.

  • Only 15 domains are supported using this method

  • Each line in the NOTES.INI file is limited to 216 characters.

  • Multiple BTPROCESSDOMAINx lines can be defined (i.e. BTPROCESSDOMAIN1=… BTPROCESSDOMAIN2=…):

  • If more than 15 domains are required or;

  • If all 15 domains cannot fit on a single 216 character line.

  • The trailing numbers must be sequential.

  • Each line, except for the last, must end in a comma.

  • The * character can be used to start a domain (example: *.contoso.com)

BTDELAY

Accepted Value: <number>

Default: 60

This parameter specifies the interval in seconds for processing Domino to Exchange messages. The recommended value is 15. The value can be set higher than 30, but any value lower than 10 will be interpreted as 10.

BTORPHANDELAY

Accepted Value: <number>

Default: 300

This parameter specifies the interval in seconds for processing orphaned messages (i.e., Exchange to Domino messages marked dead by BTEx) but not processed immediately by BTCal (for a number of possible reasons). The recommended value is 120. If the provided value is less than 60, it will be reset to 60. When BTExchange notification is disabled, the BTORPHANDELAY parameter can be set to a minimum of 10 seconds.

BTCALRESTARTTIMER

Accepted Value: <number>

Default: 0 (no restart)

This parameter indicates that the BTCal server task should restart itself every <number> minutes. Task restart may be useful to ensure that all memory segments used by a task are properly released. Recommended values for the restart interval are between 60 and 720, representing a task restart between every hour and twice a day. There is no performance impact on BTCal due to a periodic restart.


For this Restart Timer to work correctly, the name of the file associated with BTCal must be nBTCal.exe. If you rename it to anything else, the Restart Timer will cycle every 5 seconds attempting to restart the task.

BTRETRYLIMIT

Accepted Value: <number>

Default: 10

This parameter is used when inbound and outbound mail items need to be processed. When processing inbound and outbound mail items, this parameter prevents a bad message from continuously crashing BTCAL or clogging the mail flow by specifying the maximum number of times BTCAL can process the same message.

BTRETRYSENDNDR

Accepted Value: 0/1

Default: 0

If BTCal has exceeded the retry limit while processing a specific mail item, this parameter specifies whether or not an NDR will be sent to the originator of the mail item. If the parameter is set to 1, an NDR is sent, and if it is set to 0, an NDR is not sent.

BTRETRYLIMITTEXTx

Accepted Value: <text>

Default: None

This parameter defines the text of the retry limit notification. There can be any number of lines of text; however, the lines must be sequentially numbered starting with 1 and the text of each line cannot exceed 216 characters. When the notice text is created, the contents of lines are scanned as a single string with no implied line ends. Line ends are defined by the string \n in the text of any line. The string “\t” defines a tab.


Because NOTES.INI parameters cannot have leading or trailing spaces, each BTRETRYLIMITTEXTx line must begin and end with a non-blank character.

For example:

  • BTRETRYLIMITTEXT1=Dear User\n\n\tYour message or calendar entry cannot be delivered to its intended recipient

  • BTRETRYLIMITTEXT 2=s.\n\nPlease contact your e-mail administrator for further assistance.

Translates as follows:

Dear User

Your message or calendar entry cannot be delivered to its intended recipients.

Please contact your e-mail administrator for further assistance.

BTBCCSKIPADDRESS

Accepted Value: <SMTP address>

Default: None

This parameter allows BTCal to coexist with an archiving solution – Ascentor – implemented using a similar approach and architecture in message processing as BTCal.

Ascentor marks every message with fields $Processed and $ProcessedID to indicate that it has already processed the message and adds a Bcc SMTP recipient to force a copy of a message to be directed to a specific mailbox via the SMTP address. Without this parameter, BTCal will stop processing an item if it encounters fields $Processed and $ProcessedID. With this parameter defined, BTCal will check if an item with fields $Processed and $ProcessedID has a Bcc recipient whose address matches the value specified in the configuration. If such a recipient is found, BTCal will continue processing the item assuming that it has the fields $Processed and $ProcessedID because of prior processing by Ascentor. If such a recipient is not found, BTCal will stop processing the item assuming that it has the fields $Processed and $ProcessedID because of prior processing by BTCal.

BTSUPPORTMULTIPLEDOMINODOMAINS

Accepted Value: 0/1

Default: 0

When processing a mail item from Domino to Exchange, BTCal typically removes the FromDomain field from the mail item. If there are multiple Domino Domains, this can cause problems processing replies from Exchange to Notes originally sent from downstream Domains. This parameter specifies whether BTCal should process the FromDomain field to avoid this issue. If BTSUPPORTMULTIPLEDOMINODOMAINS is set to 1, BTCal will examine the FromDomain and determine if the value contains "@" signs. If it does, the FromDomain value is replaced with the value to the left of the first @ sign. If it does not, the FromDomain field is left alone.

BTWORKDIRECTORY

Accepted Value: <Windows path name>

Default: Windows temp directory

This parameter defines the directory to which temporary work files used by BTCal will be written. It expects a properly formatted windows path name (e.g., c:\CMTc\work). If the specified directory does not exist, BTCal will attempt to create the directory. If this directory cannot be found or created, or if this parameter is not specified, work files will be written to the Windows temp directory.

BTTRUNCATESUBJECT

Accepted Value: Y/N

Default: N

The parameter accepts a value of Y and N. When set to Y, BTCal truncates the subjects of all messages sent from Notes to Exchange at 255 characters if the subject length is greater than 255 characters. There are times when Outlook will not correctly handle messages whose Subject is greater than 2K, so this parameter can be used to avoid these issues.

BTEXPANDCALGROUPS

Accepted Value: Y/N

Default: N

This parameter accepts a value of Y or N. If BTEPANDCALGROUPS is set to Y, the recipient list on inbound calendar mail items will be checked and expanded if it contains a Domino group name; otherwise, the group name will be passed in untouched.

If you have Domino group names that contain Exchange users, BTEXPANDCALGROUPS should be set to Y.  This will ensure that inbound calendar mail items are correctly processed by BTCal for any Exchange recipients.  If you do not have Domino groups, or your Domino groups do not contain any Exchange users, you should set this parameter to N.

BTEXPANDMAILGROUPS

Accepted Value: Y/N

Default: N

This parameter accepts a value of Y or N. If BTEXPANDMAILGROUPS is set to Y, the recipient list on inbound non-calendar mail items will be checked and expanded if it contains a Domino group name; otherwise, the group name will be passed in untouched.  There is no recommended setting for this parameter.

BTEXPANDGROUPS

Accepted Value: Y/N

Default: N

This parameter accepts a value of Y or N. If an Outlook user sends an invitation to a group defined in Domino that contains Exchange users, the group name must be expanded by BTCal for calendar processing to work correctly. If you are using Domino groups that contain Exchange users, you should set this parameter to Y; otherwise, this parameter will be ignored.


  • Integration for Notes now expands nested groups.

  • If there is an error in expanding groups (e.g., the expanded group would exceed 64K), an NDR is returned to the Outlook user.

  • There is a 64k limit on expanded Distribution Lists (nested groups) imposed by Domino.

  • BTEXPANDGROUPS has been deprecated in Release 3.1 and is superseded by the two new parameters: BTEXPANDCALGROUPS and BTEXPANDMAILGROUPS. The settings of these new parameters override the setting of BTEXPANDGROUPS if it is found in your NOTES.INI file.  We recommended that you delete BTEXPANDGROUPS from your NOTES.INI file if it was previously configured.

BTEXPANDGROUPSDOMAIN

Accepted Value: <string>

Default: None

There are times when the domain name defined for Domino groups in Exchange may be different from the domain name defined for associated groups in Domino. For example, the SMTP address in Exchange may be TestGroup@notes.dev.com, but the Internet address in the NAB could be TestGroup@notes.com. BTEXPANDGROUPSDOMAIN takes a string-value and is configured with the domain name that will be used for matching the groups. For example, set BTEXPANDGROUPSDOMAIN to notes.com in the above scenario.

BTCal will first try to find a match using TestGroup@notes.dev.com. If it is not found, and BTEXPANDGROUPSDOMAIN is defined, BTCal would replace the domain name and try to match it with TestGroup@notes.com and will succeed.


BTEXPANDGROUPSDOMAIN only supports one domain.

 

BTFORCELOCATIONRESOLUTION

Accepted Value: 0/1

Default: 0

When enabled (parameter set to 1), BTCal will look at each attendee in the Exchange ICAL stream and attempt to resolve it to a Domino room/resource. If the attendee is found to be a Domino room/resource, the display name will be added to the LOCATION value in the ICAL. This allows BTCAL and Domino to recognize the room/resource properly so that cancellations and updates are properly applied. This should be enabled for Exchange 2013 or higher. Exchange 2007 and 2010 handle this correctly already.

BTSENDEXPANDED

Accepted Value: Y/N

Default: Y

This parameter accepts a value of Y or N, and is only used if BTEXPANDCALGROUPS=Y. When set to Y, BTCal will send reschedule/cancellation notices to Exchange users after expanding the group. If the messages are sent, this will result in duplicate e-mails for Exchange users. If the messages are not sent, you run the risk of Exchange users not receiving reschedule/cancellation notices if they have not yet accepted the original invitation. Note that the original invitation is always sent to Exchange users, regardless of the setting of this parameter.


The setting of BTEXPANDMAILGROUPS has no effect on this parameter.

 

BTCHECKINTERNALSMTP

Accepted Value: 0/1

Default: 0

and

BTINTERNALSMTPDOMAIN

Accepted Value: <SMTP domain1,SMTP domain2>

Default: none

This parameter allows an O365 customer, who is gradually transitioning users from Domino to O365, to process all inbound external mail originating from O365, while letting other externally originated mail flow through untouched.

BTCHECKINTERNALSMTP accepts a value of 0/1, with the default being 0. To enable O365 compatibility, you should set BTCheckInternalSMTP=1.

BTInternalSMTPDomain accepts a comma separated list of SMTP domains, with no default. If O365 compatibility is enabled (i.e., BTCheckInternalSMTP=1), BTEx will compare the originator address of all inbound mail items against the list of configured internal SMTP domains. If a match is not found, the mail item is passed through unchanged. This also means that no address translation is done.

BTCONVERTPNG

Accepted Value: 0/1

Default: 0

BTCONVERTPNG accepts a value of 0/1, with the default being 0. When the parameter is set to 0, inline PNG images are not looked for and the BTPNG field is not set for BTCal if PNG images are found. When it is set to 1, PNG images are looked for and BTPNG field is set if images are found.

BTCONVERTPROPOSE

Accepted Value: 0/1

Default: 0

For on-prem installations only. Not for use for hybrid or O365 deployments.

The BTCONVERTPROPOSE parameter can be used to prevent the message, which is sent by a Notes user to propose a new time for a meeting that originated in Outlook, from always converting to a text message. The parameter allows BTCal to either convert the message to a text message or let it flow through as a counter proposal.

BTCONVERTPROPOSE accepts a value of 0/1, with the default being 0. When the parameter is set to 0, proposals for SINGLE meetings will be sent to Outlook as calendar counter proposals. When it is set to 1, proposals will be converted to text messages.


  • Proposals for entire series are ALWAYS converted to text messages, regardless of the setting of BTCONVERTPROPOSE. In addition, regardless of the setting of BTCONVERTPROPOSE, BTCal will insert text in the mail item that will be displayed by Outlook to the Outlook user. This text will specify the original date/time of the meeting, and the proposed date/time.

  • When an Outlook invitee declines a meeting request that originated in Notes and proposes a new date/time for the meeting, then message received by the Notes user comes as a counter proposal. If the Notes user declines it, the Notes message is changed to a Meeting Confirmation (NoticeType=N) and the subject is prefixed with Counter Proposal Declined and sent to the Outlook user.

  • Counter proposals from Notes users to O365 chairs are not supported.

BTOUTMESSAGEMAX

Accepted Value: 0/<any number greater than 0>

Default: 100

And

BTINMESSAGEMAX

Accepted Value: 0/<any number greater than 0>

Default: 100

BTOUTMESSAGEMAX and BTINMESSAGEMAX allow you to specify the maximum number of messages that you want BTCal to process in a mailbox before it switches to the next mailbox.

  • The BTOUTMESSAGEMAX parameter defines the maximum number of messages that should be processed from the mailboxes defined in BTEXCHANGEDB for Outbound SMTP traffic to Exchange.

  • The BTINMESSAGEMAX parameter defines the maximum number of messages that should be processed from the mail.boxes (mail1.box, mail2.box, etc.) for Inbound SMTP traffic to Notes/Domino.

The default for both parameters is 100, and when you specify zero (0) for either of the parameters, this indicates to BTCal that there is no maximum limit specified and it should process all of the messages in the mailbox before switching to another mailbox.

BTONLINEMEETINGLABEL

Accepted Value: <text>

Default: None

If an online meeting invitation is being sent from Notes to Outlook, and it contains an APPTUNIDURL, the BTOnlineMeetingLabel parameter can be configured to add the specified label and URL in front of the body of the notice.

It can be used as BTOnlineMeetingLabel1 and BTOnlineMeetingLabel2 and has a maximum size of 8K characters. 

BTNOTIFYONDELEGATEORCOUNTER

Accepted Value: 0/1

Default: 0

When enabled (parameter set to 1), BTCal will send the following NDR’s when the Prevent Delegation or the Prevent Counter-Proposals is enabled:

  • Prevent Delegation enabled - BTNDR43 =”This meeting has “Prevent delegating” enabled. This functionality is not supported for Outlook participants.”

  • Prevent Counter-Proposals enabled - BTNDR44=”This meeting has “Prevent counter-proposing” enabled. This functionality is not supported for Outlook participants.”

  • Prevent Delegation enabled and Prevent Counter-Proposals enabled - BTNDR45=”This meeting has “Prevent delegating” and “Prevent counter-proposing” enabled. This functionality is not supported for Outlook participants.”

  • Default text for the notify body - BTNDR46="Dear User,\r\n\r\nWhile this invitation will be delivered, it contains functionality not supported between Notes and Outlook:\r\n\r\n\t%REASON%\r\n\r\n***Your invitation information:\r\n\tSubject: %SUBJECT%\r\n\tLocation: %LOCATION%\r\n\tDate: %DATE%\r\n\r\nThe affected recipient(s):\r\n%RECIPIENTS%"

Please refer to Appendix K: Cross Platform Delegation to determine which option is appropriate for your environment and user community.

BTSUBJECTPREFIXMARKER

Accepted Value: markers separated by a comma.

Default: none (disabled by default)

When Notes sends meeting-related messages to Outlook, it prepends various strings to the meeting title, making the actual meeting title difficult to view on mobile device calendar views. This parameter allows for prepended text such as "Updated: " and "Rescheduled: " to be removed by looking for the pattern at the end of the prepended text (the marker). Removing the prepended text allows users to more easily see meeting titles on mobile device calendar views. When a meeting title with prepended text contains one of the markers from the list, all the text preceding the marker and the marker itself will be removed from the meeting title.

  • Use a trailing comma to avoid Notes stripping trailing spaces from the marker. For example, BTSubjectPrefixMarker=: , means BTCal will look for the string ": " in the meeting title.

  • Commas as part of a marker can be escaped with a backslash (\,).

  • Backslashes as part of a marker can be doubled (\\).

  • Characters with diacritics (é, ü, etc.) are supported, but NOTES.INI must be in UTF-8 format without a BOM. Notepad++ is the recommended tool for saving in this format. UTF-8 format that includes the BOM, or byte order mark cannot be read.

BTSUBJECTPREFIXEXCLUSION

Accepted Value: prefixes separated by a comma.

Default: none (disabled by default)

Note, this parameter modifies the behavior of BTSUBJECTPREFIXMARKER and is only valid if BTSUBJECTPREFIXMARKER is set.

This parameter allows certain prefixes to be retained in meeting titles for messages sent from Notes and received by Outlook. When a meeting title with prepended text starts with one of the prefixes from the list, the full meeting title is left intact.

  • Use a trailing comma to avoid Notes stripping trailing spaces from the marker. For example, BTSubjectPrefixExclusion=Résiliation: , means BTCal will look for the prefix "Résiliation: " in the meeting title.

  • Commas as part of a prefix can be escaped with a backslash (\,).

  • Backslashes as part of a prefix can be doubled (\\).

  • Characters with diacritics (é, ü, etc.) are supported, but NOTES.INI must be in UTF-8 format without a BOM. Notepad++ is the recommended tool for saving in this format. UTF-8 format that includes the BOM, or byte order mark cannot be read.

The BTSUBJECTPREFIXEXCLUSION parameter supports multiple lines. If the total list of prefixes is larger than 255 characters, it can be separated across multiple BTSUBJECTPREFIXEXCLUSIONx variables. Any number of sequentially numbered BTSUBJECTPREFIXEXCLUSIONx prefixes can be defined, starting with BTSUBJECTPREFIXEXCLUSION1.

The following example illustrates two alternatives of defining prefixes:

                BTSUBJECTPREFIXEXCLUSION=Cancelled: ,Cancelado: ,Résiliation: ,Suspender: ,

Or

                BTSUBJECTPREFIXEXCLUSION1=Cancelled: ,Cancelado: ,

                BTSUBJECTPREFIXEXCLUSION2=Résiliation: ,Suspender: ,

BTSUBJECTPREFIXFILTERING

Accepted Value: Y/N.

Default: N (disabled by default)

With filtering disabled (BTSUBJECTPREFIXFILTERING=N), all messages from Notes to Outlook are processed if BTSUBJECTPREFIXMARKER is set. With filtering on (BTSUBJECTPREFIXFILTERING=Y), only meeting notices from Notes to Outlook that are initiated by the chairperson or someone representing the chairperson are processed if BTSUBJECTPREFIXMARKER is set.

BTEXNOTIFYBTCAL

Accepted Value: Y/N.

Default: N (disabled by default)

To prevent the Domino server from crashing under load, BTExchange notification of BTCal can be disabled with the BTEXNOTIFYBTCAL parameter.

To disable BTExchange notification of BTCal, set BTEXNOTIFYBTCAL=N


When BTExchange notification is disabled, the BTORPHANDELAY parameter (the interval for processing orphaned messages) can now be set to a minimum of 10 seconds instead of the previous minimum of 60 seconds.

9.4    Handling Attachments between Domino and Exchange

Due to certain differences in processing MIME-encoded attachments by Domino and Exchange, the following Domino Server configuration variable is required:

MIMEFORCEATTACHMENTS=1

Although not specifically used by BTCal, this parameter must be set for the Domino Server to process outbound mail items with attachments properly.

BTINATTOPT

Accepted Value: 0/1

Default: 0

When Domino SMTP translates e-mails sent from Exchange to Domino into Notes documents, MIME-encoded attachments and embedded objects are represented by $FILE items. Due to certain limitations of Notes Clients prior to versions 6.x, some attachments are not properly displayed for the eventual recipients of e-mails. To ensure that $FILE items are properly displayed, BTCal detaches and re-attaches each $FILE object and, if necessary, performs additional processing of these items. This parameter specifies whether and what type of additional processing is performed by BTCal.

When BTINATTOPT is set to 0, BTCal performs no additional processing. This value should always be used for environments where all Notes Client versions are 6.x or higher.

When BTINATTOPT is set to 1, BTCal performs name-based and host-based processing of $FILE items. A value of 1 should only be used for environments where some Notes Client versions are 5.x or lower. Additional processing of $FILE item is performed according to the following rules:

If the HOST value of the original $FILE item is not STREAM (2304), the HOST value of the re-attached $FILE object will be left unchanged.

If the HOST value of the original $FILE item is STREAM and the File Name of the $FILE item matches a pattern defined by the BTINATTSKIPNAMES parameter, the HOST value of the re-attached $FILE object will be left unchanged.

If the HOST value of the original $FILE item is STREAM and the File Name of the $FILE item does not match a pattern defined by the BTINATTSKIPNAMES parameter, the HOST value of the re-attached $FILE object will be replaced with value of UNKNOWN. This results in $FILE element always being displayed as an attachment (even if the $FILE element represents an embedded image).

BTINATTSKIPNAMES

Accepted Value: <comma separated filename patterns>

Default: None

This parameter specifies a multi-valued field with values separated by commas that represent various file name patterns, against which File Name values of $FILE items may be compared (see rules defined above). The following syntax rules should be used when constructing values for this parameter:

(asterisk) represents string of any length or value.

# (number sign) represents a single digit.

*<string> matches a file name of any length ending in <string> (case and extension insensitive). For example, file name test document.doc matches value *document.

<string>* matches a file name of any length starting with <string> (case and extension insensitive). For example, file name test document.doc matches value test*.

<string>### matches a file name starting with <string> followed by 3 digits (case and extension insensitive). For example, file name image123.bmp matches value image###; however, file names image1x3.bmp or image12.jpg do not match value image###.

 

The recommended value is image###, since embedded images in Outlook are given “virtual file names of imageNNN.<extension>. For example, image001.bmp, image002.jpg, image003.tif.

BTBLOCKCANCELNOCACHE

Accepted Value: Y/N

Default: Y

This parameter determines what happens when a meeting chaired in Notes and sent to an Outlook user is cancelled and there is no cache document which results in no NDR and no cancellation notice by default. If the BTBlockCancelNoCache parameter is set to "Y", "Cancel Single Occurrence" will not be delivered. If the BTBlockCancelNoCache parameter is set to "N", the cancel will be delivered. "Cancel All Occurrences" is needed for the chair to cancel and recreate the meeting and will be delivered regardless of the BTBlockCancelNoCache parameter setting.

BTPRESERVEATTACHMENTS

Accepted Value: 0/1

Default: 1

This parameter preserves the attachments added during an update of a Notes repeating meeting sent to Outlook attendees. When enabled (parameter set to 1), BTCal will not remove the attachments added during an update to a repeating meeting in Notes and sent to Outlook attendees. This parameter resolved a defect that was incorrectly removing attachments during meeting updates, and should always be enabled. It is Binary Tree's practice to use ini parameters to correct this type of issue to protect the previous behavior in the event an existing deployment is dependant on it.

Processing Meetings between Exchange and Domino

BTKEEPPOSTED

Accepted Value: Y/N

Default: Y

If BTKEEPPOSTED is set to Y or if it is not present in the NOTES.INI file, BTCal inserts the KeepPosted text field in the meeting response. If the KeepPosted text field is present in the decline response you sent to a meeting, and the meeting is updated, Domino will send you the update even though you declined the original invitation. This may be useful in the case where an Exchange user could not attend the meeting at its originally scheduled time but can attend at the rescheduled time. Also, if the meeting is canceled, the cancellation notice is sent to the Exchange user if KeepPosted is set.

If BTKEEPPOSTED=N, this text field is not added to the meeting response.

BTCHECKRECIPIENTS

Accepted Value: Y/N

Default: N

If BTCHECKRECIPIENTS is set to Y, BTCal searches the recipient list of all inbound calendar mail items for any Exchange users. If Exchange users are found, the original mail item is copied to a new mail item. The Exchange users are copied to the new mail item and then removed from the original mail item.

If BTCHECKRECIPIENTS = N, the recipient list is not searched for Exchange recipients.


This process can be time consuming, depending on the size of the recipient list. Therefore, this parameter should only be enabled if BTCal is receiving inbound mail items that contain Exchange addresses. 

BTINBOUNDLOOKUPFIELDS

The BTINBOUNDLOOKUPFIELDS parameter can be added to the Notes.ini file to define field names that, if the fields exist in the Domino NAB and contain a value, will have the field values added to the Notes memo or calendar invitation during an Outlook to Notes transaction.

    BTINBOUNDLOOKUPFIELDS=FieldName1, FieldName2

9.6    Processing Repeating Meetings between Exchange and Domino

Due to significant differences in handling repeating/recurring meetings from invitations to reschedules and updates and to cancellations by Exchange and Domino, BTCal examines such items and determines whether the opposite environment can properly handle them. If a scheduling or a rescheduling action is improperly handled, an appropriate notification is issued based on parameter values defined further in the document.

For the detailed documentation on handling various types and functions of repeating/recurring meetings by BTCal, please refer to Appendix F.

BTCACHEDB

Accepted Value: <database name>

Default: btcache.nsf

This parameter defines the database that will be used to store data required for proper processing of repeating/recurring meetings by BTCal. The database must be stored in the Domino Coexistence Server Data Directory and built from the default database received as part of the Integration for Notes Installation package.

BTRECURRENCELIMIT

Accepted Value: <number>

Default: 1200

With the limit being around 1200, there is an issue with the actual number of recurrence dates that Notes will accept. To avoid issues in Notes after a calendar invitation from Exchange is delivered to Domino, BTRECURRENCELIMIT should be used to specify the maximum number of recurrence dates that should process be processed. If this number is exceeded, an NDR is sent to the originator.

BTMULTISCHEDREPORTLEVEL

Accepted Value: 1/2/4

Default: 1

This parameter determines whether the notice of an inappropriate action is sent by BTCal.

1 – an error report is sent back just to the originator of the meeting

2 – an error report is sent back to the originator and specified administrator address,

which can be a group

4 – checking the validity of invitations or reschedules is disabled. (not recommended)

BTMULTISCHEDREPORTADDRESS

Accepted Value: <SMTP address>

Default: None

This parameter defines the value of an additional address to which notification of an inappropriate recurring meeting action is sent. The SMTP address user1@clientdomain.com is an example of the value that can be assigned to the parameter. This address can also be a group.


This parameter is only needed if BTMULTISCHEDREPORTLEVEL is set to 2.

 

BTMULTISCHEDREPORTADDRESSTYPE

Accepted Value: 0/1/2

Default: 0

This parameter allows the user to specify whether the configured BTMULTISCHEDREPORTADDRESS should be placed in the To, CC, or BCC field when sending a mail notification. Acceptable values are 0 (To), 1 (CC) and 2 (BCC), with the default being 0. If the parameter is not included in the NOTES.INI file or contains an unacceptable value then the address will appear in the To field as that is the default behavior.

BTMULTISCHEDREPORTTEXTx

Accepted Value: <text>

Default: Dear User,

The calendar pattern used in the invitation you sent is not supported at this time for the following reason:

%REASON%

Please reschedule using another pattern!

Original invitation information:

Subject: %SUBJECT%

Date: %DATE%

Integration for Notes allows the user to customize the NDR returned for invalid calendar items. The BTMULTISCHEDREPORTTEXTx parameter defines the text of the notice of the inappropriate action. Customization is based on the text configured for this parameter. There can be any number of lines of text; however, the lines must be sequentially numbered starting with 1 and the text of each line cannot exceed 216 characters. When the notice text is created, the contents of the lines are scanned as a single string with no implied line ends. Line ends are defined by the string “\n” in the text of any line. The string “\t” defines a tab.


Because NOTES.INI parameters cannot have leading or trailing spaces, each BTMULTISCHEDREPORTTEXTx line must begin and end with a non-blank character.

For example, you can specify the BTMULTISCHEDREPORTTEXTx parameter as follows to create a customized message for the NDR when a calendar pattern is rejected.

BTMULTISCHEDREPORTTEXT1=Dear User\n\nThe calendar pattern used in invitation you sent is not supported at this time\n

BTMULTISCHEDREPORTTEXT2=for the following reason:\n%REASON%\n

BTMULTISCHEDREPORTTEXT3=Please reschedule using another pattern!\n\n

BTMULTISCHEDREPORTTEXT4=***Your invitation information:\n

BTMULTISCHEDREPORTTEXT5=Subject: %SUBJECT%\n

BTMULTISCHEDREPORTTEXT6=Location: %LOCATION%\n

BTMULTISCHEDREPORTTEXT7=Time: %DATE%\n

BTMULTISCHEDREPORTTEXT8=Chair: %CHAIRPERSON%\n

BTMULTISCHEDREPORTTEXT9=The invitation was not sent to the following user(s):\n%RECIPIENTS%

It will translate as:

The calendar pattern used in invitation you sent is not supported at this time for the following reason:

<Reason>

Please reschedule using another pattern!

 

***Your invitation information:

Subject: <SUBJECT>

Location: <LOCATION>

Time: <DATE>

Chair: <CHAIRPERSON>

The invitation was not sent to the following user(s):<RECIPIENTS>

There are six keywords that can be placed anywhere in the configured text to supply additional information specific to the non-delivery report. Note that the keywords are not case-sensitive, but they MUST be enclosed in percent signs.

  1. %REASON% - Displays a textual reason why Integration for Notes is rejecting the calendar event and returning a non-delivery notification. See Appendix G for a complete list of the reasons for a failure as well as the cause of the failure.

  2. %DATE% - Displays the start date of the meeting notice in the long form, such as Monday, March 8, 2010.

  3. %SUBJECT% - Subject specified in calendar event.

  4. %LOCATION% - Location specified in the calendar event.

  5. %CHAIRPERSON% - Chairperson specified in the calendar event.

  6. %RECIPIENTS% - Comma-separated list of foreign recipients of the calendar event. For messages originating in Outlook, this keyword would refer to Notes users. For messages originating in Notes, this keyword would refer to Outlook users.


The rejection notices for unsupported meeting patterns originating in Notes display the Chairperson and Foreign Recipient addresses in full canonical format.

If the BTMULTISCHEDREPORTTEXTx parameter is not set in the NOTES.INI file, then the default message that appears when a calendar pattern is rejected is:

Dear User,

The calendar pattern used in the invitation you sent is not supported at this time for the following reason:

%REASON%

Please reschedule using another pattern!

Original invitation information:

Subject: %SUBJECT%

Date: %DATE%

BTNDRFROMADDRESS

Accepted Value: <email address> or <common name>

Default: None

When an email address is provided for this parameter, the From field of all NDR’s will be set to the email address. This parameter will accept an SMTP name or a common name. If there is no value, the NDR will appear to come from the recipient.

BTNONDRONQUIT

Accepted Value: 0/1

Default: 0

This parameter specifies whether or not BTCal will send an NDR if it is in the middle of processing a mail item when the QUIT command is issued from the console. If BTNONDRONQUIT is set to 0, an NDR will not be sent; otherwise, an NDR will be generated and sent to the originator.

BTPARTIALTEXT

Accepted Value: <text>

Default: Room/Resource is not available for all the dates of the requested meeting and has declined the entire series. You must use another time or find another resource. Date(s) that the room/resource were not available at the requested time are the following:

When an Exchange user attempts to schedule a recurring meeting with a Notes Room/Resource and the Room/Resource is not available for one, multiple, or all instances of the meeting, a complete Decline is generated. This parameter allows you to customize the notification text for the Decline message. For example:

BTPartialText1=Room/Resource is not available.

BTPartialText2=You must use another time or find another resource.

There is a maximum of 1024 characters for this parameter.

BTBLOCKUPDATENOCACHE

Accepted Value: Y/N

Default: N

The default behavior of BTCal is to assume all calendar updates coming from an Exchange chair to a Domino participant where there is no information of the meeting in the BTCache database are valid and are delivered to the Domino participant. This includes reschedules, updates, and adding a Domino participant. When this parameter is set to Y (Yes), BTCal is blocks any calendar update coming from an Exchange chair to a Domino participant where there is no information of the meeting in the BTCache database.

Updates (Exchange to Domino)

When a calendar update arrives from Exchange, BTCal first looks for the UID in the cache database. If the UID does not exist:

  • If BTBlockUpdateNoCache = N

    The document is processed by BTCal and passed through to Domino. It will not be blocked based on the missing cache document.

  • If BTBlockUpdateNoCache = Y

    We determine if it is a repeating meeting by looking in the iCal stream for either an RRULE: or a RECURRENCE-ID:

    If the SEQUENCE: is 0, the document is processed by BTCal and passed through to Domino. It will not be blocked based on the missing cache document.

    If the SEQUENCE: is greater than 0 but the iCal stream contains neither an RRULE: or a RECURRENCE-ID: it is a single occurrence meeting update and passed through to Domino. It will not be blocked based on the missing cache document.

    If the SEQUENCE: is greater than 0 and the iCal stream contains either an RRULE: or a RECURRENCE-ID: it is a recurring meeting update and will be stopped by BTCal. It will be blocked based on the missing cache document. This can be either an update to a single occurrence, all occurrences, or an add user.

Cancels (Domino to Exchange)

When a calendar cancel arrives from Exchange, BTCal first looks for the UID in the cache database. If the UID does not exist:

  • "Cancel All Occurrences" will be delivered regardless of the BTBlockCancelNoCache INI setting. Without this, the chair cannot cancel and recreate the meeting.

  • "Cancel Single Occurrence" will not be delivered by default. If the INI parameter BTBlockCancelNoCache is set to "N", the cancel will be delivered.

BTRESOLVENDRRECIPIENTS

Accepted Value: Y/N

Default: N

When enabled (parameter set to Y), the recipients list in a calendar NDR is resolved from the Exchange-based SMTP addresses into a Notes name. For example, john.smith@domino.contoso.com becomes John Smith/Contoso.

BTRESOLVENDRRECIPIENTSDOMAIN

Accepted Value: <string>

Default: None

This parameter allows you to specify the SMTP domain to search if the first search fails. When BTResolveNDRRecipientsDomain=localpart, the local part of the address is used to perform lookups. If the local part is not unique across all address books, the first matching entry found will be used. When local part is used for name resolution, no secondary domain lookups are supported. If possible, the incoming SMTP address is converted to the abbreviated Notes name.

BTADDUSERDWASUPPORT

Accepted Value: Y/N

This parameter accepts a value of Y or N. It specifies whether BTCal supports the ability for a user to add an Outlook user to an existing repeating meeting via Domino Web Access (DWA). If this parameter is set to N (or not present in the NOTES.INI file), and a request to add a user comes in, an NDR is returned.

BTEXCHANGEROUTER

Accepted Value: <String>

Default: BTExchange.box

BTEXCHANGEROUTER is normally set to BTExchange.box, which is the database that the Foreign Domain database points to

BTPRIVATEHANDLEQP

Accepted Value: Y/N

Default: N

The parameter accepts a value of Y or N. It specifies whether BTCal should validate quote-printable text in URL’s contained in message bodies. If enabled BTCal will not block messages with iCal streams that contain the text “=3d”.

BTPRIVATEADDMISSINGROOMATTENDEE

Accepted Value: Y/N

Default: N

The parameter accepts a value of Y or N. It specifies whether BTCal should validate the attendee list on meetings from Exchange to Domino to check for Rooms that are included in the meeting. When enabled this will add the room to the ATTENDEE line if it is missing and add CUTYPE=ROOM.

Zero-Touch Application Remediation (ZApp)

ZApp is an optional (separately purchased) feature of BTCal designed to perform on-the-fly transformation of mail items sent from Domino to Exchange, which contain elements that can only be processed by a Notes Client. Such elements include Custom e-Mail Forms, Hot Spot Button, Action Pop-up, and Mouse-over Action. When these items are encountered, they require remediation. To ensure that the Notes-specific elements of these mail items are not lost in transmission from Domino to Exchange, a remediated mail item that contains custom text (defined by the BTSTORETEXT parameter) is sent to the Exchange user. The original mail item is stored in a Domino database on the Domino Coexistence Server (referred to as BTStore) and/or in a Domino database attached to the remediated message.  If the original mail item is stored on the Coexistence Server, when the Exchange user receives the resulting mail item in Outlook or Outlook Web Access, the user can click on the link and access the original Notes mail item in BTStore. If the original mail item is stored in a database attached to the remediated mail item, the Exchange user can open the attached database.  In either case, it is assumed the Exchange user's workstation has the Notes Client and the original Notes ID File.

Since the mail item transformation requires no action beyond original configuration, the process is referred to as Zero Touch Application Remediation. ZApp actions are defined by the following parameters:

BTZAPPSUPPORT

Accepted Value: 0/1

Default: 0

This parameter defines whether ZApp functionality is enabled and which Domino database should be used to store the original mail item.

  • If BTZAPPSUPPORT is set to 0, ZApp is disabled and all subsequent ZApp parameters are ignored.

  • If BTZAPPSUPPORT is set to 1, the original mail item is stored in a Domino database on the Domino Coexistence Server (defined by the BTSTOREDB parameter). If the Domino database cannot be found, BTCal will terminate.

  • If BTZAPPSUPPORT is set to 2, the original mail item is stored in a Domino database that is attached to the remediated mail item. The Domino database is created based on the Domino template defined by the BTZAPPTEMPLATE parameter.  If the Domino template cannot be found, BTCal will terminate.

  • If BTZAPPSUPPORT is set to 3, the original mail item is stored in the BTSTOREDB on the Domino Coexistence Server as well as in a Domino database that is attached to the remediated mail item. If either the BTSTOREDB database or the BTZAPPTEMPLATE cannot be found, BTCal will terminate.

BTZAPPTEMPLATE

Accepted Value: <database name>

Default: Required if BTZAPPSUPPORT=2 or BTZAPPSUPPORT=3

This parameter defines the Domino Database template used to create the ZApp Database that is attached to the remediation messages if BTZAPPSUPPORT is set to 2 or 3. If BTZAPPSUPPORT is set to 2 or 3, and this parameter is not specified, BTCal will terminate. If BTZAPPSUPPORT is set to 2 or 3 and this BTCal cannot open the configured template, BTCal will terminate.

This template should be created by the Administrator and Binary Tree recommends using a standard mail template.


When the mail item is received in Outlook, if the Exchange user is running Exchange 2010, the user must set the message to Edit mode by clicking Actions -> Edit message before attempting to open the attached ZApp Database.

BTZAPPDB

Accepted Value: <database name>

Default: BTZAPP.NSF

This parameter defines the name of the Domino Database that is attached to the remediation message if BTZAPPSUPPORT is set to 2 or 3.


When the %DATETIME% keyword is included in the INI parameter BTZAPPDB, the keyword is replaced with the date and time on the CMTc server in the following format: dd-mm-yyyy_hh-mm. For example, if the parameter is BTZAPPDB=%DATETIME%_EncryptedContent.nsf, the database would receive a name like 13-02-2014_12-12_EncryptedContent.nsf.

BTSTOREDB

Accepted Value: <database template name>

Default: BTSTORE.NSF

This parameter defines the ZApp BTStore Domino database. The database must be stored in the Domino Coexistence Server data directory and is built from the btstore*.ntf Template received as part of the Integration for Notes Installation package. The database can be treated as any other standard Domino database, including creation of replicas, agents to manage document aging, reporting, and other activities.

BTZAPPUNIQUECOPY

Accepted Value: N/Y

Default: Y

This parameter defines how the original mail item that contains the ZApp-able items will be handled.

  • If BTZAPPUNIQUECOPY is set to Y, a separate document is stored in the BTStore database for each recipient (if BTZAPPSUPPORT is 1 or 3) and a separate ZApp database is created and sent to each recipient (if BTZAPPSUPPORT is 2 or 3).

  • If BTZAPPUNIQUECOPY is set to N, one document is stored in the BTStore database for all recipients (if BTZAPPSUPPORT is 1 or 3) and the same ZApp Database is sent to all recipients (if BTZAPPSUPPORT is 2 or 3).

This parameter can be used to control the size of the BTStore database effectively. Setting BTZAPPUNIQUECOPY to N significantly reduces the database; however, users can inadvertently delete common documents in the BTStore database. To avoid this, BT recommends that the ACL of the BTStore database be set up to prevent users from deleting documents. Additionally, if any documents in the BTStore database contain buttons that update fields to prevent multiple executions, their functionality can be adversely affected by this setting. Size versus functionality considerations should be carefully considered when implementing this feature.


If only one copy of the documents is stored in the BTStore database, and the same ZApp Database is sent to all recipients, then all recipients will have access to the same document. Therefore, if the original mail item contained BCC addresses, these addresses will be present for all recipients to view.

BTZAPPCHECKENCRYPT

Accepted Value: 0/1/2

Default: 1

This parameter defines whether encrypted e-mails sent from Domino to Exchange will be remediated by BTCal.

If BTZAPPCHECKENCRYPT is set to 0, for all encrypted items (e-mail or calendar entries), the user receives a message (not the calendar entry) with a notice in the body that contents are missing due to being encrypted.

If BTZAPPCHECKENCRYPT is set to 1 and the e-mail is encrypted, it will be treated as an e-mail containing Notes-specific items and will be saved in the BTStore.nsf database and a custom e-mail with a link to the saved document will be sent to the target user. If the encrypted item is a calendar entry, it is ZApped and the message is sent along with the link to the original entry, which cannot be acted upon.

If BTZAPPCHECKENCRYPT is set to 2, and the encrypted item is a calendar entry, the unremediated calendar notice is stored in the Btstore.nsf database, a message (similar to BTZAPPCHECKENCRYPT=1) is delivered to the Outlook user, and a calendar notification is delivered to the Outlook user. 


Messages are processed by the On the Fly Decryption and Encryption feature before being processed by the ZApp feature. See Appendix J for more information about the On the Fly Decryption and Encryption feature.

BTZAPPCOMBINEENCRYPTEDCALENDAR

Accepted Value: 0/1

Default: 1

This parameter defines whether the ZApp notice is placed in the body of the meeting notice.

If BTZAPPCOMBINEENCRYPTEDCALENDAR is set to 0 the ZApp notice is not placed in the bocy of the meeting.

If BTZAPPCOMBINEENCRYPTEDCALENDAR is set to 1 the ZApp notice is placed in the body of the meeting notice. The standard ZApp text is used in place of the encrypted text.

BTZAPPENCRYPTTEXT

Accepted Value: <text>

Default: Contents of this document are encrypted with a Notes certificate and cannot be read.

This parameter provides the message text for calendar notices. This parameter can be specified as just BTZAPPENCRYPTTEXT or as a multi-line value (BTZAPPENCRYPTTEXT1, BTZAPPENCRYPTTEXT2).

The maximum number of characters that can be specified in the parameter is 255. If BTZAPPENCRYPTTEXT is not configured, then the following default text is used:

Contents of this document are encrypted with a Notes certificate and cannot be read.

BTZAPPBYPASS

Accepted Value: 0/1

Default: 0

This parameter defines whether the presence of a $BTZAppBypass field in an e-mail will cause BTCal to not examine the e-mail for the purposes of remediation regardless of its contents. Encrypted e-mails sent from Domino to Exchange will be remediated by BTCal. If BTZAPPBYPASS is set to 1 and the e-mail contains a field $BTZAppBypass that equals to 1, the e-mail will be ignored by the remediation process; otherwise, the presence of a $BTZAppBypass field will not be checked.

BTZAPPBYPASSDOCSWITHFIELDS

Accepted Value: <comma separated list of field names>

Default: None

This parameter defines a list of fields, the presence of which in any mail item will force document remediation to be skipped. This is a multi-valued case-insensitive parameter.

BTZAPPIGNORESTOREDFORMS

Accepted Value: 0/1

Default: 0

This parameter defines whether the presence of a stored form in a mail item will force or skip remediation regardless of its contents. If (mail item’s Form is blank or no form is present) and (mail item has fields $Body_StoredForm or $Fields_StoredForm or $TITLE_StoredForm or $Info_StoredForm) it is considered to have a stored form.

  • BTZAPPIGNORESTOREDFORMS=1 will cause remediation to be skipped while,

  • BTZAPPIGNORESTOREDFORMS=0 will cause remediation to be performed

BTZAPPINCLUDEFULLDISTRIBUTION

Accepted Value: 0/1

Default: 0

This parameter defines whether to maintain the email’s original SendTo, CopyTo, and BlindCopyTo values. If the original SendTo, CopyTo, and BlindCopyTo values are maintained, Outlook recipients of Zapped items will only see other Outlook recipients in the TO and CC fields, not the Notes recipients.

If BTZAPPINCLUDEFULLDISTRIBUTION is set to 0 the email’s original SendTo, CopyTo, and BlindCopyTo values will not be maintained.

If BTZAPPINCLUDEFULLDISTRIBUTION is set to 1 the BTCal will maintain the email’s original SendTo, CopyTo, and BlindCopyTo values.

BTZAPPPROCESSFORMS

Accepted Value: <comma separated list of form names>

Default: None

This parameter defines a list of non-standard mail item forms whose remediation will be performed. This is a multi-valued case-insensitive parameter.

A value of “None” represents the condition of the form being blank or absent from the document. The following values for this parameter are invalid and will be ignored:

  • Memo

  • Reply

  • Reply with history

BTZAPPIGNOREFORMS

Accepted Value: allnonstandard/<comma separated list of form names>

Default: None

This parameter defines a list of non-standard mail item forms whose remediation will be skipped. This is a multi-valued case-insensitive parameter.

A value of “none” represents the condition of the form being blank or absent from the document. If the first value of this parameter is set to is "allnonstandard", all other values are ignored and forms except for “memo”, “reply”, “reply with history”, “appointment”, “notice”, “task”, “delivery report”, “nondelivery report”, “return receipt”, “trace report”, “phone message” will cause BTCal to skip remediation.

BTZAPPIGNOREALLFORMS

Accepted Value: 0/1

Default: 0

This parameter specifies whether remediation will be skipped for a mail item that contains a non-standard form.

If a value of 1 is specified for this parameter, all forms except for “memo”, “reply”, “reply with history”, “appointment”, “notice”, “task”, “delivery report”, “nondelivery report”, “return receipt”, “trace report”, “phone message” will cause BTCal to skip remediation. Specifying BTZAPPIGNOREALLFORMS=1 has the same effect as specifying BTZAPPIGNOREFORMS=allnonstandard.

BTZAPPORGS/BTZAPPORGSx

Accepted Value: <comma separated list of org units>

Default: None

This parameter defines a multi-valued list of legacy Domino Organizations used for determination of document security in the BTStore Database. For each recipient of a remediated document, a corresponding entry in the Domino Directory is located and each value of the full name is examined to locate the value that matches user’s name in Notes ID file. Each hierarchical entry will be compared against the list of organizations specified by this parameter and the first hierarchical value matching one of the values in the list will be used for securing the copy of the mail item in the BTStore Database using a Readers field called $BTReaders.


If no full name value contains an organization matching one of the values in the list, the document will be unsecured when placed into the BTStore Database.

If the total list of organizations is larger than 240 characters, it can be separated across multiple BTZAPPORGSx variables. Any number of sequentially numbered BTZAPPORGSx variables can be defined, starting with BTZAPPORGS1.

The following example illustrates 2 alternatives of defining valid Domino Organizations:

  • BTZAPPORGS=BinaryTree,BinTree,BT,BTree

Or

  • BTZAPPORGS1=BinaryTree,BinTree,

  • BTZAPPORGS2=BT,BTree

 


  • In the second alternative, every BTZAPPORGSx line, except for the last one, must end with a comma.

  • If BTZAPPORGS and BTZAPPORGS1 – BTZAPPORGSn approaches are used, the BTZAPPORGS value will be ignored.

  • Country code cannot be listed with organization; for example, “contoso/fr” (organization/country code) will not work. Use “contoso” (organization name) only.

BTZAPPREADERS

Accepted Value: <Domino address>

Default: None

This parameter defines an additional value for the $BTReaders field described in the BTZAPPORGS section. Usually, this value represents a group containing the LocalDomainServers group and other administrative group(s).

BTZAPPRENDERSTOREDFORMS

Accepted Value: 0/1

Default: 0

This parameter specifies whether BTCal will process a memo containing a stored form. If BTZAPPRENDERSTOREDFORMS is set to 0, the stored form will be ignored and only the remediation notice will be sent; otherwise, the stored form will be processed by BTCal.

This parameter can be used for custom mail database designs and will only work if the value of the BTZAPPSENDORIGINAL parameter is anything but a zero (BTZAPPSENDORIGINAL accepts 0, 1, 2, and 3).

BTZAPPSENDORIGINAL

Accepted Value: 0/1/2/3

Default: 0

This parameter defines whether an unremediated copy of the mail item is sent to the Exchange user. It should be understood that this mail item will be missing specific Notes-only elements and functionality, but the text will be there. The action taken for each value is as follows:

  • 0 - the feature is disabled.

  • 1 - the original mail item is sent in addition to the ZApp notification. In this case, two mail messages are received by each recipient.

  • 2 - the ZApp notification is inserted into the original mail item at the top. In this case one mail message is received by each recipient.

  • 3 - the ZApp notification is inserted into the original mail item at the bottom. In this case one mail message is received by each recipient.


This parameter does not affect the process of storing the mail item in the BTStore database.

 

BTZAPPFIELDSx

Accepted Value: <comma separated list of field:value pairs>

Default: None

This parameter contains a list of field:value pairs, separated by a comma. If configured, BTCal will check each message for the configured field, and if found, will compare the value of that field with the configured value. If they are equal, BTCal will remediate the mail item. Note that only fields of TYPE_TEXT and TYPE_NUMBER are supported.

If the total list of field:value pairs is larger than 240 characters, it can be separated across multiple BTZAPPFIELDSx variables. Any number of sequentially numbered BTZAPPFIELDSx variables can be defined, starting with BTZAPPFIELDS1.

The following example illustrates 2 alternatives of defining valid field:value pairs:

    BTZAPPFIELDS=MailFormat:E,Z:1

Or

    BTZAPPFIELDS1=MailFormat:E,

    BTZAPPFIELDS2=Z:1


  • In the second alternative, every BTZAPPFIELDSx line, except for the last one, must end with a comma.

  • If BTZAPPFIELDS and BTZAPPFIELDS1 – BTZAPPFIELDSn approaches are used, the BTZAPPFIELDS value will be ignored.

    BTSTORETEXTx

Accepted Value: <text>

Default: The original custom form that was mailed to you can be found using the following link:\n\n".

This parameter defines the text of the custom e-mail sent to a recipient of a “ZApp’ed” e-mail. There can be any number of lines of text; however, the lines must be sequentially numbered starting with 1 and the text of each line cannot exceed 216 characters. When the e-mail text is created, the content of lines is scanned as a single string with no implied line ends. Line ends are defined by the string \n in the text of any line. The string “\t” defines a tab.


Because NOTES.INI parameters cannot have leading or trailing spaces, each BTSTORETEXTx line must begin and end with a non-blank character.

For example:

BTSTORETEXT1=Dear User\n\n\tAn e-mail was sent to you from Domino containing special object

BTSTORETEXT2=s accessible only via Notes Client.\n\n

BTSTORETEXT3=To access this e-mail please click this link ----->\t

Translates as follows:

Dear User

An e-mail was sent to you from Domino containing special objects accessible only via Notes Client.

To access this e-mail please click this link----->.

If BTSTORETEXT is not configured, the default text is as follows:

The original custom form that was mailed to you can be found using the following link:\n\n".

BTZAPPUSERFORMS

Accepted Value: <list of non-standard form names separated by commas>/All/None

Default: None

This parameter defines a list of non-standard mail item forms. The BODY of these non-standard mail item forms should be checked for remediation. This is a multi-valued case-insensitive parameter. A value of “None” represents the condition of the form being blank or absent from the document. A value of “All” indicates that all messages containing a non-standard form in the FORM field will be checked for remediation. It is valid to specify both All and None. When checking for ZAppable items, the only field checked is the BODY field.

BTZAPPTABLES

Accepted Value: Y/N

Default: N

This parameter accepts a value of Y or N. It is used to specify whether BTCal should remediate mail messages that contain non-basic tables.

BTZAPPIGNOREELEMENTS

Accepted Value: All, Button, Mouseover, Popup, Hotregion

Default: None

BTZAppIgnoreElements accepts the following as comma-separated values:

  • All

  • Button

  • MouseOver

  • PopUp

  • HotRegion

Please note that these values are not case sensitive. Each value represents a valid ZAppable element, with ALL representing the combination of the remaining values. If this parameter is configured, and ZApp is enabled, BTCal will examine the mail item to see if the ZAppable element should be ignored. For example, if you have specified “BTZAPPIGNOREELEMENTS=Mouseover,Popup”, and the mail item contains a Mouseover, BTCal will not ZApp the mail item. Also note that if you have “BTZAPPIGNOREELEMENTS=Mouseover”,  and the mail item contains both a Mouseover and Button, the mail item will still be ZApped since you did not configure the Button to be ignored. The mail item will NOT be ZApped if it contains only the specified element.

BTZAPPKEEPATTACHMENTS

Accepted Value: 0/1

Default: 0

This parameter specifies whether attachments will be retained on ZApped messages. By default (parameter set to the default value of 0), attachments are deleted from ZApped messages. When enabled (parameter set to 1), attachments to ZApped messages are retained. This does not alter the attachment as it appears in the BTStopre.nsf.


The BTZAPPSENDORIGINAL parameter does not affect this parameter, When BTZAPPKEEPATTACHMENTS is enabled, attachements will be retained on ZApped messages regardless of the BTZAPPSENDORIGINAL parameter setting.

Logging

There may come a time when it is necessary to gather more information than what is simply written to the Domino console log. There are several logging parameters built into the product that are used to accomplish this. Note that enabling any type of logging will affect performance. Therefore, it is recommended that these parameters only be enabled when instructed to do so by a Binary Tree representative.


  • Logging can be enabled or disabled on the fly (i.e., you do not need to restart BTCal).

  • When writing messages to the log file(s), the messages are appended to the end of the file. To capture a clean log, the previous log file must be deleted before logging of the current session is enabled.

  • A new type of log file is generated on the Windows Coexistence server when there is a SOAP:  Fault message returned by the Exchange Web Services. The new log files are named *.error.log. The log folder can be specified using IIS manager to set it in the Application properties.

If the SOAP:  Fault message indicates the CAS throttling policy has been exceeded, the following EMC commands could be used on the CAS server to create a new throttling policy that has no limits, and assign it to the IIS box:

New-ThrottlingPolicy BTFreeBusy

Set-ThrottlingPolicy BTFreeBusy -RCAMaxConcurrency $null -RCAPercentTimeInAD $null -RCAPercentTimeInCAS $null -RCAPercentTimeInMailboxRPC $null -EWSMaxConcurrency $null -EWSPercentTimeInAD $null -EWSPercentTimeInCAS $null -EWSPercentTimeInMailboxRPC $null -EWSMaxSubscriptions $null -EWSFastSearchTimeoutInSeconds $null -EWSFindCountLimit $null -CPAMaxConcurrency $null -CPAPercentTimeInCAS $null -CPAPercentTimeInMailboxRPC $null -CPUStartPercent $null

 

Set-ThrottlingPolicyAssociation [your iis machine name] -ThrottlingPolicy BTFreeBusy

BTLOGDIRECTORY

Accepted Value: <Windows path name>

Default: Windows temp directory

This parameter defines the directory to which log files will be written. It expects a properly formatted windows path name (e.g., c:\CMTc\log). If the specified directory does not exist, BTCal will attempt to create the directory. If this directory cannot be found or created, or if this parameter is not specified, log files will be written to the Windows temp directory.

BTLOGCACHE

Accepted Value: 0/1

Default: 0

A cache database is used to store data required for proper processing of repeating/recurring meetings by BTCal. This parameter defines whether messages relating to processing of the cache database will be logged. If BTLOGCACHE is set to 0, logging is disabled; otherwise, log messages are written to the file BTCACHE.LOG.

BTLOGRMB

Accepted Value: 0/1

Default: 0

During the processing of calendar invitations received from Exchange, MIME body parts are converted to an .ICS file attachment for delivery to Notes. This parameter defines whether messages relating to this conversion will be logged. If BTLOGRMB is set to 0, logging is disabled; otherwise, log messages are written to the file BTRMB.LOG.

BTLOGUIF

Accepted Value: 0/1

Default: 0

During the processing of calendar invitations received from Exchange, certain fields within the .ICS file are updated before being delivered to Notes. This parameter defines whether messages relating to the updating of .ICS files will be logged. If BTLOGUIF is set to 0, logging is disabled; otherwise, log messages are written to the file BTUIF.LOG.

BTLOGWMBP

Accepted Value: 0/1

Default: 0

During the processing of calendar invitation received from Exchange, if the .ICS file has been updated, the MIME body part may need to be re-written. This parameter defines whether messages relating to re-writing of the MIME body part will be logged. If BTLOGWMBP is set to 0, logging is disabled; otherwise, log messages are written to the file BTWMBP.LOG.

BTLOGCONSOLE

Accepted Value: Y/N

Default: Y

Integration for Notes has been enhanced to allow the user to determine whether log messages should be written to the Domino console.

BTLOGCONSOLE accepts a value of Y(es) or N(o), with the default being Y. Note that Error messages are always written to the console, regardless of the setting of this parameter. Also, note that log messages are always written to the General BTCal log regardless of the setting of this parameter.

BTLOGLEVEL

Accepted Value: 0/1/2

Default: 0

A log file named BTLOG.YYY.MM.DD@HH.MM.SS.LOG resides in the Logging Directory configured for Integration for Notes. All log messages are written to this file, based upon the setting of the BTLOGLEVEL parameter, and optionally to the Domino console (depending on the setting of BTLOGCONSOLE).

BTLOGLEVEL accepts a value of 0 (minimal), 1 (light), or 2 (full), with the default being 0. A log level of 1 corresponds to the debug messages written using the old BTCalL.exe. A log level of 2 corresponds to the debug messages written using the old BTCalF.exe.

BTLOGPNG

Accepted Value: 0/1

Default: 0

If a message from Outlook contains embedded .PNG graphic files, the images are converted to .GIF files and displayed properly when viewed within Notes.

BTLOGPNG accepts a value of 0/1, with the default being 0. When set to 1, Integration for Notes logs all messages relating to PNG processing to a file called BTPNG.LOG, which resides in the Logging directory configured for Integration for Notes .


The BTEx DLL version contained within the current release must be used for full support of embedded PNG conversion.

 

BTLOGCANCEL

Accepted Value: 0/1

Default: 0

When BTLOGCANCEL is set to 1, BTCal turns on full debugging (equivalent of BTCalF) if it detects that it is processing an inbound cancellation message. When processing of that message is complete, logging returns to the value specified in BTLogLevel.


This parameter does not have any effect if you are running BTCalF as it is already at full logging.

 

BTANONYMIZELOGGING

Accepted Value: 0/1

Default: 0

When BTANONYMIZELOGGING is set to 1, subject and originator are anonymized (appear as asterisks) when logging.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating