How do I set up the Forgot Credentials email when sent by the REST API?

If an app user doesn't know their login credentials they can use the Forgot Login button in the app. This will send them an email to reset their password. Sending this email via the REST API requires configuration that was not needed for the SOAP API. This article lists the steps to ensure it is set up properly.

A Note about HTML Templates

The REST API requires an HTML template for the Login Credentials email. Prior to Tessitura v16 this was not a requirement, so you may not have one set up already. If you need to create an HTML Template for your email please see Tessitura Help: HTML Templates or create a ticket with Tessitura support.

Since HTML templates aren't widely adopted yet, the app will fallback to using the SOAP API to send the Forgot Login email if there is an error sending via the REST API. This will work until you upgrade to Tessitura v16, at which point the SOAP API will no longer be available.

If you are ready to using HTML templates, please follow these instructions:

TR_EMAIL_PROFILE

Note: The ID's and other values in your Tessitura system will be different that those in the screenshots below. 

1. In Tessitura, go to the TR_EMAIL_PROFILE system table.
2. Make sure there is a row for sending credential emails.
3. Get the ID of that row. ID 2 in this example:

T_DEFAULTS: CRED_EMAIL_PROFILE

1. In Tessitura, go to the T_DEFAULTS system table.
2. Make sure there is an entry with these values:
   Parent Table: This should match the value in the Organization Name or Parent Table field in your REST API Credentials setting in the InstantEncore Control Panel. If you have left this value empty in the Control Panel, use "Tessitura Web".
   Field Name: "CRED_EMAIL_PROFILE"
   Default Value: The ID of the row in TR_EMAIL_PROFILE that you found above.

T_FORMAT_INFO

1. In Tessitura, go to the T_FORMAT_INFO system table.
2. Find the row with the template you want to use.
3. The row must have a value set in the Template ID column with the HTML template that will be used. You can select an existing template, or create a new one. See HTML Templates for details.
4. Get the ID of that row. In this example it's ID 30.

T_DEFAULTS: CRED_EMAIL_FORMAT_NO

1. In Tessitura, go to the T_DEFAULTS system table.
2. Make sure there is an entry with these values:
   Parent Table: This should match the value in the Organization Name or Parent Table field in your REST API Credentials setting in the InstantEncore Control Panel. If you have left this value empty in the Control Panel, use "Tessitura Web".
   Field Name: "CRED_EMAIL_FORMAT_NO"
   Default Value: The ID of the row of the row in T_FORMAT_INFO you found above.

Set Template ID in the InstantEncore Control Panel

1. Log into instantencore.com and go to REST API: Required Settings (Control Panel > InstantApps > Tessitura > Required Settings).
2. In the Send Credentials Template field select the template from the T_FORMAT_INFO table that you found above.

Testing

In your app (or the app preview), go to the account area and tap the "Forgot Login" button when logging in. Verify that you receive the email.

Resources

• Tessitura Help System: TR_EMAIL_PROFILE: Be sure to expand "Registering Email Profiles" and look for "Forgotten Login Emails".
• If you continue to experience issues please open a ticket with Tessitura and ask for help setting up your Forgot Login HTML template to be sent via the REST API.