You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
// headers for the HTTP request, can be 'application/x-www-form-urlencoded' or 'application/json'
44
+
// Headers for the HTTP request, can be 'application/x-www-form-urlencoded' or 'application/json'.
40
45
"restPostBodyMediaType" : "application/json",
41
46
42
-
// the data to send with the HTTP POST request
47
+
// The data to send with the HTTP POST request.
43
48
"notificationMessageKeyValues" : [
44
49
{
45
-
// form value will be run through JMESPATH engine to extract
46
-
// content from aggregated object.
50
+
// The form value will be run through JMESPATH engine to extract
51
+
// content from the aggregated object.
47
52
48
53
"formkey" : "json",
49
54
"formvalue" : "{parameter: [{ name: 'jsonparams', value : to_string(@) }]}"
@@ -67,3 +72,9 @@ _**Subscription templates can be found [here](https://github.com/Ericsson/eiffel
67
72
68
73
]
69
74
}
75
+
76
+
77
+
## Requirements and conditions
78
+
79
+
Read more on how Eiffel Intelligence groups [requirements and conditions in subscriptions](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/subscriptions.md#writing-requirements-and-conditions).
// An array of requirements. At least one requirement should be fulfilled to
50
50
// trigger this subscription.
51
51
"requirements" : [
@@ -63,3 +63,18 @@ _**Subscription templates can be found [here](https://github.com/Ericsson/eiffel
63
63
]
64
64
}
65
65
66
+
## Enabling e-mail notification for Eiffel Intelligence
67
+
68
+
In order to use subscriptions with e-mail notifications, Eiffel Intelligence
69
+
must be set up with an e-mail server in [application.properties](https://github.com/eiffel-community/eiffel-intelligence/blob/master/src/main/resources/application.properties).
70
+
The e-mail subject for a subscription can be set globally or for each individual
71
+
subscription. If the field emailSubject is left empty in the subscription, Eiffel
72
+
Intelligence will use the default one.
73
+
74
+
## Requirements and conditions
75
+
76
+
Read more on how Eiffel Intelligence groups [requirements and conditions in subscriptions](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/subscriptions.md#writing-requirements-and-conditions).
Copy file name to clipboardExpand all lines: wiki/markdown/triggering-jenkins-jobs.md
+43-28Lines changed: 43 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -10,40 +10,46 @@ There are some important details to know when triggering Jenkins jobs with param
10
10
* the parameters need to be send in the URL
11
11
* do not specify more parameters than you have in your job. This is a Jenkins security feature to hinder that someone triggers jobs that overwrite job environment variables. Your job will not be triggered otherwise.
12
12
13
-
Example below shows a subscription that triggers a parameterized Jenkins job having job token and a parameter object containing the aggregated object.
14
-
Observe that we use buildWithParameters and empty notificationMessageKeyValues.
13
+
Example below shows a subscription that triggers a parameterized Jenkins job having job token and a parameter object containing the aggregated object.
14
+
Observe that we use buildWithParameters and empty notificationMessageKeyValues.
15
15
16
16
{
17
+
// The name of the subscription to make it easy to search for it.
18
+
// Only numbers,letters and underscore allowed.
17
19
"subscriptionName" : "Subscription1",
18
20
19
-
// the name of the user who created the subscription
20
-
// defaults to an empty string if LDAP is disabled
21
+
// The name of the logged in user creating or updating the subscription
22
+
// added by Eiffel Intelligence if LDAP is enabled. Defaults to an empty string.
21
23
"ldapUserName" : "ABC",
22
24
23
-
// instructs whether same subscription should be re-triggered for new additions
24
-
// to the aggregated object. If false only first time the conditions are fulfilled
25
-
// a notification will be triggered. No matter how many times the aggregated object
26
-
// is updated.
25
+
// Instructs whether the same subscription should be re-triggered
26
+
// for new additions to the aggregated object. If this is set to
27
+
// false, only the first time the conditions are fulfilled, a
28
+
// notification will be triggered. No matter how many times the
29
+
// aggregated object is updated.
27
30
"repeat" : false,
28
-
"notificationMessageKeyValuesAuth" : [],
31
+
32
+
// Creation time in system time, added by Eiffel Intelligence.
29
33
"created" : 1542117412833,
30
34
31
-
// how to notify when a subscription is triggered
32
-
"notificationType" : "REST_POST",
35
+
"notificationMessageKeyValuesAuth" : [],
33
36
"authenticationType" : "BASIC_AUTH",
34
37
35
-
// the username and password to insert in headers of the POST request when sending
36
-
// a notification via REST POST
38
+
// The username and password to insert in headers of the POST request when sending
39
+
// a notification via REST POST.
37
40
"userName" : "functionalUser",
38
41
"password" : "functionalUserPassword",
39
42
40
-
// which url to use for the HTTP POST request
43
+
// How to notify when a subscription is triggered.
// headers for the HTTP request, can be 'application/x-www-form-urlencoded' or 'application/json'
49
+
// Headers for the HTTP request, can be 'application/x-www-form-urlencoded' or 'application/json'.
44
50
"restPostBodyMediaType" : "application/json",
45
51
46
-
// the data to send with the HTTP POST request
52
+
// The data to send with the HTTP POST request.
47
53
"notificationMessageKeyValues" : [
48
54
{
49
55
}
@@ -74,39 +80,43 @@ There are some important details to know when triggering Jenkins jobs with param
74
80
The subscription below triggers the same parameterized Jenkins job but we now use build endpoint and we send the parameter in a json form using REST body.
75
81
76
82
{
83
+
// The name of the subscription to make it easy to search for it.
84
+
// Only numbers, letters and underscore allowed.
77
85
"subscriptionName" : "Subscription1",
78
86
79
-
// the name of the user who created the subscription
80
-
// defaults to an empty string if LDAP is disabled
87
+
// The name of the logged in user creating or updating the subscription
88
+
// added by Eiffel Intelligence if LDAP is enabled. Defaults to an empty string.
81
89
"ldapUserName" : "ABC",
82
90
83
-
// instructs whether same subscription should be re-triggered for new additions
91
+
// Instructs whether same subscription should be re-triggered for new additions
84
92
// to the aggregated object. If false only first time the conditions are fulfilled
85
93
// a notification will be triggered. No matter how many times the aggregated object
86
94
// is updated.
87
95
"repeat" : false,
88
-
"notificationMessageKeyValuesAuth" : [],
96
+
97
+
// Creation time in system time, added by Eiffel Intelligence.
89
98
"created" : 1542117412833,
90
99
91
-
// how to notify when a subscription is triggered
92
-
"notificationType" : "REST_POST",
93
100
"authenticationType" : "BASIC_AUTH",
94
101
95
-
// the username and password to insert in headers of the POST request when sending
96
-
// a notification via REST POST
102
+
// How to notify when a subscription is triggered.
103
+
"notificationType" : "REST_POST",
104
+
105
+
// The username and password to insert in headers of the POST request when sending
// headers for the HTTP request, can be 'application/x-www-form-urlencoded' or 'application/json'
113
+
// Headers for the HTTP request, can be 'application/x-www-form-urlencoded' or 'application/json'.
104
114
"restPostBodyMediaType" : "application/json",
105
115
106
-
// the data to send with the HTTP POST request
116
+
// The data to send with the HTTP POST request.
107
117
"notificationMessageKeyValues" : [
108
118
{
109
-
// form value will be run through JMESPATH engine to extract
119
+
// The form value will be run through JMESPATH engine to extract
110
120
// content from aggregated object.
111
121
112
122
"formkey" : "json",
@@ -131,3 +141,8 @@ There are some important details to know when triggering Jenkins jobs with param
131
141
132
142
]
133
143
}
144
+
145
+
## Requirements and conditions
146
+
147
+
Read more on how Eiffel Intelligence groups [requirements and conditions in subscriptions](https://github.com/eiffel-community/eiffel-intelligence/blob/master/wiki/markdown/subscriptions.md#writing-requirements-and-conditions).
0 commit comments