Expressions Cookbook - Revision history

Dgreenwood: /* Next Step Expressions */

2026-08-06T14:38:00Z

Next Step Expressions

← Older revision		Revision as of 09:38, 6 August 2026
Line 110:		Line 110:
	==== About ====		==== About ====

	Next Step Expressions allow users to conditionally route a Batch to different steps, depending on the ~~expressions~~ outcome.		Next Step Expressions allow users to conditionally route a Batch to different steps, depending on the expression's outcome.
	* Commonly <code>If()</code> statements are used to determine which step a Batch goes to based on a true or false condition.		* Commonly <code>If()</code> statements are used to determine which step a Batch goes to based on a true or false condition.
	* The Next Step Expression must evaluate to the code name of a Batch Process Step.		* The Next Step Expression must evaluate to the code name of a Batch Process Step.
	** e.g., <code>TrueStep</code> or <code>FalseStep</code>		** e.g., <code>TrueStep</code> or <code>FalseStep</code>
	** "Code name" refers to the ~~name~~ Grooper's compiler ~~uses, generated by~~ the Batch Process Step's name ~~with restricted~~ characters ~~like~~ spaces normalized ~~to ensure~~ the expression ~~can evaluate the name~~.		** "Code name" refers to the identifier Grooper's compiler generates from the Batch Process Step's display name. Restricted characters (such as spaces) are normalized so the name can be referenced in an expression.
	*<li class="attn-bullet"> The Next Step Expression runs at the Batch level and can '''only''' make the decision at the Batch scope.		*<li class="attn-bullet"> The Next Step Expression runs at the Batch level and can '''only''' make the decision at the Batch scope.
	** The Batch Process Step's "Scope" configuration ~~will '''not''' affect~~ this.		** The Next Step Expression always evaluates at the Batch scope. It determines which step the Batch advances to next.
	** The ~~expression determines the next step the '''Batch''' advances to. Therefore, Next Step Expressions can only evaluate~~ at the Batch ~~scope~~.		** The Batch Process Step's own "Scope" configuration has no effect on this. The decision is made at the Batch level regardless.

	==== Examples ====		==== Examples ====
Line 133:		Line 133:
	===== Accessing Batch data with the "Data" property =====		===== 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>.
			*<li class="attn-bullet"> Be aware the <code>Data</code> property can only access '''Batch''' fields. It cannot access child Batch Folder data.
	* 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 expression were set on an Extract step, a Batch with an InvoiceAmount 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.

	===== 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'''.
	* ~~Remember,~~ Next Step Expressions only evaluate at the Batch level.		* Because Next Step Expressions only evaluate at the Batch level, the <code>Data</code> property only exposes index data at the Batch scope — not Batch Folder scope.
	* Therefore, the <code>Data</code> property ~~is looking for~~ index data at the Batch scope (not Batch Folder scope).		* To use '''document-level''' information, you need to traverse down to a Batch Folder and load its index data to perform the comparison. Regardless, you can still only make '''one'' decision for the entire Batch.
			** 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>
	~~Because the Next Step Expression evaluates at the Batch level, you can evaluate a single condition for the entire Batch.~~ To use document information, you ~~would~~ need to traverse down to a Batch 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>

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

Dgreenwood: /* Next Step Expressions */

2026-08-06T14:28:54Z

Next Step Expressions

← Older revision		Revision as of 09:28, 6 August 2026
Line 107:		Line 107:
	* <code>Return info.PathSegments.Count > 257</code> - Tasks would submit if the PDF has more than 257 vector drawing paths.		* <code>Return info.PathSegments.Count > 257</code> - Tasks would submit if the PDF has more than 257 vector drawing paths.

	=== Next Step Expressions ===		=== Next Step Expressions ===
			==== About ====

			Next Step Expressions allow users to conditionally route a Batch to different steps, depending on the expressions outcome.
			* Commonly <code>If()</code> statements are used to determine which step a Batch goes to based on a true or false condition.
			* The Next Step Expression must evaluate to the code name of a Batch Process Step.
			** e.g., <code>TrueStep</code> or <code>FalseStep</code>
			** "Code name" refers to the name Grooper's compiler uses, generated by the Batch Process Step's name with restricted characters like spaces normalized to ensure the expression can evaluate the name.
			*<li class="attn-bullet"> The Next Step Expression runs at the Batch level and can '''only''' make the decision at the Batch scope.
			** The Batch Process Step's "Scope" configuration will '''not''' affect this.
			** The expression determines the next step the '''Batch''' advances to. Therefore, Next Step Expressions can only evaluate at the Batch scope.

			==== Examples ====
	Inspecting batch creator		Inspecting batch creator
	* <code>If(Batch.CreatedBy.ToLower() = "domain\jusername", TrueStepName, FalseStepName)</code>		* <code>If(Batch.CreatedBy.ToLower() = "domain\jusername", TrueStepName, FalseStepName)</code>
Line 127:		Line 139:
	===== 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'''.
	* ~~The~~ Next Step ~~Expression runs~~ at the Batch level ~~and can '''only''' make~~ the ~~decision~~ at the Batch scope.		* Remember, Next Step Expressions only evaluate at the Batch level.
	* The Batch Process Step's "Scope" configuration will '''not~~''' affect this. Next Step Expressions only evaluate at the~~ Batch scope.		* Therefore, the <code>Data</code> property is looking for index data at the Batch scope (not Batch Folder scope).
	* In other words, if we're digging values out of level 1 documents, we can still only make '''one''' decision for the entire Batch.

	~~Instead~~, you ~~will~~ need to traverse down to a ~~folder~~ and load its index data to perform the comparison.		Because the Next Step Expression evaluates at the Batch level, you can evaluate a single condition for the entire Batch. To use document information, you would need to traverse down to a Batch 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.		* 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 a document in a Batch */

2026-08-06T14:13:49Z

Accessing data from a document in a Batch

← Older revision		Revision as of 09:13, 6 August 2026
Line 127:		Line 127:
	===== 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'''.
			* The Next Step Expression runs at the Batch level and can '''only''' make the decision at the Batch scope.
			* The Batch Process Step's "Scope" configuration will '''not''' affect this. Next Step Expressions only evaluate at the Batch scope.
			* In other words, if we're digging values out of level 1 documents, we can still only make '''one''' decision for the entire Batch.

	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 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 ==