Skip to Content
Last modified by Danniar Firdausy on 2024/09/16 14:32
From version 6.3
edited by Danniar Firdausy
on 2024/09/03 10:43
Change comment: There is no comment for this version
To version 1.2
edited by eMagiz
on 2022/06/08 13:19
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Limitations of eMagiz definitions
1 +intermediate-defining-your-message-structures-limitations-of-emagiz-definitions
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.dfirdausy
1 +XWiki.marijn
Content
... ... @@ -1,11 +1,20 @@
1 -{{container}}
2 -{{container layoutStyle="columns"}}
3 -(((
1 +{{html wiki="true"}}
2 +<div class="ez-academy">
3 + <div class="ez-academy_body">
4 4  
5 +<div class="doc">
6 +
7 +
8 +
9 += Limitations of eMagiz definitions =
10 +
5 5  In this microlearning, we will focus on certain limitations when importing your definition in eMagiz. It is necessary to understand these limitations in order to make the correct choices before importing your definition into eMagiz.
6 6  
7 -Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
13 +Should you have any questions, please contact academy@emagiz.com.
8 8  
15 +* Last update: March 26th 2021
16 +* Required reading time: 5 minutes
17 +
9 9  == 1. Prerequisites ==
10 10  
11 11  * Basic knowledge of the eMagiz platform
... ... @@ -20,11 +20,11 @@
20 20  
21 21  * Imported files cannot be larger than 1MB
22 22  * xs:all statements cannot be represented in the data model.
23 -* ref statements cannot be represented in the data model.
24 -* choice constructs cannot be represented in the data model.
25 25  * Iterations (maxOccurs) over a threshold of 50 are not accepted
26 26  * Cross reference between entities that could lead to an infinite loop are not accepted
27 27  
35 +
36 +
28 28  == 3. Limitations of eMagiz definitions ==
29 29  
30 30  In this microlearning, we will focus on certain limitations when importing your definition in eMagiz. It is necessary to understand these limitations in order to make the correct choices before importing your definition into eMagiz.
... ... @@ -32,13 +32,11 @@
32 32  Identifying and knowing about these restrictions will improve your decision making the moment you want to import your definition
33 33  
34 34  * Imported files cannot be larger than 1MB
35 -* xs:all statements cannot be represented in the data model.
36 -* ref statements cannot be represented in the data model.
37 -* choice constructs cannot be represented in the data model.
44 +* xs:all statements cannot be represented in the data model
38 38  * Iterations (maxOccurs) over a threshold of 50 are not accepted
39 39  * Cross reference between entities that could lead to an infinite loop are not accepted
40 40  
41 -Below we will specify per limitations what this exactly means
48 +Below we will specify per limiations what this exactly means
42 42  
43 43  === 3.1 Imported files cannot be larger than 1MB ===
44 44  
... ... @@ -53,41 +53,43 @@
53 53  * Write a custom XSLT that will transform the incoming message to a structured messages that you can validate via the tooling
54 54  * Use a custom XSD as validation and use the standard eMagiz tooling for your transformation, whereby you assume that your system definition has a defined structure
55 55  
56 -=== 3.3 ref statements cannot be represented in the data model ===
63 +=== 3.3 Iterations (maxOccurs) over a threshold of 50 are not accepted ===
57 57  
58 -As specified before in earlier microlearnings, eMagiz defines the expected structure with the help of data models. Within a data model you need to specify the association between entities. In XSD terminology this is represented as follows <xs:element type="itemsType" name="items"/>. However, sometimes we see a different notation that is not working when importing an XSD in eMagiz. This notation is <xs:group ref="status_group" />. To get this in you need to rewrite the association in your XSD a bit to reflect the first notation and mention that the assocation is optional (minOccurs="0").
65 +To prevent weird results when it comes to the creation of data models we do not accept maxOccurs above 50. To succesfully import your definition you should change the maxOccurs setting to unbounded. This way eMagiz will succesfully import the definition. As of today we have never encountered a practical case where this caused issues.
59 59  
60 -=== 3.4 Choice statements cannot be represented in the data model ===
67 +=== 3.4 Cross reference between entities that could lead to an infinite loop are not accepted ===
61 61  
62 -As specified before in earlier microlearnings, eMagiz defines the expected structure with the help of data models. Within a data model you need to specify the association between entities and order within these entities. In XSD terminology this is represented as follows <xs:complexType><xs:element name="employee" type="employee"/><xs:element name="member" type="member"/></xs:complexType>. However, sometimes we see that a choice is offered in the XSD. This notation means that you can supply A or B. This notation is <xs:complexType><xs:choice><xs:element name="employee" type="employee"/><xs:element name="member" type="member"/></xs:choice></xs:complexType>. To get this in you need to remove the reference to the <xs:choice> and the </xs:choice> lines in your XSD and make each element within the choice optional (minOccurs="0").
69 +In some cases we see definitions in which entities keep referecing each other. This could cause an infinite loop to occur when trying to build up the correct structure of your system message. Therefore we do an initial check when importing your file to safeguard ourselves against creating infinite loops in our portal that will in the end break the eMagiz portal.
63 63  
64 -=== 3.5 Iterations (maxOccurs) over a threshold of 50 are not accepted ===
71 +===== Practice =====
65 65  
66 -To prevent weird results when it comes to the creation of data models we do not accept maxOccurs above 50. To succesfully import your definition you should change the maxOccurs setting to unbounded. This way eMagiz will succesfully import the definition. As of today we have never encountered a practical case where this caused issues.
73 +== 4. Assignment ==
67 67  
68 -=== 3.6 Cross reference between entities that could lead to an infinite loop are not accepted ===
75 +Make sure that at least one of the attributes within one of your data models is set to Confidential
76 +This assignment can be completed within the Design phase of your (Academy) project that you have created/used in the previous assignment.
69 69  
70 -In some cases we see definitions in which entities keep referecing each other. This could cause an infinite loop to occur when trying to build up the correct structure of your system message. Therefore we do an initial check when importing your file to safeguard ourselves against creating infinite loops in our portal that will in the end break the eMagiz portal.
78 +== 5. Key takeaways ==
71 71  
72 -== 4. Key takeaways ==
73 -
74 74  Identifying and knowing about these restrictions will improve your decision making the moment you want to import your definition
75 75  
76 76  * Imported files cannot be larger than 1MB
77 -* xs:all statements cannot be represented in the data model.
78 -* ref statements cannot be represented in the data model.
79 -* choice constructs cannot be represented in the data model.
83 +* xs:all statements cannot be represented in the data model
80 80  * Iterations (maxOccurs) over a threshold of 50 are not accepted
81 81  * Cross reference between entities that could lead to an infinite loop are not accepted
82 82  
83 -== 5. Suggested Additional Readings ==
84 84  
85 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz and see the following links:
86 86  
87 -* [[Definition Limitations (Search Results)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&l_space_facet=10&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=%22definition+limitations%22||target="blank"]]
89 +== 6. Suggested Additional Readings ==
88 88  
89 -)))
91 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
90 90  
91 -((({{toc/}}))){{/container}}
92 -{{/container}}
93 +== 7. Silent demonstration video ==
93 93  
95 +As this is a theoretical microlearning there is no video
96 +
97 +</div>
98 +
99 +</div>
100 +</div>
101 +
102 +{{/html}}