Data Model Compiler - Revision history

Dgreenwood: /* Exposing parent and sibling data */

2025-12-17T16:17:41Z

Exposing parent and sibling data

← Older revision		Revision as of 11:17, 17 December 2025
Line 33:		Line 33:

	<big>Child Of</big>		<big>Child Of</big>
	:~~When~~ a Content ~~Type is configured with a "Child Of" parent~~, all ~~data elements~~ from ~~the~~ parent ~~type are made~~ available in expressions ~~within the child~~. This allows you to reference parent fields directly in validation rules, calculated values, export mappings, and other expressions. For example, if a "Benefits Change Form" is a child of "Personnel File", you can reference Personnel_File.Employee_ID in any expression on the child.		:Configuring a Content Type’s “Child Of” property, makes all Data Elements from a parent document available in a child document’s expressions. This allows you to reference parent fields directly in validation rules, calculated values, export mappings, and other expressions. For example, if a "Benefits Change Form" is a child of "Personnel File", you can reference Personnel_File.Employee_ID in any expression on the child.
	:* Use for multi-level Batch structures where parent-child Batch Folder relationships are required.		:* Use for multi-level Batch structures where parent-child Batch Folder relationships are required.
	:* Enables export and processing logic to include data from parent elements.		:* Enables export and processing logic to include data from parent elements.
Line 57:		Line 57:

	<big>Sibling Of</big>		<big>Sibling Of</big>
	: ~~Setting the~~ "Sibling Of" property makes the Data Elements of ~~the sibling~~ Content Types directly accessible in the expression environment ~~of this type~~. This means you can reference fields, sections, or tables from sibling types in calculated values, validation rules, or export mappings. ~~For example, if~~ "~~Type A~~" is ~~a sibling of "Type B", expressions in "Type A" can reference data from "Type B"~~ using ~~the syntax Type_B.FieldName~~.		: Configuring a Content Type’s "Sibling Of" property makes the Data Elements of “sibling” Content Types (assigned as Secondary Types to the document) directly accessible in the expression environment for the Content Type. This means you can reference fields, sections, or tables from sibling types in calculated values, validation rules, or export mappings.
			:* The "Sibling Of" property is for scenarios using Secondary Types.
	:* Use "Sibling Of" when a document (Batch Folder) has one or more Secondary Types assigned and must be treated as multiple Document Types for extraction, validation, or export.		:* Use "Sibling Of" when a document (Batch Folder) has one or more Secondary Types assigned and must be treated as multiple Document Types for extraction, validation, or export.
	:* The "Sibling Of" property should list Content Types are expected to be assigned alongside this type on the same Batch Folder, using Secondary Type assignments.		:* The "Sibling Of" property should list Content Types are expected to be assigned alongside this type on the same Batch Folder, using Secondary Type assignments.

Dgreenwood: /* Exposing parent and sibling data */

2025-12-17T16:06:32Z

Exposing parent and sibling data

← Older revision		Revision as of 11:06, 17 December 2025
Line 64:		Line 64:
	:* Avoid circular or redundant sibling assignments, as this can complicate configuration and data access logic.		:* Avoid circular or redundant sibling assignments, as this can complicate configuration and data access logic.

	Example: "Type A" is a sibling of "Type B"		:Example: "Type A" is a sibling of "Type B"
	* Expressions written for "Type A" documents can reference data from the "Type B" Data Model.		:* Expressions written for "Type A" documents can reference data from the "Type B" Data Model.
	* Use the syntax <code>Type_B.FieldName</code>		:* Use the syntax <code>Type_B.FieldName</code>

Dgreenwood: /* Exposing parent and sibling data */

2025-12-17T16:05:47Z

Exposing parent and sibling data

