Expressions Cookbook - Revision history

Dgreenwood: /* Accessing data from a document in a Batch */

2026-05-19T21:36:05Z

Accessing data from a document in a Batch

← Older revision		Revision as of 16:36, 19 May 2026
Line 126:		Line 126:

	===== Accessing data from a document in a Batch =====		===== Accessing data from a document in a Batch =====
	If you need to route to the next step, based on a value from a ''document'' the <code>Data</code> property '''will not work'''.		If you need to route to the next step based on a value from a ''document'', the <code>Data</code> property '''will not work'''.

	Instead, you will need to traverse down to a folder and load its index data to perform the comparison.		Instead, you will need to traverse down to a folder and load its index data to perform the comparison.

Dgreenwood: /* Accessing data from the first document in a Batch */

2026-05-19T21:24:38Z

Accessing data from the first document in a Batch

← Older revision		Revision as of 16:24, 19 May 2026
Line 125:		Line 125:
	**<li class="attn-bullet"> Be aware the <code>Data</code> property can only access '''Batch''' fields. It cannot access child Batch Folder data.		**<li class="attn-bullet"> Be aware the <code>Data</code> property can only access '''Batch''' fields. It cannot access child Batch Folder data.

	===== Accessing data from ~~the first~~ document in a Batch =====		===== Accessing data from a document in a Batch =====
	If you need to route to the next step, based on a value from a ''document'' the <code>Data</code> property '''will not work'''.		If you need to route to the next step, based on a value from a ''document'' the <code>Data</code> property '''will not work'''.

	Instead, you will need to traverse down to a folder and load its index data to perform the comparison.		Instead, you will need to traverse down to a folder and load its index data to perform the comparison.
			* Most typically, the condition is set using data from the '''first''' document in the Batch.
	* Example: <code>If(batch.Folders.First.LoadIndexData.Fields("StringField").Value = "String Value", TrueStep, FalseStep)</code>		* Example: <code>If(batch.Folders.First.LoadIndexData.Fields("StringField").Value = "String Value", TrueStep, FalseStep)</code>

Dgreenwood: /* Accessing data from the first document in a Batch */

2026-05-19T21:03:01Z

Accessing data from the first document in a Batch

← Older revision		Revision as of 16:03, 19 May 2026
Line 129:		Line 129:

	Instead, you will need to traverse down to a folder and load its index data to perform the comparison.		Instead, you will need to traverse down to a folder and load its index data to perform the comparison.
	* Example: <code>If(batch.Folders.First.LoadIndexData("StringField") = "String ~~value~~", TrueStep, FalseStep)</code>		* Example: <code>If(batch.Folders.First.LoadIndexData.Fields("StringField").Value = "String Value", TrueStep, FalseStep)</code>

	== IP Profile Expressions ==		== IP Profile Expressions ==

Dgreenwood: /* Accessing field values in Next Step Expressions */

2026-05-19T20:03:35Z

Accessing field values in Next Step Expressions

← Older revision		Revision as of 15:03, 19 May 2026
Line 118:		Line 118:

	==== Accessing field values in Next Step Expressions ====		==== Accessing field values in Next Step Expressions ====

			===== Accessing Batch data with the "Data" property =====
	If the Batch Process has its Content Type property set, the data for this Content Type is exposed in a property named <code>Data</code>.		If the Batch Process has its Content Type property set, the data for this Content Type is exposed in a property named <code>Data</code>.
	* Example expression: <code>If(Data.InvoiceAmount > 5000, ReviewL2, ReviewL1)</code>		* Example expression: <code>If(Data.InvoiceAmount > 5000, ReviewL2, ReviewL1)</code>
	* If this were set on an Extract step, and the Batch had an "InvoiceAmount" value is greater than 5000 would be sent to a Review step named "ReviewL2". Otherwise, it would be sent to a Review step named "ReviewL1"		* If this were set on an Extract step, and the Batch had an "InvoiceAmount" value is greater than 5000 would be sent to a Review step named "ReviewL2". Otherwise, it would be sent to a Review step named "ReviewL1"
	**<li class="attn-bullet"> Be aware the <code>Data</code> property can only access '''Batch''' fields. It cannot access child Batch Folder data.		**<li class="attn-bullet"> Be aware the <code>Data</code> property can only access '''Batch''' fields. It cannot access child Batch Folder data.

			===== Accessing data from the first document in a Batch =====
			If you need to route to the next step, based on a value from a ''document'' the <code>Data</code> property '''will not work'''.

			Instead, you will need to traverse down to a folder and load its index data to perform the comparison.
			* Example: <code>If(batch.Folders.First.LoadIndexData("StringField") = "String value", TrueStep, FalseStep)</code>

	== IP Profile Expressions ==		== IP Profile Expressions ==

Dgreenwood: /* Misc Expression Snippets */

2026-04-10T14:39:14Z

Misc Expression Snippets

← Older revision		Revision as of 09:39, 10 April 2026
Line 212:		Line 212:
	* <code>ParentFolder.ChildrenAtLevel(1).Count</code>		* <code>ParentFolder.ChildrenAtLevel(1).Count</code>
	**<li class="fyi-bullet"> Works for Default Value expressions but '''not''' Calculated Value expressions. Calculated Value expressions do not have access to <code>ChildrenAtLevel()</code> or <code>ParentFolder</code>		**<li class="fyi-bullet"> Works for Default Value expressions but '''not''' Calculated Value expressions. Calculated Value expressions do not have access to <code>ChildrenAtLevel()</code> or <code>ParentFolder</code>

			String expression to calculate a file name based on the current attachment's name.
			* Scenario: Merge/Export is generating a PDF from an HTML file. User wants the PDF to be named after the source file with ".html" replaced with ".pdf"
			* <code>$"{CurrentDocument.AttachmentFileName.Replace(CurrentDocument.AttachmentFileExtension, "")}.pdf"</code>

	== General ==		== General ==

