Page History

...

This can be useful for updating a user's mail template to the latest version after the Notes client is upgraded to a new client version. It can also be used to deploy a customized mail template to specific users.

Preparing Your Infrastructure

...

• Replicate the new mail template(s) to all mail servers in using the same path relative to the Domino Data directory.
• The signer of the 'Replace Database Design' scheduled agent needs to have at least Designer rights to the mail databases.
• The signer of the scheduled agent also needs to be in the “Full "Full Remote Console Administrators” group Administrators" field for the server document of all mail servers:
   Image RemovedImage Added
• In addition it's possible that the server that the agent runs on needs to be listed in the "Full Remote Console Administrators" field as well as the "Trusted Servers" field for all mail servers that have mail databases that might be updated:
  Image Added

This HCL technote has more information on these requirements: https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0093468

MarvelClient Config DB Configuration

In order to detect what mail templates are currently being used, you will need two different MarvelClient actions to run on your users' machines:

1. Create a Run Agent action that runs the the agent ‘X. Addon PERNAB: Collect LocalNamesDetails’ from the MarvelClient Analyze DB. Instructions for setting this up can be found in the article: Get Location and Connection Information
   
   1. This requires the agent from MarvelClient Analyze DB template version 20230420 or higher
   2. If you are already using a Run Agent action with this agent, you will need to open it in edit mode and use the "Check For Update" button to get the latest version of the agent from the Analyze DB after you've updated your template version
      Image Added
      
      
2. Create a Backup action that saves MarvelClient XML files to your Analyze DB. You can use the example action in the Config DB for this purpose, as described here: The readily prepared backup Action in detail

...

In the MarvelClient Analyze DB, make sure the 'Audit' agent is enabled and scheduled to run, and the 'Run Post Processing' option is selected in the Audit Configuration document. This will collect the mail template information from the 'X. Addon PERNAB' agent.

Image Removed

...

Replace Design Configuration in the MarvelClient Analyze database

The same configuration in the MarvelClient Analyze database is used by both the MarvelClient Upgrade and the scheduled agent options.

...

This view lists the mail template name by Notes client version and gives an overview of your current mail database design situation. Full clients only: no Nomad (iOS, Android, Nomad Web) clients

The view below that in the navigator is ‘Replace Design Configuration’:

...

Replace Design using MarvelClient Upgrade with SMTP mail

In the MarvelClient Config DB, on the MarvelClient Upgrade configuration ‘Tracking’ tab, are the options to choose one the 'Send...' options for ‘Send SMTP Progress Emails’.

Image RemovedImage Added

Using this option, after a Notes client is successfully upgraded, an email will be sent to the MC Analyze DB. This triggers a template replacement for that user’s mail , based on the enabled entries in the ‘Replace Design Configuration’ view described in the previous section. This works database in the following way:

1. The success email is processed by the agent ’(Before New Mail Arrives - MarvelClient Upgrade)’ in the MC Analyze DB
2. This agent searches the 'Replace Design Configuration' view for documents matching the user's Current Mail template and MCUpgrade packagename 
3. If a match is found, and the matching document is enabled, a console command (load convert -u …) is sent the user's Mail server. This command will be processed immediately on the server.
4. After the mail template upgrade is successfully completed and , the next time the user opens their mail database , they will see the new design replace will be performed.

NOTE: If a Replace Design Configuration document matching the user's Current Mail template and MCUpgrade packagename is not found, nothing will be done!

...

1. Make sure all the steps in the Preparing Your Infrastructure section above are complete:
   
2. An agent action that runs the ‘X. Addon PERNAB: Collect LocalNamesDetails’ agent
3. A backup action that uploads to the Analyze DB
The Audit agent is scheduled to run, and the Post-Processing option is selected in the Audit ConfigurationThe 'Replace Database Design ' agent is signed using an ID as described in the Domino Server ConfigurationConfiguration sections above are complete
4. Make sure the 'Replace Database Design' agent is enabled and scheduled (double-check the agent signer again after doing this!)
5. Make sure the Replace Design Configuration documents have been created properly, as described above

As with the MarvelClient Upgrade process, the The scheduled agent ‘Replace database design’ searches the 'Replace Design Configuration' view for documents matching the user's Current mail template name and Min Notes version. 

If a match is found, and the matching document is enabled, a console command (load convert -u …) is sent the user's Mail server. This command will be processed immediately on the server, and the design replace will be performed the next time the user opens their mail database they will see the new design.

NOTE: As always, please test thoroughly before implementing. Your users will thank you!

...

Related articles

...

...