← Older revision		Revision as of 11:05, 17 December 2025
Line 48:		Line 48:
	:*:::: {{IconName\|Data Field}} Request_Date		:*:::: {{IconName\|Data Field}} Request_Date
	:*:::: {{IconName\|Data Field}} Change_Reason		:*:::: {{IconName\|Data Field}} Change_Reason
	:* Batch ~~strcutre~~:		:* Batch structure:
	:*: {{IconName\|Batch}} Batch		:*: {{IconName\|Batch}} Batch
	:*:: {{IconName\|Batch Folder}} Personnel File (Batch Folder)		:*:: {{IconName\|Batch Folder}} Personnel File (Batch Folder)

Dgreenwood: /* Exposing parent and sibling data */

2025-12-17T16:05:24Z

Exposing parent and sibling data

← Older revision		Revision as of 11:05, 17 December 2025
Line 63:		Line 63:
	:* Sibling relationships are '''not''' hierarchical; all Content Types listed are considered peers for the purposes of data access and processing.		:* Sibling relationships are '''not''' hierarchical; all Content Types listed are considered peers for the purposes of data access and processing.
	:* Avoid circular or redundant sibling assignments, as this can complicate configuration and data access logic.		:* Avoid circular or redundant sibling assignments, as this can complicate configuration and data access logic.

			Example: "Type A" is a sibling of "Type B"
			* Expressions written for "Type A" documents can reference data from the "Type B" Data Model.
			* Use the syntax <code>Type_B.FieldName</code>


	<big>Relative Of</big>		<big>Relative Of</big>

Dgreenwood: /* Exposing parent and sibling data */

2025-10-02T13:15:55Z

Exposing parent and sibling data

← Older revision		Revision as of 08:15, 2 October 2025
Line 32:		Line 32:
	The "Child Of", "Sibling Of" and "Relative Of" properties on Content Type (i.e. [[Document Type]]) enable advanced data access scenarios by exposing related data elements to the expression environment of a Data Model.		The "Child Of", "Sibling Of" and "Relative Of" properties on Content Type (i.e. [[Document Type]]) enable advanced data access scenarios by exposing related data elements to the expression environment of a Data Model.

	;Child Of:		<big>Child Of</big>
	:When a Content Type is configured with a "Child Of" parent, all data elements from the parent type are made available in expressions within the child. This allows you to reference parent fields directly in validation rules, calculated values, export mappings, and other expressions. For example, if a "Benefits Change Form" is a child of "Personnel File", you can reference Personnel_File.Employee_ID in any expression on the child.		:When a Content Type is configured with a "Child Of" parent, all data elements from the parent type are made available in expressions within the child. This allows you to reference parent fields directly in validation rules, calculated values, export mappings, and other expressions. For example, if a "Benefits Change Form" is a child of "Personnel File", you can reference Personnel_File.Employee_ID in any expression on the child.
	:* Use for multi-level Batch structures where parent-child Batch Folder relationships are required.		:* Use for multi-level Batch structures where parent-child Batch Folder relationships are required.
Line 56:		Line 56:
	:* For example, when the Benefits Change Form is exported it could utilize the "Employee_Name" value of its parent in its Export Mappings.		:* For example, when the Benefits Change Form is exported it could utilize the "Employee_Name" value of its parent in its Export Mappings.

	;Sibling Of:		<big>Sibling Of</big>
	: Setting the "Sibling Of" property makes the Data Elements of the sibling Content Types directly accessible in the expression environment of this type. This means you can reference fields, sections, or tables from sibling types in calculated values, validation rules, or export mappings. For example, if "Type A" is a sibling of "Type B", expressions in "Type A" can reference data from "Type B" using the syntax Type_B.FieldName.		: Setting the "Sibling Of" property makes the Data Elements of the sibling Content Types directly accessible in the expression environment of this type. This means you can reference fields, sections, or tables from sibling types in calculated values, validation rules, or export mappings. For example, if "Type A" is a sibling of "Type B", expressions in "Type A" can reference data from "Type B" using the syntax Type_B.FieldName.
	:* Use "Sibling Of" when a document (Batch Folder) has one or more Secondary Types assigned and must be treated as multiple Document Types for extraction, validation, or export.		:* Use "Sibling Of" when a document (Batch Folder) has one or more Secondary Types assigned and must be treated as multiple Document Types for extraction, validation, or export.