Dgreenwood: /* Misc Expression Snippets */

2026-02-27T14:05:44Z

Misc Expression Snippets

← Older revision		Revision as of 09:05, 27 February 2026
Line 207:		Line 207:
	Count the number of children at a certain level. This would count the number of Batch Folders that are direct children of a Batch Folder being processed.		Count the number of children at a certain level. This would count the number of Batch Folders that are direct children of a Batch Folder being processed.
	* <code>ChildrenAtLevel(1).Count</code>		* <code>ChildrenAtLevel(1).Count</code>
			**<li class="fyi-bullet"> Works for Default Value expressions but '''not''' Calculated Value expressions. Calculated Value expressions do not have access to <code>ChildrenAtLevel()</code>

	Count the number of children at a certain level of a ''parent folder''. This would count the number of Batch Folders that are direct children of the ''parent'' Batch Folder relative to the Batch Folder being processed.		Count the number of children at a certain level of a ''parent folder''. This would count the number of Batch Folders that are direct children of the ''parent'' Batch Folder relative to the Batch Folder being processed.
	* <code>ParentFolder.ChildrenAtLevel(1).Count</code>		* <code>ParentFolder.ChildrenAtLevel(1).Count</code>
			**<li class="fyi-bullet"> Works for Default Value expressions but '''not''' Calculated Value expressions. Calculated Value expressions do not have access to <code>ChildrenAtLevel()</code> or <code>ParentFolder</code>

	== General ==		== General ==

Dgreenwood: /* Accessing field values in Next Step Expressions */

2026-02-24T15:26:57Z

Accessing field values in Next Step Expressions

← Older revision		Revision as of 10:26, 24 February 2026
Line 118:		Line 118:

	==== Accessing field values in Next Step Expressions ====		==== Accessing field values in Next Step Expressions ====
	If the Batch Process has its Content Type property set, the data for this Content Type is exposed in a property named ~~“Data”~~.		If the Batch Process has its Content Type property set, the data for this Content Type is exposed in a property named <code>Data</code>.
	* Example expression: <code>If(Data.InvoiceAmount > 5000, ReviewL2, ReviewL1)</code>		* Example expression: <code>If(Data.InvoiceAmount > 5000, ReviewL2, ReviewL1)</code>
	* If this were set on an Extract step, ~~each document whose~~ InvoiceAmount value is greater than 5000 would be sent to a Review step named "ReviewL2". Otherwise, it would be sent to a Review step named "ReviewL1"		* If this were set on an Extract step, and the Batch had an "InvoiceAmount" value is greater than 5000 would be sent to a Review step named "ReviewL2". Otherwise, it would be sent to a Review step named "ReviewL1"
			**<li class="attn-bullet"> Be aware the <code>Data</code> property can only access '''Batch''' fields. It cannot access child Batch Folder data.

	== IP Profile Expressions ==		== IP Profile Expressions ==

Dgreenwood: /* Batch Processing Expressions */

2026-02-24T14:41:08Z

Batch Processing Expressions

← Older revision		Revision as of 09:41, 24 February 2026
Line 116:		Line 116:
	* <code>If(DatePart(DateInterval.Month, Batch.Created) = 6, TrueStepName, FalseStepName)</code>		* <code>If(DatePart(DateInterval.Month, Batch.Created) = 6, TrueStepName, FalseStepName)</code>
	* <code>If(DatePart(DateInterval.Day, Batch.Created) > 15, TrueStepName, FalseStepName)</code>		* <code>If(DatePart(DateInterval.Day, Batch.Created) > 15, TrueStepName, FalseStepName)</code>

			==== Accessing field values in Next Step Expressions ====
			If the Batch Process has its Content Type property set, the data for this Content Type is exposed in a property named “Data”.
			* Example expression: <code>If(Data.InvoiceAmount > 5000, ReviewL2, ReviewL1)</code>
			* If this were set on an Extract step, each document whose InvoiceAmount value is greater than 5000 would be sent to a Review step named "ReviewL2". Otherwise, it would be sent to a Review step named "ReviewL1"

	== IP Profile Expressions ==		== IP Profile Expressions ==

Dgreenwood: Dgreenwood moved page Expressions Cookbook (Concept) to Expressions Cookbook without leaving a redirect

2026-01-27T17:32:03Z

Dgreenwood moved page Expressions Cookbook (Concept) to Expressions Cookbook without leaving a redirect

← Older revision	Revision as of 12:32, 27 January 2026
(No difference)

Dgreenwood at 17:28, 27 January 2026

2026-01-27T17:28:38Z

@@ Line 3: / Line 3: @@
 Expressions are snippets of .NET code, allowing Grooper to do various things outside its "normal" parameters.  This includes calculating or validating extracted '''Data Field''' values in a '''Data Model''', applying conditional execution of a '''Batch Process''' or '''IP Profile''', and more!  This article collects examples of common (and maybe not so common) uses of expressions in Grooper.
 {|class="important-box"
+|