Creating custom email templates

Starting in Maximo® Application Suite 9.0.3, you can customize the emails templates that are used in Maximo Application Suite by creating a ConfigMap in Red Hat® OpenShift® Container Platform.

1. In the Red Hat OpenShift Container Platform console, in the Workloads section, select ConfigMap.
2. Click Create ConfigMap and select YAML view.
3. Enter the YAML syntax for the ConfigMap.
   The following example is for a custom email template to confirm a password reset.

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: custom-email-templates
     namespace: mas-myinstanceid-core
   data:
     UserPasswordReset: |
       MIME-Version: 1.0
       Content-Type: multipart/alternative; boundary=edf79c96c6bc4320ae4106a24320edb0; charset="UTF-8"
       Subject: Password reset confirmation / Confirmação de reconfiguração de senha: IBM Maximo Application Suite
   
       This is a multipart message in MIME format.
       template_name='{{ meta.template_name }}'
   
       --edf79c96c6bc4320ae4106a24320edb0
       Content-Type: text/plain; charset="UTF-8"
   
       ---------------------------------------------------------
       Password reset confirmation: IBM Maximo Application Suite
       ---------------------------------------------------------
   
       Dear {{ user.displayName }},
   
       An IBM Maximo Application Suite password reset was requested for the account that is associated with this email address.
       If you did not make the request, you can ignore this email and no further action is taken.
   
       To complete the reset, enter the included confirmation code in the password reset dialog.
   
       Confirmation code: {{ code }}
   
       {% if expirationMinutes -%}
       This code expires in {{ expirationMinutes }} minutes.
       {% endif -%}
   
       --------------------------------------------
       Need help?
       For technical support, visit IBM Support page: {{ links.ibm_support }}
       For suite support, see IBM Documentation: {{ links.mas_kc }}
       --------------------------------------------
       (c) 2023 IBM All rights reserved
   
       
       --------------------------------------------------------------------
       Confirmação de reconfiguração de senha: IBM Maximo Application Suite
       --------------------------------------------------------------------
   
       Caro(a) {{ user.displayName }},
   
       Uma reconfiguração de senha do IBM Maximo Application Suite foi solicitada para a conta que está associada a este endereço de e-mail.
       Caso não tenha feito a solicitação, ignore esse e-mail e nenhuma outra ação será tomada.
   
       Para concluir a reconfiguração, insira o código de confirmação incluído na caixa de diálogo de reconfiguração de senha.
   
       Código de confirmação: {{ code }}
   
       {% if expirationMinutes -%}
       Esse código expira em {{ expirationMinutes }} minutos.
       {% endif -%}
   
       --------------------------------------------
       Precisa de ajuda?
       Para obter suporte técnico, visite a página de suporte da IBM: {{ links.ibm_support }}
       Para obter suporte a conjuntos, consulte a documentação da IBM: {{ links.mas_kc }}
       --------------------------------------------
       (c) 2023 IBM Todos os direitos reservados
   
       --edf79c96c6bc4320ae4106a24320edb0

   If you use an existing email template as a baseline for a custom template, be aware that existing templates reference files, such as CommonHeader.html.j2, CommonFooter.html.j2, CommonFooter.txt.j2, and CommonPreamble.txt.j2. If those references are kept in the custom templates, make sure the content of these referenced files are also added to the custom-email-templates configmap, for example:

   data:
     ...
     CommonPreamble.txt.j2: |
       This is a multipart message in MIME format.
       template_name='{{ meta.template_name }}'

4. To use the custom template, specify the template mode as custom in the SmtpCfg custom resource.
   1. In the Administration section, select Custom Resource Definitions.
   2. In the CustomResourcesDefinitions window, select the SmtpCfg file.
   3. On the Instances tab, select the instance that you want to update.
   4. On the YAML tab, in the spec.config section, enter custom for the templateMode property.

      spec:
        config:
          templateMode: Custom

5. Save your changes.