Line 64:		Line 64:
	:* Avoid circular or redundant sibling assignments, as this can complicate configuration and data access logic.		:* Avoid circular or redundant sibling assignments, as this can complicate configuration and data access logic.

	;Relative Of:		<big>Relative Of</big>
	:The "Relative Of" property defines a set of related Content Types whose data elements are exposed in the expression environment of this type. Unlike "Child Of" (which establishes a strict parent-child relationship) or "Sibling Of" (which exposes data from peer Secondary Types on the same Batch Folder), "Relative Of" is used for scenarios where related Content Types may appear as siblings, ancestors, or in varying positions within the Batch structure, but their data should always be available for reference in expressions, validation, or export logic.		:The "Relative Of" property defines a set of related Content Types whose data elements are exposed in the expression environment of this type. Unlike "Child Of" (which establishes a strict parent-child relationship) or "Sibling Of" (which exposes data from peer Secondary Types on the same Batch Folder), "Relative Of" is used for scenarios where related Content Types may appear as siblings, ancestors, or in varying positions within the Batch structure, but their data should always be available for reference in expressions, validation, or export logic.
	:* Use "Relative Of" when the Content Type could be a parent or a sibling.		:* Use "Relative Of" when the Content Type could be a parent or a sibling.

Dgreenwood: /* Exposing parent and sibling data */

2025-10-02T13:14:49Z

Exposing parent and sibling data

← Older revision		Revision as of 08:14, 2 October 2025
Line 37:		Line 37:
	:* Enables export and processing logic to include data from parent elements.		:* Enables export and processing logic to include data from parent elements.
	:* The selected parent cannot be a descendant or ancestor of this type.		:* The selected parent cannot be a descendant or ancestor of this type.
	~~<br>~~
	: '''Example:''' Examine the Content Type structure and the Batch structure below.		: '''Example:''' Examine the Content Type structure and the Batch structure below.
	:* Content Type structure:		:* Content Type structure:

Dgreenwood: /* Exposing parent and sibling data */

2025-10-01T19:03:39Z

Exposing parent and sibling data

← Older revision		Revision as of 14:03, 1 October 2025
Line 38:		Line 38:
	:* The selected parent cannot be a descendant or ancestor of this type.		:* The selected parent cannot be a descendant or ancestor of this type.
	<br>		<br>
	: '''Example:''' ~~Examinethe~~ Content Type structure and the Batch structure below.		: '''Example:''' Examine the Content Type structure and the Batch structure below.
	:* Content Type structure:		:* Content Type structure:
	:*: {{IconName\|Content Model}} HR Processing		:*: {{IconName\|Content Model}} HR Processing

Dgreenwood: /* Exposing parent and sibling data */

2025-10-01T16:19:46Z

Exposing parent and sibling data

← Older revision		Revision as of 11:19, 1 October 2025
Line 67:		Line 67:
	;Relative Of:		;Relative Of:
	:The "Relative Of" property defines a set of related Content Types whose data elements are exposed in the expression environment of this type. Unlike "Child Of" (which establishes a strict parent-child relationship) or "Sibling Of" (which exposes data from peer Secondary Types on the same Batch Folder), "Relative Of" is used for scenarios where related Content Types may appear as siblings, ancestors, or in varying positions within the Batch structure, but their data should always be available for reference in expressions, validation, or export logic.		:The "Relative Of" property defines a set of related Content Types whose data elements are exposed in the expression environment of this type. Unlike "Child Of" (which establishes a strict parent-child relationship) or "Sibling Of" (which exposes data from peer Secondary Types on the same Batch Folder), "Relative Of" is used for scenarios where related Content Types may appear as siblings, ancestors, or in varying positions within the Batch structure, but their data should always be available for reference in expressions, validation, or export logic.
	* Use "Relative Of" when the Content Type could be a parent or a sibling.		:* Use "Relative Of" when the Content Type could be a parent or a sibling.
	* This is useful when you need to reference data from other Content Types that are not guaranteed to be direct parents or assigned as Secondary Types.		:* This is useful when you need to reference data from other Content Types that are not guaranteed to be direct parents or assigned as Secondary Types.
	* This is especially useful for flexible or variable Batch structures, where the relationship between types may change, but cross-type data access is still required.		:* This is especially useful for flexible or variable Batch structures, where the relationship between types may change, but cross-type data access is still required.
	* Data Elements from the listed Content Types are made available in the expression environment, using the code name of each related type as a property.		:* Data Elements from the listed Content Types are made available in the expression environment, using the code name of each related type as a property.
	* The relationship is non-hierarchical and does not affect Batch organization or processing order.		:* The relationship is non-hierarchical and does not affect Batch organization or processing order.

	== Example Data Model and generated code environment ==		== Example Data Model and generated code environment ==

