Changes for page Limitations of eMagiz definitions

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.eMagiz
	1	+XWiki.ebakker

Content

...	...	@@ -6,9 +6,6 @@
6	6
7	7	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
8	8
9		-* Last update: March 26th 2021
10		-* Required reading time: 5 minutes
11		-
12	12	== 1. Prerequisites ==
13	13
14	14	* Basic knowledge of the eMagiz platform
...	...	@@ -23,11 +23,11 @@
23	23
24	24	* Imported files cannot be larger than 1MB
25	25	* 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.
26	26	* Iterations (maxOccurs) over a threshold of 50 are not accepted
27	27	* Cross reference between entities that could lead to an infinite loop are not accepted
28	28
29		-
30		-
31	31	== 3. Limitations of eMagiz definitions ==
32	32
33	33	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.
...	...	@@ -35,7 +35,9 @@
35	35	Identifying and knowing about these restrictions will improve your decision making the moment you want to import your definition
36	36
37	37	* Imported files cannot be larger than 1MB
38		-* xs:all statements cannot be represented in the data model
	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.
39	39	* Iterations (maxOccurs) over a threshold of 50 are not accepted
40	40	* Cross reference between entities that could lead to an infinite loop are not accepted
41	41
...	...	@@ -54,37 +54,37 @@
54	54	* Write a custom XSLT that will transform the incoming message to a structured messages that you can validate via the tooling
55	55	* 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
56	56
57		-=== 3.3 Iterations (maxOccurs) over a threshold of 50 are not accepted ===
	56	+=== 3.3 ref statements cannot be represented in the data model ===
58	58
59		-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.
	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").
60	60
61		-=== 3.4 Cross reference between entities that could lead to an infinite loop are not accepted ===
	60	+=== 3.4 Choice statements cannot be represented in the data model ===
62	62
63		-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.
	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").
64	64
65		-== 4. Assignment ==
	64	+=== 3.5 Iterations (maxOccurs) over a threshold of 50 are not accepted ===
66	66
67		-Make sure that at least one of the attributes within one of your data models is set to Confidential
68		-This assignment can be completed within the Design phase of your (Academy) project that you have created/used in the previous assignment.
	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.
69	69
70		-== 5. Key takeaways ==
	68	+=== 3.6 Cross reference between entities that could lead to an infinite loop are not accepted ===
71	71
	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.
	71	+
	72	+== 4. Key takeaways ==
	73	+
72	72	Identifying and knowing about these restrictions will improve your decision making the moment you want to import your definition
73	73
74	74	* Imported files cannot be larger than 1MB
75		-* xs:all statements cannot be represented in the data model
	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.
76	76	* Iterations (maxOccurs) over a threshold of 50 are not accepted
77	77	* Cross reference between entities that could lead to an infinite loop are not accepted
78	78
	83	+== 5. Suggested Additional Readings ==
79	79
80		-
81		-== 6. Suggested Additional Readings ==
82		-
83	83	If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
84	84
85		-== 7. Silent demonstration video ==
86		-
87		-As this is a theoretical microlearning there is no video
88	88	)))
89	89
90	90	((({{toc/}}))){{/container}}