Code Expressions (Concept) - Revision history

Dgreenwood: /* Path expressions */

2025-10-10T18:45:22Z

Path expressions

← Older revision		Revision as of 13:45, 10 October 2025
Line 50:		Line 50:
	:* Various [[Export Format]]s' "Computed Filename" property - Generates the filename for the exported file.		:* Various [[Export Format]]s' "Computed Filename" property - Generates the filename for the exported file.
	:* The [[File Export]], [[FTP Export]], and [[STFP Export]] definitions' "Relative Path" property - Defines the path of exported files, dynamically generating subfolder paths and filenames based on document data retrieved by the expression.		:* The [[File Export]], [[FTP Export]], and [[STFP Export]] definitions' "Relative Path" property - Defines the path of exported files, dynamically generating subfolder paths and filenames based on document data retrieved by the expression.
	:* The [[CMIS Export]] definition's "Subfolder Path" property - Defines the folder path inside the "Target Folder" where files are exported, dynamically generating subfolder paths based on document data retrieved by the expression. BE AWARE: This expression ONLY generates folder paths NOT filenames.		:* The [[CMIS Export]] definition's "Subfolder Path" property - Defines the folder path inside the "Target Folder" where files are exported, dynamically generating subfolder paths based on document data retrieved by the expression.
			:**<li class="attn-bullet">BE AWARE: This expression ONLY generates folder paths NOT filenames.
	:* The [[Attachment Type]] command "Rename Attachment" and its "Expression" property - Calculates the attachment's new name using an expression.		:* The [[Attachment Type]] command "Rename Attachment" and its "Expression" property - Calculates the attachment's new name using an expression.

Dgreenwood: /* Trigger expressions */

2025-10-10T18:44:37Z

Trigger expressions

← Older revision		Revision as of 13:44, 10 October 2025
Line 58:		Line 58:
	=== Trigger expressions ===		=== Trigger expressions ===
	: Trigger expressions are utilized by various Grooper objects to dynamically control execution.		: Trigger expressions are utilized by various Grooper objects to dynamically control execution.
	:* In most cases, when the trigger expression evaluates to <code>true</code> the object is executed. For example, [[AI Extract]] has a "Trigger" property. If configured and the expression returns <code>true</code>, AI Extract will automatically run during extraction. If it returns <code>false</code>, it won't. This can be used to conditionally execute AI Extract only for certain Document Types or when specific data is present.		:* In most cases, when the trigger expression evaluates to <code>true</code> the object is executed. For example, AI Extract has a "Trigger" property. If configured and the expression returns <code>true</code>, AI Extract will automatically run during extraction. If it returns <code>false</code>, it won't. This can be used to conditionally execute AI Extract only for certain Document Types or when specific data is present.
	:* In the case of a [[Data Rule]]'s "Trigger" property, the trigger expression determines what Data Actions are applied. If the expression returns <code>true</code>, the "True Action" configuration is applied. If the expression returns <code>false</code>, the "False Action" is applied.		:* In the case of a Data Rule's "Trigger" property, the trigger expression determines what Data Actions are applied. If the expression returns <code>true</code>, the "True Action" configuration is applied. If the expression returns <code>false</code>, the "False Action" is applied.
	: Trigger expressions are configured in almost all cases using a "Trigger" property. The following have configurable "Trigger" properties in Grooper:		: Trigger expressions are configured in almost all cases using a "Trigger" property. The following have configurable "Trigger" properties in Grooper:
	:* Data ~~Rules~~		:* [[Data Rule]]s
	:* The "Copy" Data Action		:* The "[[Data_Action#Copy\|Copy]]" Data Action
	:* The "Append" Data Action		:* The "[[Data_Action#Append\|Append]]" Data Action
	:* The "Concat" Data Action		:* The "[[Data_Action#Concat\|Concat]]" Data Action
	:* The "Remove" Data Action		:* The "[[Data_Action#Remove\|Remove]]" Data Action
	:* Fill ~~Methods~~ (including AI Extract)		:* [[Fill Method]]s (including [[AI Extract]])
	:* The [[Route]] activity's Route Definitions		:* The [[Route]] activity's Route Definitions
	:* The "Custom" Trigger Mode for Lookup ~~Specifications~~		:* The "Custom" Trigger Mode for [[Lookup Specification]]s

	=== Variable Definitions ===		=== Variable Definitions ===

Dgreenwood: /* Variable Definitions */

2025-10-10T18:41:48Z

Variable Definitions

