Skip to content

Commit a9effe4

Browse files
eandzabeandzab
eandzab
authored and
eandzab
committed
Removed <hr> and <br> since they caused page to not load
1 parent 6b983ec commit a9effe4

File tree

1 file changed

+22
-23
lines changed

1 file changed

+22
-23
lines changed

‎src/main/resources/templates/jmesPathRulesSetUp.html

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
</head>
1212
<body>
1313
<div class="container pull-left">
14-
<br/> <br/>
1514
<div align="center">
1615
<label>JMESPath Rules setup</label>
1716
</div>
@@ -46,7 +45,7 @@ <h3>Rule set up</h3>
4645
<p>Rules for object aggregation consist from JSON object with a defined structure inside it. Key in this object is rule specification and
4746
value is JMESPath identifier. Separate rule is created for each event type that is going to take participation in creating of aggregated
4847
object. This means that if you want to create your aggregated object from 3 event types and all rest event types discard, you will need 3
49-
set of rules. Each rule might contain some of these keys, that have not null or empty values. Explicit list of rule keys are bellow:
48+
set of rules. Each rule might contain some of these keys, that have not null or empty values. Explicit list of rule keys are bellow:</p>
5049
<ul>
5150
<li><code>"TemplateName"</code> - used for specifying a template group, any string you like to name your template</li>
5251
<li><code>"Type"</code> - Eiffel event <a href="https://github.com/Ericsson/eiffel/tree/master/eiffel-vocabulary">type</a>,
@@ -68,10 +67,10 @@ <h3>Rule set up</h3>
6867
<li><code>"MatchIdRules"</code> - denotes the received event id of the object, example <code>"%IdentifyRules_objid%"</code></li>
6968
<li><code>"IdentifyRules"</code> - JMESPath identifier of event id that will be used in aggregated object. Should produce an JSON array,
7069
for example <code>"[meta.id]"</code> which will return the specified field in array
71-
<code>["sb6e51h0-25ch-4dh7-b9sd-876g8e6kde47"]</code>.<br>
70+
<code>["sb6e51h0-25ch-4dh7-b9sd-876g8e6kde47"]</code>.
7271
And other common example is
7372
<code>"links | [?type=='CAUSE'].target"</code> which will extract the event id from <code>links</code> array value of
74-
<code>target</code>, where "type" is equal "CAUSE". <br>
73+
<code>target</code>, where "type" is equal "CAUSE".
7574
Links look like <code>{"links": [
7675
{
7776
"target": "f37d59a3-069e-4f4c-8cc5-a52e73501a75",
@@ -94,12 +93,12 @@ <h3>Rule set up</h3>
9493
to the inner structure of aggregated object depending on MergeResolverRules.
9594
</li>
9695
<li><code>"MergeResolverRules"</code> - JMESPath identifier of the place where to insert the JSON object form "ExtractionRules".
97-
If MergeResolverRules is <code>null</code> ExtractionRules object will be inserted to the root of aggregated object.<br>
96+
If MergeResolverRules is <code>null</code> ExtractionRules object will be inserted to the root of aggregated object.
9897
Other example is <code>"[{NONEPATH:NONE}, {test_suite: [{ test_case : [{ trigger_event_id:meta.id}]} ]} ]"</code> which consists from
9998
array with two fields, first is expression <code>{NONEPATH:NONE}</code> that <strong>should not exist</strong> in aggregated object,
10099
actually it could be any words you like.
101100
Second part is <code>{test_suite: [{ test_case : [{ trigger_event_id:meta.id}]}</code> that will form a new JSON object that will be
102-
inserted to the aggregated object after evaluation of "meta.id".<br>
101+
inserted to the aggregated object after evaluation of "meta.id".
103102
Another example could be insertion of object obtained in "ExtractionRules" to the array element that has <code>trigger_event_id</code>
104103
matching the event id target field from incoming event "TEST_CASE_EXECUTION" link JSON object.
105104
</li>
@@ -128,17 +127,17 @@ <h3>Rule set up</h3>
128127
<li><code>"ProcessFunction"</code> - Reserved for future use.</li>
129128

130129
</ul>
131-
</p>
132-
<hr>
130+
131+
133132
<h3>The most common operation you would do</h3>
134133

135134
<h4>Creating new aggregated object from Eiifel event</h4>
136135
<p>Lets consider that aggregated object should be created on receiving the EiffelArtifactCreated event, and it should form the aggregated object
137136
from the received event. Aggregated object should contain fields "id", "artifactId", and "temp", where id will be extracted from the received
138-
event field "id", artifactId will be extracted from the this event too and temp will be set to true.
139-
<details>
140-
<summary>EiffelArtifactCreatedEvent example, click to unfold</summary>
141-
<pre>
137+
event field "id", artifactId will be extracted from the this event too and temp will be set to true.</p>
138+
<details>
139+
<summary>EiffelArtifactCreatedEvent example, click to unfold</summary>
140+
<pre>
142141
{
143142
"meta":{
144143
"id":"66208918-4422-42cb-a0bf-17b15d1043d2",
@@ -189,9 +188,9 @@ <h4>Creating new aggregated object from Eiifel event</h4>
189188

190189
]
191190
}</pre>
192-
</details>
193-
So we need to form a set of basic rules for Eiffel event that will fulfill our aggregated object.
194-
Keep in mind that we are adding to the root of aggregated object so no need to specify MergeResolverRules.
191+
</details>
192+
<p>So we need to form a set of basic rules for Eiffel event that will fulfill our aggregated object.
193+
Keep in mind that we are adding to the root of aggregated object so no need to specify MergeResolverRules.</p>
195194
<pre>
196195
{
197196
"TemplateName":"ARTIFACT_1",
@@ -217,8 +216,8 @@ <h4>Creating new aggregated object from Eiifel event</h4>
217216
"TemplateName":"ARTIFACT_1"
218217
}
219218
}</pre>
220-
</p>
221-
<hr>
219+
220+
222221

223222
<h4>Inserting a JSON array to aggregated object</h4>
224223
<p>Lets consider that on receiving of EiffelConfidenceLevelModifiedEvent message, confidence levels array should be inserted to the aggregated
@@ -241,7 +240,7 @@ <h4>Inserting a JSON array to aggregated object</h4>
241240
array is located. Each element of array is valid JSON object. There are key-value pairs in this array, and in one of those there is a key
242241
<code>"type"</code> and value is
243242
<code>"SUBJECT"</code> and we need to extract the value of <code>"target"</code> which will be our id for aggreagated object.
244-
Such identifier for that is placed in <code>"IdentifyRules":"links | [?type=='SUBJECT'].target"</code>.<br>
243+
Such identifier for that is placed in <code>"IdentifyRules":"links | [?type=='SUBJECT'].target"</code>.
245244
At this point we know the needed aggregated object id and now we need to specify the desired location for confidence level information.
246245
Lets move the data obtained in "ExtractionRules" under <code>"confidenceLevels"</code> key in the root of aggregated object and the value
247246
of it should be array. The identifier for such expression will be <code>{confidenceLevels: [{ eventId: meta.id }]}</code>. To insert the
@@ -370,13 +369,13 @@ <h4>Inserting a JSON array to aggregated object</h4>
370369
</pre>
371370
</details>
372371

373-
<hr>
372+
374373
<h4>Updating array of JSON objects where the some field is pointing to Eiffel message id</h4>
375374

376375
<p>Lets consider that on receiving EiffelTestCaseStartedEvent message we need to update the array object, which has
377376
in the <code>"TEST_CASE_EXECUTION"</code> link type id, that
378377
matches aggregated object and the data in that JSON object need to be updated. As a result of applying the rule, field ongoing in aggregated
379-
object will change the value from <code>{
378+
object will change the value from <code>{
380379
"ongoing":"false",
381380
"test_data":null,
382381
"trigger_event_id":"v46ef19d-20gb-4d2y-h9fa-87dada6kde47"
@@ -499,7 +498,7 @@ <h4>Updating array of JSON objects where the some field is pointing to Eiffel me
499498
}</pre>
500499
</details>
501500

502-
<hr>
501+
503502

504503
<h4>Upstream events</h4>
505504
<p>Under upstream events to some specified event in Eiffel we mean those event that were processed/issued before or were the cause to
@@ -509,7 +508,7 @@ <h4>Upstream events</h4>
509508
EiffelSourceChangeSubmittedEvent, EiffelArtifactCreatedEvent, EiffelArtifactPublishedEvent, so the upstream event for
510509
EiffelArtifactCreatedEvent will be EiffelSourceChangeCreatedEvent andEiffelSourceChangeSubmittedEvent.
511510
</p>
512-
<hr>
511+
513512

514513
<h4>Downstream events</h4>
515514
<p>Under downstream events to some specified event in Eiffel we mean those event that will be issued after or were the outcome to
@@ -519,7 +518,7 @@ <h4>Downstream events</h4>
519518
EiffelSourceChangeSubmittedEvent, EiffelArtifactCreatedEvent, EiffelArtifactPublishedEvent, so the downstream event for
520519
EiffelArtifactCreatedEvent will be EiffelArtifactPublishedEvent.
521520
</p>
522-
<hr>
521+
523522

524523

525524
<p>Rule examples</p>

0 commit comments

Comments
 (0)