|
1 | 1 | # Add Subscription |
2 | 2 |
|
3 | | -This form is used to add subscription through frontend GUI. Here is a |
| 3 | +This form is used to add subscription through frontend GUI. Here is a |
4 | 4 | description of the elements available on this form. |
5 | 5 |
|
6 | | -**Load Subscription Template:** In this dropdown list options are given to |
7 | | -select a specific template for the subscription form. Currently, the following |
8 | | -options are listed: Jenkins Pipeline Parametrized Job Trigger, REST POST and |
| 6 | +<img src="images/add_subscription_form1.png"> |
| 7 | +</img> |
| 8 | + |
| 9 | +**Load Subscription Template:** In this dropdown list, options are given to |
| 10 | +select a specific template for the subscription form. Currently, the following |
| 11 | +options are listed: Jenkins Pipeline Parametrized Job Trigger, REST POST and |
9 | 12 | Mail Trigger. |
10 | 13 |
|
11 | | -**SubscriptionName:** A field to give a name to the current subscription. Only |
| 14 | +**SubscriptionName:** A field to give a name to the current subscription. Only |
12 | 15 | letters, underscore and numbers are allowed in this field. |
13 | 16 |
|
14 | | -**NotificationType:** There are two options: REST POST and |
15 | | -Mail Trigger, depending on how a subscriber want to be notified when a |
16 | | -subscription is fulfilled. If Notification type MAIL is selected an email |
| 17 | +**NotificationType:** There are two options: REST POST and |
| 18 | +Mail Trigger, depending on how a subscriber want to be notified when a |
| 19 | +subscription is fulfilled. If Notification type MAIL is selected an email |
17 | 20 | subject may be entered, but it is optional. |
18 | 21 |
|
19 | | -**RestPostMediaType:** Options for selecting a |
20 | | -specific form content type. The options available in the list depends on the |
| 22 | +**RestPostMediaType:** Options for selecting a |
| 23 | +specific form content type. The options available in the list depends on the |
21 | 24 | selected template type. |
22 | 25 |
|
23 | | -**NotificationMessage:** It is used to send a message to a specific client. The |
24 | | -format of the message depends on the options selected in the NotificationMessage |
25 | | -and RestPostMediaType. A button, “Add Key/Value pair”, in this field may be |
26 | | -used to add more messages. |
27 | | - |
28 | | -**Authorization:** A list to select authorization type. Currently, only one |
29 | | -authorization type is provided which is “BASIC_AUTH”. The option “NO_AUTH” |
| 26 | +**NotificationMessage:** It is used to send a message to a specific client. The |
| 27 | +format of the message depends on the options selected in the NotificationMessage |
| 28 | +and RestPostMediaType. A button, “Add Key/Value pair”, in this field may be |
| 29 | +used to add more messages, if the selected RestPostBodyMediaType is FORM/POST |
| 30 | +parameters. |
| 31 | + |
| 32 | +**NotificationMeta:** Is the selected subscriber to notify when a subscription |
| 33 | +is triggered. It could be an email address such as `example@mail.com` or a url |
| 34 | +like `host.com/endpoint`. If you wish to trigger Jenkins job when a subscription |
| 35 | +is fulfilled then the url for the job could be set as the notificationMeta. |
| 36 | +Parameters such as a Jenkins job-token can be included in this field. |
| 37 | +**Note**: The job-token should not be mistaken for the API token that is |
| 38 | +used as a password for authentication against the entire jenkins instance. |
| 39 | + |
| 40 | +<img src="images/add_subscription_form2.png"> |
| 41 | +</img> |
| 42 | + |
| 43 | +**Authorization:** A list to select authorization type. Currently, only one |
| 44 | +authorization type is supported, which is “BASIC_AUTH”. The option “NO_AUTH” |
30 | 45 | implies that authorization is not required. |
31 | 46 |
|
32 | | -**Repeat:** It is possible to enable repeat, e.g. whether same subscription |
33 | | -should be re-triggered for new additions to the aggregated object. If disabled, |
34 | | -the notification will be triggered only the first time when conditions are |
35 | | -fulfilled. |
36 | | - |
37 | | -**Requirement:** It is used to add a requirement, which need to be fulfilled |
38 | | -before a subscription is triggered. Requirement is added in the form of a |
39 | | -condition (with a specific format). More than one conditions may be added under |
40 | | -one requirement by using “Add Condition” button. It should be noted that |
41 | | -conditions under one requirement are connected by logical “AND”. Thus all |
42 | | -conditions udder one requirement need to be satisfied before a subscription is |
43 | | -triggered. More than one requirements may be added by “Add Requirement” button. |
| 47 | +**Repeat:** It is possible to enable repeat, e.g. whether same subscription |
| 48 | +should be re-triggered for new additions to the aggregated object. If disabled, |
| 49 | +the notification will be triggered only the first time when conditions are |
| 50 | +fulfilled. |
| 51 | + |
| 52 | +**Requirement:** It is used to add a requirement, which need to be fulfilled |
| 53 | +before a subscription is triggered. Requirement is added in the form of a |
| 54 | +condition (with a specific format). More than one conditions may be added under |
| 55 | +one requirement by using “Add Condition” button. It should be noted that |
| 56 | +conditions under one requirement are connected by logical “AND”. Thus all |
| 57 | +conditions udder one requirement need to be satisfied before a subscription is |
| 58 | +triggered. More than one requirements may be added by “Add Requirement” button. |
44 | 59 | Requirements are connected by logical “OR”. |
0 commit comments