Dgreenwood: /* Exposing parent and sibling data */

2025-10-01T16:19:05Z

Exposing parent and sibling data

← Older revision		Revision as of 11:19, 1 October 2025
Line 66:		Line 66:

	;Relative Of:		;Relative Of:
	The "Relative Of" property defines a set of related Content Types whose data elements are exposed in the expression environment of this type. Unlike "Child Of" (which establishes a strict parent-child relationship) or "Sibling Of" (which exposes data from peer Secondary Types on the same Batch Folder), "Relative Of" is used for scenarios where related Content Types may appear as siblings, ancestors, or in varying positions within the Batch structure, but their data should always be available for reference in expressions, validation, or export logic.		:The "Relative Of" property defines a set of related Content Types whose data elements are exposed in the expression environment of this type. Unlike "Child Of" (which establishes a strict parent-child relationship) or "Sibling Of" (which exposes data from peer Secondary Types on the same Batch Folder), "Relative Of" is used for scenarios where related Content Types may appear as siblings, ancestors, or in varying positions within the Batch structure, but their data should always be available for reference in expressions, validation, or export logic.
			* Use "Relative Of" when the Content Type could be a parent or a sibling.
			* This is useful when you need to reference data from other Content Types that are not guaranteed to be direct parents or assigned as Secondary Types.
			* This is especially useful for flexible or variable Batch structures, where the relationship between types may change, but cross-type data access is still required.
			* Data Elements from the listed Content Types are made available in the expression environment, using the code name of each related type as a property.
			* The relationship is non-hierarchical and does not affect Batch organization or processing order.

	== Example Data Model and generated code environment ==		== Example Data Model and generated code environment ==

Dgreenwood at 16:15, 1 October 2025

2025-10-01T16:15:24Z

← Older revision		Revision as of 11:15, 1 October 2025
Line 11:		Line 11:
	The compiler generates source code for the data model structure, compiles it into an in-memory assembly, and exposes the resulting types for use in extraction, validation, and scripting scenarios. This approach allows for high performance, type safety, and flexibility when working with complex document schemas.		The compiler generates source code for the data model structure, compiles it into an in-memory assembly, and exposes the resulting types for use in extraction, validation, and scripting scenarios. This approach allows for high performance, type safety, and flexibility when working with complex document schemas.

	===Role and ~~Usage~~ in Grooper===		===Role and usage in Grooper===
	* Used internally by Grooper to generate dynamic types for each Data Model, supporting property access, variable evaluation, and navigation of hierarchical data.		* Used internally by Grooper to generate dynamic types for each Data Model, supporting property access, variable evaluation, and navigation of hierarchical data.
	* Enables advanced features such as calculated fields, validation rules, and custom expressions that reference model elements by name.		* Enables advanced features such as calculated fields, validation rules, and custom expressions that reference model elements by name.
	* Supports inheritance, parent/child relationships, and variable definitions, ensuring that all aspects of the data model are accessible in code.		* Supports inheritance, parent/child relationships, and variable definitions, ensuring that all aspects of the data model are accessible in code.

	==How ~~It Works~~==		==How it works==
	# The compiler parses the Data Model and its descendants, generating source code that defines a .NET class structure mirroring the model's hierarchy.		# The compiler parses the Data Model and its descendants, generating source code that defines a .NET class structure mirroring the model's hierarchy.
	# Each field ([[Data Field]]), section ([[Data Section]]), table ([[Data Table]]), and variable ([[Variable Definition]]) is represented as a property or nested type, with appropriate type information and documentation.		# Each field ([[Data Field]]), section ([[Data Section]]), table ([[Data Table]]), and variable ([[Variable Definition]]) is represented as a property or nested type, with appropriate type information and documentation.
