...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Example of a Jira Cloud distribution setup
...
...
...
...
Deleting global configurations
...
| Table of Contents | ||
|---|---|---|
|
About Distribution Jobs
Configure distribution jobs to send specific types of alerts to selected audiences. You use the providers and channels that you configure to create distribution jobs in Alert.
...
| Info |
|---|
When you configure distribution jobs, required fields are denoted by a red asterisk (* ). |
...
| Info |
|---|
The notification types shown are for the selected provider in the distribution job. Therefore, if you select the Black Duck provider, only Black Duck notification types are available to select. |
...
| Info |
|---|
The Enabled column was added to the distribution table that displays a checkmark or an X depending on the enabled state of the job. |
...
Creating a distribution job
Use the following process to create a distribution job.
Navigate to Jobs > Distribution, click +New. The New Distribution Job dialog displays.
To enable the distribution job, leave the Enabled checkbox selected or deselect the checkbox to disable the job.
Using the Channel Type drop-down menu, select the job type; either Azure Boards, Email, Jira Cloud, Jira Server, MS Teams, or Slack.
Notifications generated through Alert are sent using this channel. The New Distribution Job dialog expands to display the appropriate fields for the selected job type.Complete the fields as follows.
The following are common for all job types:
Name: Type a unique name for the distribution job.
Frequency: Use the drop-down to select how frequently you want Alert to check for notifications to send: Real Time as triggers occur, or Daily.
Provider Type: Name of provider type. Only notifications for the selected provider are processed in this distribution job. Selecting Black Duck displays additional fields which are described in the following steps.Provider Configuration: The unique name assigned to this provider configuration that is configured on the Providers page.
After completing the previous fields, additional fields display which are pertinent to your selected provider type, which includes the following fields and sections.
Notification Types: Select one or more types from the drop-down list. Only the selected notification types are included for this distribution job. Your selections display in the Notification Types box. Click X at the right of a notification type to remove it from your selections. Alert versions 5.0.0 and higher support the BOM_EDIT notification. In Distribution Job configurations with Black Duck selected as the provider, BOM_EDIT displays as an option in the drop-down selector for Notification Types. The BOM_EDIT notification is primarily intended for use in Jira Cloud to keep component information on issues as up to date as possible.
When Project and Project Version Black Duck notification types are selected, these notifications notify you when new projects or project versions are created or deleted. When used with Jira Cloud, Jira Server, or Azure Boards, the deletion of either project or project version triggers a Resolve Transition, when enabled, for all issues related to it.
In Alert versions 5.1.0 and higher, two new Black Duck notification types are supported: Project and Project Version. When selected, these notifications notify you when new projects or project versions are created or deleted. When used with Jira Cloud, Jira Server, or Azure Boards, the deletion of either project or project version triggers a Resolve Transition, when enabled, for all issues related to it.Notification types are as follows:
- BOM_EDIT
- PROJECT
- PROJECT VERSION
- LICENSE_LIMIT
- POLICY_OVERRIDE
- RULE_VIOLATION
- RULE_VIOLATION_CLEARED
- VULNERABILITYProcessing: Select one of the following:
- Default: Displays the notifications as they are.
- Digest: Displays a more streamlined version.
- Summary: Only includes changes that have occurred.
Note: In versions 5.3.0 and earlier, the Processing field is labeled as Format.
Important note:
Using the Summary processing type with the issue tracker channels will result in unexpected behavior with the issues that are created.Filter by project: If selected, only notifications from the selected projects table are processed. Otherwise, notifications from all projects are processed. Selecting this checkbox displays these additional fields:
Project name pattern: Type the regular expression to use for determining the projects to include. These are in addition to the projects selected in the table.
Projects: Select a project or projects to be used to retrieve notifications from your provider. Clicking Select displays the Projects table. Select the projects to include in notifications by clicking the checkbox at the left of the project name. Click Show Selected Only to display only your selected projects. Click Show All to display all projects. When you are finished selecting your projects, click OK to return to New Distribution Job. Your selected projects now display in the Projects field. When projects are selected, but not returned in the request and you navigate to the listing, these items are added to the list and are removable.
Black Duck Notification Filtering:
This filtering option is available when you select Black Duck as the Provider.Policy Notification Type Filter: To use this filter, you select a policy notification.
Click Select to show a list of policies and select the checkbox for each policy that you want to add, and click OK.
Vulnerability Notification Type Filter: To use this filter, you select a vulnerability notification.
Click the dropdown menu to show a list of vulnerability severities.The following fields display based on your selection in the Type field.
...
If information is missing, the notification Required field missing displays in red above the affected field. Complete the required fields, and click Test Configuration. When the test is successful, click Save.
Example of a Jira Cloud distribution setup
The following is an example of a possible Jira Cloud job distribution setup. Your settings will vary based on your environment; this example is for illustrative purposes only.
...
For more information regarding permissions, refer to Atlassian: Managing Project Permissions.
Copying a distribution job
In Alert versions 5.0.0 and higher, the Distribution table includes an additional column containing a copy button, located at the far right of each distribution job. This enables you to copy the configuration of an existing distribution job. By using the copy functionality you can easily configure multiple distribution jobs where only a small number of fields differ between jobs. When copying a distribution job, you must use a unique job name for the copied job. Clicking the copy icon displays the Copy Distribution Job dialog box.
...
| Info |
|---|
Members of each project only receive notifications about projects of which they are members. For example, if you set up a job and select Project A, Project B, and Project C, then members of Project A do not receive notifications about Project B, even if both projects are in the same job. |
Editing a distribution job
In Jobs > Distribution, click the Edit (pencil) icon at the right of the desired job. The Edit Distribution Job dialog displays. In Alert versions 5.1.0 and higher, double-clicking a row in the Distribution table opens the Edit Distribution Job dialog for the selected entry.
Make the desired edits.
Click Test Configuration to send a test alert to ensure values are valid.
Click Save to save the edited job. Your changes are saved, and you are returned to the Distribution screen.
Deleting a distribution job
In Jobs > Distribution, click the row of the desired job to select it.
Click Delete. A popup asks you to confirm the deletion.
Click Confirm. The job is deleted.
Deleting global configurations
For a given global configuration, but not job configurations, if you remove the values in all fields and click Save, the configuration is cleared from the database.
Vulnerability update considerations
In Alert versions 5.0.0 and higher, vulnerability notifications include remediation information when available. This is listed as an additional section of the message, and is listed per component version.