Skip to content

Notifications

Overview

VCF Operations Orchestrator includes a number of default email notifications that it uses to send email notifications in a number of event types, called scenarios. An organization administrator can customize these notification definitions, including the text and the branding elements of the email.

Project Structure

Build Tools for VMware Aria stores notification objects in several files in a directory with the notification configuration name under the src/main/resources/scenarios directory in the project content on the local filesystem.

Following is a sample listing of the local filesystem for a notification with the name Deployment Lease Expired.

Local Project Content
src/
└─ main/
    └── resources/
        └── scenarios/
            └── Deployment Lease Expired/
                ├── details.json
                └── template.html

Following is a list of the files for each notification object with a short description of their content and purpose.

  • The details.json file contains the metadata information for the notification.
  • The template.html file contains the HTML definition for the notification.

Export

To export the definition of a notification configuration from the VCF Automation server (pull the content), you need to add the notification name as a list item of the scenario element in the content.yaml content descriptor file for the project.

Tip

Alternatively, if you want to export all notification configuration objects from the project on the VCF Automation server, you can configure the scenario element with no value (i.e. its value is null). For details, see the Content Filtering section.

Following is a sample listing of the content.yaml file for a project that exports only the Deployment Lease Expired notification configuration from the project on the VCF Automation server.

content.yaml
scenario:
  - Deployment Lease Expired
# ...

Import

When you import a scenario to a VCF Automation server (push operation), Build Tools for VMware Aria matches the notification object by its name (the name of the directory under src/main/resources/scenarios in the project content on your local filesystem) and performs one of the following operations.

Warning

Note that for push operations for VCF Automation projects for All Apps organizations, Build Tools for VMware Aria uses the content filtering rules that you define in the content.yaml content descriptor file. For details, see the Content Filtering section.

  • If a notification with the same name does not exist on the server, Build Tools for VMware Aria creates a new notification with the details from the local project files.
  • If a notification with the same name already exists on the server, Build Tools for VMware Aria checks if there are any differences between the local copy and the server copy and performs one of the following operations.
    • If there are no differences between the local copy and the server copy, BTVA skips the operation and does not update the notification on the server.
    • If there are differences between the local copy and the server copy, BTVA deletes the existing notification object on the server and creates it again with the definition from the local project.