Line 23:		Line 23:
	# The compiler manages versioning, assembly cleanup, and dynamic type resolution to ensure consistency and performance.		# The compiler manages versioning, assembly cleanup, and dynamic type resolution to ensure consistency and performance.

	=== Automatic ~~Compilation~~ ===		=== Automatic compilation ===
	In some cases it may be necessary to hard refresh browser sessions or restart services after making changes to the Data Model structure.		In some cases it may be necessary to hard refresh browser sessions or restart services after making changes to the Data Model structure.
	* The compiler is invoked automatically when a Data Model is created or modified.		* The compiler is invoked automatically when a Data Model is created or modified.
	* The generated types are used by Grooper's expression editors, validation logic, and automation features to provide IntelliSense, error checking, and code navigation.		* The generated types are used by Grooper's expression editors, validation logic, and automation features to provide IntelliSense, error checking, and code navigation.

	== Exposing ~~Parent~~ and ~~Sibling Data~~ ==		== Exposing parent and sibling data ==

	The "Child Of", "Sibling Of" and "Relative Of" properties on Content Type (i.e. [[Document Type]]) enable advanced data access scenarios by exposing related data elements to the expression environment of a Data Model.		The "Child Of", "Sibling Of" and "Relative Of" properties on Content Type (i.e. [[Document Type]]) enable advanced data access scenarios by exposing related data elements to the expression environment of a Data Model.
Line 68:		Line 68:
	The "Relative Of" property defines a set of related Content Types whose data elements are exposed in the expression environment of this type. Unlike "Child Of" (which establishes a strict parent-child relationship) or "Sibling Of" (which exposes data from peer Secondary Types on the same Batch Folder), "Relative Of" is used for scenarios where related Content Types may appear as siblings, ancestors, or in varying positions within the Batch structure, but their data should always be available for reference in expressions, validation, or export logic.		The "Relative Of" property defines a set of related Content Types whose data elements are exposed in the expression environment of this type. Unlike "Child Of" (which establishes a strict parent-child relationship) or "Sibling Of" (which exposes data from peer Secondary Types on the same Batch Folder), "Relative Of" is used for scenarios where related Content Types may appear as siblings, ancestors, or in varying positions within the Batch structure, but their data should always be available for reference in expressions, validation, or export logic.

	== Example Data Model and ~~Generated Code Environment~~ ==		== Example Data Model and generated code environment ==
	The Data Model Compile' generates a strongly-typed .NET class structure that mirrors the hierarchy of your Data Model. This enables intuitive property access and expression evaluation for all fields, sections, tables, and variables.		The Data Model Compile' generates a strongly-typed .NET class structure that mirrors the hierarchy of your Data Model. This enables intuitive property access and expression evaluation for all fields, sections, tables, and variables.

← Older revision		Revision as of 11:05, 17 December 2025
Line 48:		Line 48:
	:*:::: {{IconName\|Data Field}} Request_Date		:*:::: {{IconName\|Data Field}} Request_Date
	:*:::: {{IconName\|Data Field}} Change_Reason		:*:::: {{IconName\|Data Field}} Change_Reason
	:* Batch ~~strcutre~~:		:* Batch structure:
	:*: {{IconName\|Batch}} Batch		:*: {{IconName\|Batch}} Batch
	:*:: {{IconName\|Batch Folder}} Personnel File (Batch Folder)		:*:: {{IconName\|Batch Folder}} Personnel File (Batch Folder)