← Older revision		Revision as of 13:41, 10 October 2025
Line 71:		Line 71:

	=== Variable Definitions ===		=== Variable Definitions ===
	: [[Variable Definition]]s use expressions to compute values that can then be leveraged from other expressions.		[[Variable Definition\|A full article on Variable Definitions can be found here.]]

			: Variable Definitions use expressions to compute values that can then be leveraged from other expressions.
	:* Variables can be defined on any "container" Data Element: [[Data Model]]s, [[Data Section]]s, and [[Data Table]]s		:* Variables can be defined on any "container" Data Element: [[Data Model]]s, [[Data Section]]s, and [[Data Table]]s
	:* Variables may be used in many places throughout Grooper. [[Variable_Definition#What_can_use_Variables?\|See this section of the Variable Definition article for a full list.]]		:* Variables may be used in many places throughout Grooper. [[Variable_Definition#What_can_use_Variables?\|See this section of the Variable Definition article for a full list.]]

Dgreenwood: /* Data Model expressions */

2025-10-10T18:41:04Z

Data Model expressions

← Older revision		Revision as of 13:41, 10 October 2025
Line 21:		Line 21:

	=== Data Model expressions ===		=== Data Model expressions ===

			[[Data Model Expressions\|A full article on Data Model expressions can be found here.]]

	: These expressions are among the most common in Groper. They are used to calculate and validate field values in a [[Data Model]].		: These expressions are among the most common in Groper. They are used to calculate and validate field values in a [[Data Model]].
	: Data Model expressions are configured using the following [[Data Field]] and [[Data Column]] properties:		: Data Model expressions are configured using the following [[Data Field]] and [[Data Column]] properties:

Dgreenwood: /* Variable Definitions */

2025-10-08T19:12:11Z

Variable Definitions

← Older revision		Revision as of 14:12, 8 October 2025
Line 68:		Line 68:

	=== Variable Definitions ===		=== Variable Definitions ===
	: [[Variable ~~Definitions~~]] use expressions to compute values that can then be leveraged from other expressions.		: [[Variable Definition]]s use expressions to compute values that can then be leveraged from other expressions.
	:* Variables can be defined on any "container" Data Element: [[Data Model]]s, [[Data Section]]s, and [[Data Table]]s		:* Variables can be defined on any "container" Data Element: [[Data Model]]s, [[Data Section]]s, and [[Data Table]]s
	:* Variables may be used in many places throughout Grooper. [[Variable_Definition#What_can_use_Variables?\|See this section of the Variable Definition article for a full list.]]		:* Variables may be used in many places throughout Grooper. [[Variable_Definition#What_can_use_Variables?\|See this section of the Variable Definition article for a full list.]]

Dgreenwood: /* String interpolation */

2025-10-08T16:04:31Z

String interpolation

← Older revision		Revision as of 11:04, 8 October 2025
Line 79:		Line 79:
	<pre>		<pre>
	$"Invoice_{Invoice_No}_{Invoice_Date:yyyy-MM-dd}"		$"Invoice_{Invoice_No}_{Invoice_Date:yyyy-MM-dd}"
			</pre>

			=== String concatenation ===
			<pre>
			"Invoice" & "_" & Invoice_No & "_" & Invoice_Date.ToSTring("yyyy-MM-dd")
	</pre>		</pre>

Dgreenwood: /* Types of expressions */

2025-10-08T16:01:24Z

Types of expressions

← Older revision		Revision as of 11:01, 8 October 2025
Line 20:		Line 20:
	Grooper supports several types of expressions, each designed for a specific purpose:		Grooper supports several types of expressions, each designed for a specific purpose:

	; Data Model expressions		=== Data Model expressions ===
	: These expressions are among the most common in Groper. They are used to calculate and validate field values in a [[Data Model]].		: These expressions are among the most common in Groper. They are used to calculate and validate field values in a [[Data Model]].
	: Data Model expressions are configured using the following [[Data Field]] and [[Data Column]] properties:		: Data Model expressions are configured using the following [[Data Field]] and [[Data Column]] properties:
Line 28:		Line 28:
	:* "Is Required" - A Boolean expression that determines if the field is required (meaning it cannot be empty). If the expression evaluates to <code>true</code> and the field is empty, it will be set to an error state to alert a user during Review.		:* "Is Required" - A Boolean expression that determines if the field is required (meaning it cannot be empty). If the expression evaluates to <code>true</code> and the field is empty, it will be set to an error state to alert a user during Review.

	; Batch Process expressions		=== Batch Process expressions ===
	: These expressions customize the flow of steps in a Batch Process.		: These expressions customize the flow of steps in a Batch Process.
	: Batch Process expressions are configured using the following [[Batch Process Step]] properties:		: Batch Process expressions are configured using the following [[Batch Process Step]] properties:
Line 34:		Line 34:
	:* "Next Step Expression" - Determines the next step to execute after this one. This is used to create branching workflows in a Batch Process and route the Batch to Review steps for exception handling. This must evaluate to a specific Batch Process Step or <code>Nothing</code> to complete the Batch.		:* "Next Step Expression" - Determines the next step to execute after this one. This is used to create branching workflows in a Batch Process and route the Batch to Review steps for exception handling. This must evaluate to a specific Batch Process Step or <code>Nothing</code> to complete the Batch.

	; IP Profile expressions		=== IP Profile expressions ===
	: These expressions customize the flow of steps in an IP Profile.		: These expressions customize the flow of steps in an IP Profile.
	: IP Profile expressions are configured using the following [[IP Step]] and [[IP Group] properties:		: IP Profile expressions are configured using the following [[IP Step]] and [[IP Group] properties:
Line 41:		Line 41:
	:*<li class="fyi-bullet"> The need for complicated, expression-driven IP Profiles has reduced dramatically with the introduction of [[Azure OCR]]. The Azure engine simply does not require the levels of image cleanup traditional OCR engines require.		:*<li class="fyi-bullet"> The need for complicated, expression-driven IP Profiles has reduced dramatically with the introduction of [[Azure OCR]]. The Azure engine simply does not require the levels of image cleanup traditional OCR engines require.

	; Path expressions		=== Path expressions ===
	: These expressions are used to dynamically generate output paths for exported documents. They allow you to combine field values, metadata, and custom logic to build folder and file names.		: These expressions are used to dynamically generate output paths for exported documents. They allow you to combine field values, metadata, and custom logic to build folder and file names.
	: Path expressions are configurable for the following:		: Path expressions are configurable for the following:
Line 50:		Line 50:
	:* The [[Attachment Type]] command "Rename Attachment" and its "Expression" property - Calculates the attachment's new name using an expression.		:* The [[Attachment Type]] command "Rename Attachment" and its "Expression" property - Calculates the attachment's new name using an expression.

	; Mapping expressions		=== Mapping expressions ===
	: Mapping expressions are used by various ~~export~~ mechanisms to export document data to external systems like database tables and content management systems.		: Mapping expressions are used by various mechanisms to export Grooper document data to external systems like database tables and content management systems. Mapping expressions are also used by [[CMIS Import]] and [[Import Behavior]]s to import data from external content management systems to Grooper documents.

	; Trigger expressions		=== Trigger expressions ===
	: Trigger expressions are utilized by various Grooper objects to dynamically control execution.		: Trigger expressions are utilized by various Grooper objects to dynamically control execution.
	:* In most cases, when the trigger expression evaluates to <code>true</code> the object is executed. For example, [[AI Extract]] has a "Trigger" property. If configured and the expression returns <code>true</code>, AI Extract will automatically run during extraction. If it returns <code>false</code>, it won't. This can be used to conditionally execute AI Extract only for certain Document Types or when specific data is present.		:* In most cases, when the trigger expression evaluates to <code>true</code> the object is executed. For example, [[AI Extract]] has a "Trigger" property. If configured and the expression returns <code>true</code>, AI Extract will automatically run during extraction. If it returns <code>false</code>, it won't. This can be used to conditionally execute AI Extract only for certain Document Types or when specific data is present.
Line 67:		Line 67:
	:* The "Custom" Trigger Mode for Lookup Specifications		:* The "Custom" Trigger Mode for Lookup Specifications

	; Variable Definitions		=== Variable Definitions ===
	: [[Variable Definitions]] use expressions to compute values that can then be leveraged from other expressions.		: [[Variable Definitions]] use expressions to compute values that can then be leveraged from other expressions.
	:* Variables can be defined on any "container" Data Element: [[Data Model]]s, [[Data Section]]s, and [[Data Table]]s		:* Variables can be defined on any "container" Data Element: [[Data Model]]s, [[Data Section]]s, and [[Data Table]]s

Dgreenwood: /* Types of expressions */

2025-10-08T15:57:34Z

Types of expressions

← Older revision		Revision as of 10:57, 8 October 2025
Line 49:		Line 49:
	:* The [[CMIS Export]] definition's "Subfolder Path" property - Defines the folder path inside the "Target Folder" where files are exported, dynamically generating subfolder paths based on document data retrieved by the expression. BE AWARE: This expression ONLY generates folder paths NOT filenames.		:* The [[CMIS Export]] definition's "Subfolder Path" property - Defines the folder path inside the "Target Folder" where files are exported, dynamically generating subfolder paths based on document data retrieved by the expression. BE AWARE: This expression ONLY generates folder paths NOT filenames.
	:* The [[Attachment Type]] command "Rename Attachment" and its "Expression" property - Calculates the attachment's new name using an expression.		:* The [[Attachment Type]] command "Rename Attachment" and its "Expression" property - Calculates the attachment's new name using an expression.

			; Mapping expressions
			: Mapping expressions are used by various export mechanisms to export document data to external systems like database tables and content management systems.

	; Trigger expressions		; Trigger expressions
Line 68:		Line 71:
	:* Variables can be defined on any "container" Data Element: [[Data Model]]s, [[Data Section]]s, and [[Data Table]]s		:* Variables can be defined on any "container" Data Element: [[Data Model]]s, [[Data Section]]s, and [[Data Table]]s
	:* Variables may be used in many places throughout Grooper. [[Variable_Definition#What_can_use_Variables?\|See this section of the Variable Definition article for a full list.]]		:* Variables may be used in many places throughout Grooper. [[Variable_Definition#What_can_use_Variables?\|See this section of the Variable Definition article for a full list.]]

	== Syntax and examples ==		== Syntax and examples ==

Dgreenwood at 15:53, 8 October 2025

2025-10-08T15:53:49Z

← Older revision		Revision as of 10:53, 8 October 2025
Line 1:		Line 1:
	{{~~Migrated~~}}		{{AutoVersion}}
	{{~~2023~~:{{~~PAGENAME}~~}}}		<blockquote>{{#lst:Glossary\|Code Expressions}}</blockquote>

			Code expressions provide a powerful way to add dynamic logic, calculations, and conditional behavior to your Data Fields, Batch Processes, image processing steps, and export paths. This article explains the types of expressions available, how they are used, and best practices for configuring them.

			== What are expressions? ==

			An '''expression''' in Grooper is a code snippet or formula that is evaluated at runtime to compute a value, determine workflow logic, or validate data. Expressions can reference fields, variables, and built-in functions available in the current context, allowing you to tailor Grooper’s behavior to your business needs.

			Expressions are used in many places, including:
			* Calculating field values in a [[Data Model]]
			* Validating extracted data
			* Controlling the flow of a [[Batch Process]]
			* Generating export paths for documents
			* Managing image processing steps in an [[IP Profile]]
			* [[Data Rule]] triggers

			== Types of expressions ==

			Grooper supports several types of expressions, each designed for a specific purpose:

			; Data Model expressions
			: These expressions are among the most common in Groper. They are used to calculate and validate field values in a [[Data Model]].
			: Data Model expressions are configured using the following [[Data Field]] and [[Data Column]] properties:
			:* "Default Value" - Generates a default value for the field.
			:* "Calculated Value" - Calculates an expected value for the field based on other field values. This can be used to validate or automatically populate the field.
			:* "Is Valid" - A Boolean expression that determines if the field's value is valid. If the expression evaluates to <code>false</code>, the field will be set to an error state to alert a user during Review.
			:* "Is Required" - A Boolean expression that determines if the field is required (meaning it cannot be empty). If the expression evaluates to <code>true</code> and the field is empty, it will be set to an error state to alert a user during Review.

			; Batch Process expressions
			: These expressions customize the flow of steps in a Batch Process.
			: Batch Process expressions are configured using the following [[Batch Process Step]] properties:
			:* "Should Submit Expression" - A Boolean expression that determines if a task is submitted for each item in scope (Batch, Batch Folder or Batch Page). The expression is evaluated for each item. If the expression evaluates to <code>false</code>, no task is submitted for the item and the item is skipped. If all items are skipped, the step is effectively bypassed.
			:* "Next Step Expression" - Determines the next step to execute after this one. This is used to create branching workflows in a Batch Process and route the Batch to Review steps for exception handling. This must evaluate to a specific Batch Process Step or <code>Nothing</code> to complete the Batch.

			; IP Profile expressions
			: These expressions customize the flow of steps in an IP Profile.
			: IP Profile expressions are configured using the following [[IP Step]] and [[IP Group] properties:
			:* "Should Execute Expression" - A Boolean expression that determines whether the IP Step or IP Group should execute. This allows the IP Profile to adapt dynamically to properties of the image or the results of previous IP Steps. If the expression evaluates to <code>true</code>, the IP Group or IP Step executes. The IP Group or IP Step is skipped if <code>false</code>.
			:* "Next Step Expression" - A Boolean expression that determines the next IP Step or IP Group after the current one completes. This is used to create conditional branching in an IP Profile or terminate the IP Profile early. This must evaluate to a specific IP Group or IP Step or <code>Nothing</code> to terminate the IP Profile.
			:*<li class="fyi-bullet"> The need for complicated, expression-driven IP Profiles has reduced dramatically with the introduction of [[Azure OCR]]. The Azure engine simply does not require the levels of image cleanup traditional OCR engines require.

			; Path expressions
			: These expressions are used to dynamically generate output paths for exported documents. They allow you to combine field values, metadata, and custom logic to build folder and file names.
			: Path expressions are configurable for the following:
			:* The [[Merge]] activity's "Attachment Name" property - Calculates the attachment filename.
			:* Various [[Export Format]]s' "Computed Filename" property - Generates the filename for the exported file.
			:* The [[File Export]], [[FTP Export]], and [[STFP Export]] definitions' "Relative Path" property - Defines the path of exported files, dynamically generating subfolder paths and filenames based on document data retrieved by the expression.
			:* The [[CMIS Export]] definition's "Subfolder Path" property - Defines the folder path inside the "Target Folder" where files are exported, dynamically generating subfolder paths based on document data retrieved by the expression. BE AWARE: This expression ONLY generates folder paths NOT filenames.
			:* The [[Attachment Type]] command "Rename Attachment" and its "Expression" property - Calculates the attachment's new name using an expression.

			; Trigger expressions
			: Trigger expressions are utilized by various Grooper objects to dynamically control execution.
			:* In most cases, when the trigger expression evaluates to <code>true</code> the object is executed. For example, [[AI Extract]] has a "Trigger" property. If configured and the expression returns <code>true</code>, AI Extract will automatically run during extraction. If it returns <code>false</code>, it won't. This can be used to conditionally execute AI Extract only for certain Document Types or when specific data is present.
			:* In the case of a [[Data Rule]]'s "Trigger" property, the trigger expression determines what Data Actions are applied. If the expression returns <code>true</code>, the "True Action" configuration is applied. If the expression returns <code>false</code>, the "False Action" is applied.
			: Trigger expressions are configured in almost all cases using a "Trigger" property. The following have configurable "Trigger" properties in Grooper:
			:* Data Rules
			:* The "Copy" Data Action
			:* The "Append" Data Action
			:* The "Concat" Data Action
			:* The "Remove" Data Action
			:* Fill Methods (including AI Extract)
			:* The [[Route]] activity's Route Definitions
			:* The "Custom" Trigger Mode for Lookup Specifications

			; Variable Definitions
			: [[Variable Definitions]] use expressions to compute values that can then be leveraged from other expressions.
			:* Variables can be defined on any "container" Data Element: [[Data Model]]s, [[Data Section]]s, and [[Data Table]]s
			:* Variables may be used in many places throughout Grooper. [[Variable_Definition#What_can_use_Variables?\|See this section of the Variable Definition article for a full list.]]
			== Syntax and examples ==

			Grooper expressions use Visual Basic .NET syntax. You can use string interpolation, composite formatting, LINQ queries, built-in functions, and lambda functions.

			=== String interpolation ===
			<pre>
			$"Invoice_{Invoice_No}_{Invoice_Date:yyyy-MM-dd}"
			</pre>

			=== Composite formatting ===
			<pre>
			String.Format("Invoice_{0}_{1}", Invoice_No, Invoice_Date.ToString("yyyy-MM-dd"))
			</pre>

			=== LINQ queries ===
			<pre>
			(From Row In Line_Items Select Row.Line_Total).Sum
			</pre>

			=== Built-in functions ===
			<pre>
			CleanFileName(Customer_Name)
			Guid.NewGuid
			DateTime.Now
			</pre>

			== Best practices ==

			* '''Test expressions thoroughly''' to avoid runtime errors.
			* '''Sanitize path segments''' in path expressions to avoid invalid characters.
			* '''Use clear, maintainable logic''' for conditional and validation expressions.
			* '''Document complex expressions''' using comments or supporting documentation.
			* '''Use explicit formatting''' for dates and numbers to ensure consistent output.

			== Expression Editor shortcuts ==
			When in any expression editor:
			* Enter <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>Space</kbd> on the keyboard to bring up the IntelliSense menu.
			* Type <code>Me.</code> to list all accessible instance fields, properties, and methods in the IntelliSense menu.

Randallkinard at 13:26, 28 August 2024

2024-08-28T13:26:00Z

← Older revision		Revision as of 08:26, 28 August 2024
Line 1:		Line 1:
	{{~~Migrated2023~~}}		{{Migrated}}
	{{2023:{{PAGENAME}}}}		{{2023:{{PAGENAME}}}}