Portal E-mail Templates
On this page
The Self Service Portal has its own e-mail templates. Two applications carry them: the Admin Center and the Settings App. Both edit the same stored templates. For how the two applications divide the administration work, see Admin Center and Settings App.
The self-registration settings that decide when the registration messages are sent are described in Self-Registration.
Messages the portal sends
The portal sends four messages from these templates, each as HTML, from the installation's default sender address:
| Template | When the portal sends it |
|---|---|
| Registration Confirmation | A self-registration that needs no authorization, and the approval of a registration |
| Manager Notification | The same self-registration, when its option in the self-registration settings is on |
| Authorization Request | A registration that needs authorization, when its option in the self-registration settings is on |
| Password Notification | A password restore |
Portal e-mail templates in the Admin Center
In the Admin Center, the portal's instance settings are administered under Apps and Portals > Self Service Portal. The portal e-mail templates are on the SSP E-mail Templates page of the Notifications section. For the other pages of that section, see Notifications Overview.
The page lists the templates in a single column of names. Edit is the only action button on its toolbar, beside the refresh icon and the search box. There is no command to create or copy a template on this page. An information banner appears above the list only when more than one Self Service Portal instance has self-registration enabled.
Before you begin
- The Notifications section shows the SSP E-mail Templates page to administrators who hold the Self Service Portal configuration right, and its other pages to holders of the notifications right. An administrator who holds only the Self Service Portal configuration right is still offered the Notifications section.
Edit a portal e-mail template
- Go to Notifications > SSP E-mail Templates.
- Select one template and click Edit, or double-click the template. Edit is available only while exactly one template is selected. The template opens in an edit drawer.
- Change the template's name, description, subject, or content. The content is edited in an HTML editor.
- To add a placeholder, use Select Placeholder. It drills down from a category to an item and then a sub-item, and its OK is available only once a complete placeholder is chosen.
- Save the template. None of the four fields is required: a template is saved even with any of them left blank.
Portal e-mail templates in the Settings App
In the Settings App, the Self Service Portal node has an E-mail Templates page, next to the Self-Registration and Workflow pages of the same node.
The page lists the portal's four fixed messages in one Name column. There is no command to add or delete a template.
Before you begin
- The template editor requires the administrative right that gives access to the Self Service Portal group of the Settings App. It checks the right every time it opens, from the E-mail Templates page or from the workflow Find Callers tool; without the right, it refuses with an error.
Edit a portal e-mail template
- Go to Self Service Portal > E-mail Templates.
- Double-click a template, or select it and click Open. The template opens in the Edit Template window, with its Name: in the General group.
- In the Notification group, change the Subject:. The ellipsis button of the box opens Select Placeholder.
- Change the Body:. Click Insert Placeholder... to add a placeholder.
- Click OK to save. Cancel closes the window.
The body has no format choice: it is always HTML. The body editor opens in Design mode; the first toolbar item switches between Design and HTML Code, and a Format command is shown only in HTML Code mode. The rest of the toolbar has boxes for the style, font, and font size; character formatting and colors; numbered and bulleted lists and indentation; table commands; alignment; and commands that insert a horizontal line, a link, and an image. The Style list holds Formatted, Heading 1 to Heading 5, and Paragraph.
Placeholders in portal e-mail templates
In the Settings App, Select Placeholder offers the fields of the user account under
Object Fields > Current Values: %[DBF Last_IP]%, %[DBF Login]%,
%[DBF Password]%, %[DBF Person_ID]%, and %[DBF Pswd_LastChange]%.
Person_ID opens onto the person's fields, inserted as
%[DBF Person_ID.<field>]%. The macros offered are Now, Today,
Initiator, License Information, MessageID Tag, Web Portal Link,
Self Service Portal Link, and API Link; Current User is not offered.
What the placeholders yield depends on the message:
- In Registration Confirmation sent for a registration that needs no
authorization, the
Passwordfield yields the new password. - When a registration is approved, Registration Confirmation goes to the
person's primary e-mail address, and
Passwordis replaced by "Use the password that you specified during the registration.". If the person has no primary e-mail address, the approval ends with the error "Primary E-mail of associated Person is empty." and nothing is sent. For what then happens to the registration, see Review pending registrations. - Authorization Request is sent before the account exists, so its fields
are filled from the registration:
Loginas entered,Last_IPwith the client's IP address, and any other field by its name from the registration data. A person field that the registration does not carry comes out empty, and so doesPswd_LastChange.