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.dfirdausy

Content

...	...	@@ -2,7 +2,7 @@
2	2	{{container layoutStyle="columns"}}
3	3	(((
4	4
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.
	5	+In this microlearning, we will delve into some crucial limitations you will need to be aware of when importing your definitions into eMagiz. Understanding these constraints will help you make informed decisions and avoid potential issues.
6	6
7	7	Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
8	8
...	...	@@ -12,29 +12,22 @@
12	12
13	13	== 2. Key concepts ==
14	14
15		-This microlearning centers around learning which limitations you need to take into account when importing your definition
16		-With eMagiz definitions we mean: Structured data models that represent how a message should look like at a certain point in the flow
17		-With limitations we mean: Restrictions of what will and what won't work when importing your definitions
	15	+This microlearning centers around learning which limitations you need to take into account when importing your definition.
	16	+* With eMagiz definitions we mean: Structured data models that represent how a message should look like at a certain point in the flow
	17	+* With limitations we mean: Restrictions of what will and what won't work when importing your definitions
18	18
19		-Identifying and knowing about these restrictions will improve your decision making the moment you want to import your definition
20		-
21		-* Imported files cannot be larger than 1MB
22		-* xs:all statements cannot be represented in the data model.
23		-* Iterations (maxOccurs) over a threshold of 50 are not accepted
24		-* Cross reference between entities that could lead to an infinite loop are not accepted
25		-
26	26	== 3. Limitations of eMagiz definitions ==
27	27
28		-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.
	21	+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. Identifying and knowing about these restrictions will improve your decision making the moment you want to import your definition
29	29
30		-Identifying and knowing about these restrictions will improve your decision making the moment you want to import your definition
31		-
32	32	* Imported files cannot be larger than 1MB
33		-* xs:all statements cannot be represented in the data model
	24	+* xs:all statements cannot be represented in the data model.
	25	+* ref statements cannot be represented in the data model.
	26	+* choice constructs cannot be represented in the data model.
34	34	* Iterations (maxOccurs) over a threshold of 50 are not accepted
35	35	* Cross reference between entities that could lead to an infinite loop are not accepted
36	36
37		-Below we will specify per limiations what this exactly means
	30	+Below we will specify per limitations what this exactly means.
38	38
39	39	=== 3.1 Imported files cannot be larger than 1MB ===
40	40
...	...	@@ -49,35 +49,41 @@
49	49	* Write a custom XSLT that will transform the incoming message to a structured messages that you can validate via the tooling
50	50	* 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
51	51
52		-=== 3.3 Iterations (maxOccurs) over a threshold of 50 are not accepted ===
	45	+=== 3.3 ref statements cannot be represented in the data model ===
53	53
54		-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.
	47	+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").
55	55
56		-=== 3.4 Cross reference between entities that could lead to an infinite loop are not accepted ===
	49	+=== 3.4 Choice statements cannot be represented in the data model ===
57	57
58		-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.
	51	+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").
59	59
60		-== 4. Assignment ==
	53	+=== 3.5 Iterations (maxOccurs) over a threshold of 50 are not accepted ===
61	61
62		-Make sure that at least one of the attributes within one of your data models is set to Confidential
63		-This assignment can be completed within the Design phase of your (Academy) project that you have created/used in the previous assignment.
	55	+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.
64	64
65		-== 5. Key takeaways ==
	57	+=== 3.6 Cross reference between entities that could lead to an infinite loop are not accepted ===
66	66
67		-Identifying and knowing about these restrictions will improve your decision making the moment you want to import your definition
	59	+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.
68	68
69		-* Imported files cannot be larger than 1MB
70		-* xs:all statements cannot be represented in the data model
71		-* Iterations (maxOccurs) over a threshold of 50 are not accepted
72		-* Cross reference between entities that could lead to an infinite loop are not accepted
	61	+== 4. Key takeaways ==
73	73
74		-== 6. Suggested Additional Readings ==
	63	+* File Size Limit: Imported files must be 1MB or smaller to ensure system stability. For larger files, please contact your partner manager for a tailored solution.
	64	+* No xs:all Statements: eMagiz cannot process xs:all statements which allow elements in any order. Convert these to xs:sequence to ensure compatibility.
	65	+* No ref Statements: ref statements for element references aren't supported. Use explicit element definitions instead.
	66	+* No choice Constructs: eMagiz does not support xs:choice constructs. Modify your schema to make elements optional rather than using choices.
	67	+* Max Occurrences Limit: maxOccurs values over 50 are not accepted. Adjust to unbounded if needed for successful import.
	68	+* Avoid Infinite Loops: Cross-references between entities that may create infinite loops are not allowed. Ensure your definitions avoid such structures.
75	75
76		-If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
	70	+== 5. Suggested Additional Readings ==
77	77
78		-== 7. Silent demonstration video ==
	72	+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:
79	79
80		-As this is a theoretical microlearning there is no video
	74	+* [[Crash Courses (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.WebHome||target="blank"]]
	75	+** [[Crash Course Platform (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.WebHome||target="blank"]]
	76	+*** [[Creating a message definition (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-creating-a-message-definition||target="blank"]]
	77	+*** [[Importing a message definition (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.crashcourse-platform-design-import-message-definition||target="blank"]]
	78	+* [[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=%22limitations%22||target="blank"]]
	79	+
81	81	)))
82	82
83	83	((({{toc/}}))){{/container}}