-
Title
NI: Zapp Processing Workflow Guide -
Description
NI: Zapp Processing Workflow Guide -
Resolution
The purpose of this document is to define the workflow process for Zero Touch Application Remediation (ZApp) functionality of CMT for Coexistence. Please note that term variable refers to notes.ini parameters defined on CMT for Coexistence Domino Server. For a detailed description of each variable, see the document CMT for Coexistence Comprehensive User’s Guide.
Check ZAppSupport:
Is ZApp enabled with variable BTZAPPSUPPORT=1?
Yes
Continue ZApp processing
No
Exit ZApp processing - No action
Check ZAppBypass:
Is ZApp bypass enabled by variable BTZAPPBYPASS=1?
Yes
Does mail item contain field $BTZAppBypass equal to “1”?
Yes
Exit ZApp processing - No action
No
Continue with ZApp processing
No
Continue with ZApp processing
Check ZAppBypassDocsWithFields:
Is ZApp disabled for mail item containing fields defined by variable BTZappByPassDocsWithFields?
Yes
For each field defined: Does mail item contain field?
Yes
Exit ZApp processing – No action
No
Continue with ZApp processing
No
Continue with ZApp processing
Check AlreadyZApped:
Does mail contain field $BTZApped equal to “1”
Yes
Exit ZApp processing - No action
No
Continue ZApp processing
Check ZAppCheckEncrypt:
Is ZApp enabled for encrypted mail items by BTZAPPCHECKENCRYPT=1?
Yes
Is mail item Encrypted (field "$Seal" equal to “1” or “Y”)?
Yes
ZApp mail item
No
Continue with ZApp processing
No
Continue with ZApp processing
Check ZAppIgnoreStoredForms:
Is ZApp disabled for mail item containing stored forms by BTZAPPIGNORESTOREDFORMS =1?
Yes
Is mail item Form field blank or not present?
Yes
Does mail item contain field $Body_StoredForm or $Fields_StoredForm or $Title_StoredForm?
Yes
Exit ZApp processing – no action
No
Continue with ZApp processing
No
Continue with ZApp processing
No
Continue with ZApp processing
Check ZAppProcessForms:
Is ZApp enabled for mail item containing forms defined by BTZAPPPROCESSFORMS?
Yes
Is the value of the mail item form field part of the list defined by the variable?
Yes
ZApp mail item
No
Continue with ZApp processing
No
Continue with ZApp processing
Check ZAppIgnoreForms:
Is ZApp disabled for mail item containing forms defined by BTZAPPIGNOREFORMS?
Yes
Is the value of the mail item form field part of the list defined by the variable?
Yes
Exit ZApp processing - No action
No
Is the mail item form field blank or missing and value “none” part of the list defined by
variable?
Yes
Exit ZApp processing - No action
No
Continue with ZApp processing
No
Continue with ZApp processing
Check ZAppFields:
Is ZApp enabled for mail item containing fields defined by BTZAPPFIELDS?
Yes
For each field defined by the variable: Does the mail item contain a field defined by the variable?
Yes
Is the value of the field equal to the value defined by the variable?
Yes
ZApp mail item
No
Continue with ZApp processing
No
Continue with ZApp processing
No
Continue with ZApp processing
Check StandardForm:
Is the value of mail item form field in the following list:
Memo, Reply, Reply With History, Phone Message, Delivery Report, NonDelivery Report, Return Receipt, Database Entry, Trace Report, Quota Report, CalendarProfile, DelegationProfile, Appointment, Notice, Reservation, Resource, Task, RepeatCache, TaskNotice
Is form a Standard Form?
Yes
Check Body
No
Continue ZApp processing
Check ZAppUserForms:
Is ZApp enabled for mail item containing forms defined by BTZAPPUSERFORMS?
Yes
Is the form field present
Yes
Is the form field empty
Yes
Is ‘None’ one of the forms defined for the variable?
Yes
Check Body
No
Continue with ZApp processing
No
Is the form one of the forms defined for the variable?
Yes
Check Body
No
Continue with ZApp processing
No
Is ‘None’ one of the forms defined for the variable?
Yes
Check Body
No
Continue with ZApp processing
No
Continue with ZApp processing
Check ZAppIgnoreAllForms:
Is ZApp disabled for mail item containing non-standard forms defined by BTZAPPIGNOREALLFORMS = 1?
Yes
Exit ZApp processing – no action
No
Continue ZApp processing
Check ZAppIgnoreForms:
Is ZApp disabled for mail item containing non-standard forms defined by BTZAPPIGNOREFORMS = allnonstandard?
Yes
Exit ZApp processing – no action
No
ZApp mail item
Check Body:
Does field Body contain a ZApp-eligible element (see list of elements below)?
Yes
ZApp mail item
No
Exit ZApp processing - No action
ZApp Mail Item
Is single copy of a mail item in BTStore enabled by variable BTZAPPUNIQUECOPY=Y?
Yes
Make a single copy of the mail item in BTStore for each recipient
Update $BTZAppReason, $BTReaders, $BTRecipient fields as described below
No
Make one copy of the mail item in BTStore for all recipients
Update $BTZAppReason, $BTReaders, $BTRecipient fields as described below
Send customized ZApp Message to each recipient with link to document in BTStore
Is processing of the original mail item defined by variable BTZAPPSENDORIGINAL?
Yes
If BTZAPPSENDORIGINAL=0
Do not send a copy of the original mail item to each recipient.
If BTZAPPSENDORIGINAL=1
Send a copy of the original mail item to each recipient.
If BTZAPPSENDORIGINAL=2
Insert the ZApp notification at the beginning of the original mail item.
If BTZAPPSENDORIGINAL=3
Insert the ZApp notification at the end of the original mail item.
No
Do not send a copy of the original mail item to each recipient
Exit ZApp processing - Processing Completed
List of ZApp-eligible elements:
· HOTSPOT POPUP
Not ZApped if “ALL” or “POPUP” specified for BTZAPPIGNOREELEMENTS.
· HOTSPOT BUTTON
Not ZApped if “ALL” or “BUTTON” specified for BTZAPPIGNOREELEMENTS.
· HOTSPOT MOUSEOVER
Not ZApped if “ALL” or “MOUSEOVER” specified for BTZAPPIGNOREELEMENTS.
· HOTSPOT HOTREGION
Not ZApped if “ALL” or “HOTREGION” specified for BTZAPPIGNOREELEMENTS.
· HOTSPOT PRETABLEBEGIN
Tables will only be Zapped if BTZAPPTABLES=Y
NOTE: If BTZAPPIGNOREELEMENTS is configured, and for example, you have BTZAppIgnoreElements=Mouseover, and the mail item contains both a mouseover and button, the mail item will still be ZApped (since BTCal is not configured for Buttons to be ignored). The mail item will only NOT be ZApped if it contains only the specified element. BTZAPPIGNOREELEMENTS is currently only supported in CMTc release 3.0.0.1.
Update of $BTZAppReason, $BTReaders, $BTRecipient field:
· $BTZAppReason (text) – reason for mail item remediation
· $BTRecipient (text) – each recipient’s name as addressed by the originator (no domain)
For example: John Smith/Users/Acme@AcmeEx will be John Smith/Users/Acme
Mary Jones@AcmeEx will be Mary Jones
· $BTReaders (Readers) – each recipient’s resolved hierarchical name, if found, plus value from variable BTZAPPREADERS. Recipient resolution is performed as follows:
Is recipient name hierarchical and value of Organization portion of the name is part of the list defined by variable BTZAPPORGS/BTZAPPORGSx?
Yes
Add recipient name without domain to $BTReaders field
No
Look up recipient name against NAB(s) defined by variable NAMES
Is unique match found?
Yes
Check each value of the FullName field of the NAB document
Is value hierarchical and the Organization portion of the name is part of the list defined by
variable BTZAPPORGS/BTZAPPORGSx?
Yes
Add recipient name without domain to $BTReaders field
Stop FullName value check
No
Continue FullName value check
Did FullName check result in proper organization match?
Yes
Recipient will have access to document in BTStore
No
Recipient will not be included in BTStore document security and will not have
access to document in BTStore
No
Recipient will not be included in BTStore document security and will not have access to
document in BTStore
Reasons Specified in Calendar ZApp Notifications
CMT for Coexistence can be configured to remediate mail items that contain Notes items that cannot be properly displayed within Outlook. If BTZAPPSUPPORT is enabled in the NOTES.IN! file, the original outbound mail items (those sent from Notes to Outlook) will be stored in a separate configured database (BTStore). Additionally, a separate note will be created and sent to the Outlook users notifying them of this.
When storing the original mail item in the BTStore database, an additional field, $BTZAppReason, is inserted in the mail item to explain the reason why the mail item was ZApp'ed. The BTStore template contains a view that displays the mail items sorted by the failure reason. This view is titled, By Reason.
Included below is a complete list of all of the possible values stored in $BTZAppReason along with an explanation of each one:
• "Encrypted" message.
• The mail item is encrypted and BTCal is configured with BTZAppCheckEncrypt=l
• "Stored Form" for messages with stored forms
• The mail item contains stored forms and BTZApplgnoreStoredForms=0.
• "Process Form" for messages with process forms
• The mail item contains a form defined by BTZappProcessForms.
• "Custom Field"
• The mail item contains a field/value paiir defined in BTZAppFields.
• "Form" field does not exist.
• There is no form field specified, so you assume it is a custom form and ZApp it.
• "Custom Form· for messages with custom forms
The mail item contains a custom (non-standard) form. The user can specify to not ZApp non-standard forms one of two ways:
• By specifying BTZApplgnoreForms=allnonstandard
• By specifying BTZApplgnoreAIIForms=l
If the user has not specified a value on these two options, the mail item will be Zapped.
• "Popup" for type HOTSPOTREC_TYPE_POPUP - Popup Hotspot was found in the mail item, and BTZApplgnoreElements did NOT specify All or Popup.
• "Button" for type HOTSPOTREC_ TYPE_BUTTON - Button Hotspot was found in the mail item, and BTZApplgnoreElements did NOT specify All or Button.
• "Mouseover" for type HOTSPOTREC_ TYPE_MOUSEOVER - Mouseover Hotspot was found in the mail item, and BTZApplgnoreElements did NOT specify All or Mouseover.
• "HotRegion" for type HOTSPOTREC_TYPE_HOTREGION - Hotregion Hotspot was found in the mail item, and BTZApplgnoreElements did NOT specify All or Hotregion.
• "Button" for type SIG_CD_B'UTTON - Button Hotspot was found in the mail item, and BTZApplgnoreElements did NOT specify All or Button.
• Non-basic Table found - non-basic table was found in the mail item and BTZAppTables=Y. Examples of a nonbasic table are tabbed tables and captioned tables.