You can configure the approval workflow system so that users receive email notifications when workflow-related events occur. Notifications can be sent to users who have requests to approve. You can use predefined email templates for workflow notifications, or you can use a custom email template for each workflow that you create. For example, if you have an approval request workflow, you can use an email template that was written specifically for approval request.
Note:
For CentraSite to issue email messages, an administrator must first configure CentraSite's email server settings. For procedures,
see the section Configuring the Email Server in the document Basic Operations.
The content is organized under the following topics:
The following predefined email templates are installed with CentraSite. These templates are provided for you to use with the API Management workflow listed below if you do not want to create your own email templates.
| Template Name | Description | To use with... |
|---|---|---|
| APIKeyGenerationSuccess.html | Default email template used when an approval request for API key generation is approved. | The Approved action in the
Key Generation Settings panel.
|
| PendingApprovalNotification.html | Default email template used when an approval request for API key generation is submitted to approvers. | The Approval Request
action in the Key Generation Settings panel.
|
| APIKeyRenewalSuccess.html | Default email template used when an approval request for API key renewal is approved. | The Approved action in the
Key Renewal Settings panel.
|
| APIKeyRenewalPendingNotification.html | Default email template used when an approval request for API key renewal is submitted to approvers. | The Approval Request
action in the Key Renewal Settings panel.
|
| RejectionNotification.html | Default email template used when an approval request is rejected. | The Rejected action in the
Key Generation Settings and Key Renewal Settings.
|
| APIKeyRevocationSuccess.html | Default email template used when an approval request for API key revocation is approved. | The Approved action in the
Key Revocation Settings panel.
|
| APIKeyExpiredNotification.html | Default email template used when an API key has expired. | In the centrasite.xml file located in the <CentraSiteInstallDir>\cast\cswebapps\BusinessUI\ directory |
| APIKeyExpirationNotification.html | Default email template used when an API key is about to expire. | In the centrasite.xml file located in the <CentraSiteInstallDir>\cast\cswebapps\BusinessUI\ directory |
| OnboardingSuccessMessage.html | Default notification template used for notifying a consumer that a request for consumer onboarding has been processed successfully. |
The - OR - The |
| APIKeyDeployFailed.html | Default notification template used for notifying a provider that an API key generation has failed. | For internal use. |
You can use a custom email template for each workflow that you create. To write an email template for a workflow, see the instructions in Create Email Templates for Workflow Notifications below.
You can use a specific email template for each workflow that you create. For example, if you have an API Consumption Approval workflow, you can use an email template that was written specifically for the API consumption approval.
Complete the following procedures to create a custom email template.
Create your own custom HTML email template.
Your HTML document should include the <html> and <label> tags as shown in the example below.
<html>
Congratulations! ${policycontext.consumer.name},<br/><br/>
Your Consumption Request for the API ${entity.name} on ${request.date} has been processed successfully. <br/>
You can now access the API using the API Key - <b> ${policycontext.apikey} </b>. The key expires on <b> ${apikey.expirationdate} </b><br/><br/>
<b>Information about API usage:</b>
<br>${api.usage}</br>
</html>
Specify the key parameters.
| Set this parameter... | To specify... |
|---|---|
{policycontext.consumer.name} |
Name of the consumer. |
{entity.name} |
Name of the API. |
{request.date} |
Date of the request for API consumption. |
{policycontext.apikey} |
The API key. |
{apikey.expirationdate} |
Expiration date of the API key. |
{api.usage} |
Usage tips for the API key. |