2023.1:Apply Rules (Activity): Difference between revisions

From Grooper Wiki
Created page with "{{AutoVersion}} {|class="wip-box" | '''WIP''' | This article is a work-in-progress or created as a placeholder for testing purposes. This article is subject to change and/or expansion. It may be incomplete, inaccurate, or stop abruptly. This tag will be removed upon draft completion. |} <blockquote>{{#lst:Glossary|Apply Rules}}</blockquote> == Glossary == == About == == How To =="
 
// via Wikitext Extension for VSCode
Line 15: Line 15:


== About ==
== About ==
Once you have extracted data from a '''Batch''' you might want to do something to manipulate that data. '''Data Rules''' allow you to automatically manipulate data through use of .NET, LINQ, and/or lambda expressions. For information on how to set these up, please visit our '''[[Data Rule (Object)|Data Rules]]''' wiki article.
However, just having '''Data Rules''' set up in your '''Content Model''' will not actually run those rules on your extracted data. To automatically apply these '''Data Rules''' you will need to include an ''Apply Rules'' '''Batch Process Step''' to your '''Batch Process''' after your ''Extract'' '''Batch Process Step'''.


== How To ==
== How To ==
Creating and configuring the ''Apply Rules Activity'' is fairly simple and requires that you create an ''Apply Rules'' '''Batch Process Step''' in a '''Batch Process'''.
{|class="attn-box"
|
|
'''Data Rules''' can only be applied on data that has already been extracted, so the ''Apply Rules'' '''Batch Process Step''' must ALWAYS come after an ''Extract'' '''Batch Process Step''' within a '''Batch Process'''.
|}
=== Adding the Apply Rules Step ===
# Right-click on the '''Batch Process'''.
# Hover over "Add Activity", then hover over "Document Processing". Finally, click on "Apply Rules..."
# When the "Add Activity" window pops up, you can change the name in the '''''Step Name''''' if you like, but in this tutorial we're going to keep the default of "Apply Rules".
# Click "EXECUTE" located in the top right corner of the pop up window.
[[File:2023.1 Apply-Rules-(Activity) 02 01 BP-Step 01.png]]
#<li value=5> Now you should have an ''Apply Rules'' '''Batch Process Step''' in your '''Batch Process'''.
# You will need to set your '''''Scope''''' to the folder level your documents reside at. For our example, our '''''Scope''''' is set to ''Folder'' and the '''''Folder Level''''' is ''1''. You will never need to set this property to a ''Page'' '''''Folder Level'''''.
[[File:2023.1 Apply-Rules-(Activity) 02 01 BP-Step 02.png]]
=== Configuring the Apply Rules Activity ===
# Click on the ellipsis icon to the right of the '''''Rules Property'''''.
[[File:2023.1 Apply-Rules-(Activity) 02 02 Configuring 01.png]]
#<li value=2> When the "Rules" window pops up, navigate to and click the check boxes next to the '''Data Rule''' objects you want to apply.
# The selected '''Data Rules''' will show up in a list on the left side of the window. They will be displayed in the order they will be applied.
# Click the up and down icons located above the Rules list to change the order of the selected rule in the list.
# When you are finished adding and reordering your '''Data Rules''', click "OK" located in the top right of the pop up window.
[[File:2023.1 Apply-Rules-(Activity) 02 02 Configuring 02.png]]
#<li value=6> Check the box next to the '''''Flag Issues''''' property if you want the folder to be flagged when the ''Raise Issue'' action is fired. This will make it easier to find the issues during review.
[[File:2023.1 Apply-Rules-(Activity) 02 02 Configuring 03.png]]

Revision as of 15:54, 17 July 2024

This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

20252023.1

WIP

This article is a work-in-progress or created as a placeholder for testing purposes. This article is subject to change and/or expansion. It may be incomplete, inaccurate, or stop abruptly.

This tag will be removed upon draft completion.

flowsheet Apply Rules is an Activity that runs flowsheet Data Rules on data that has previously been extracted from documents (folder Batch Folders).

  • The Apply Rules activity will always need to run after an Extract activity runs (An Extract step must come before an Apply Rules step in the order of edit_document Batch Process Steps in a settings Batch Process).

Glossary

About

Once you have extracted data from a Batch you might want to do something to manipulate that data. Data Rules allow you to automatically manipulate data through use of .NET, LINQ, and/or lambda expressions. For information on how to set these up, please visit our Data Rules wiki article.

However, just having Data Rules set up in your Content Model will not actually run those rules on your extracted data. To automatically apply these Data Rules you will need to include an Apply Rules Batch Process Step to your Batch Process after your Extract Batch Process Step.

How To

Creating and configuring the Apply Rules Activity is fairly simple and requires that you create an Apply Rules Batch Process Step in a Batch Process.

Data Rules can only be applied on data that has already been extracted, so the Apply Rules Batch Process Step must ALWAYS come after an Extract Batch Process Step within a Batch Process.

Adding the Apply Rules Step

  1. Right-click on the Batch Process.
  2. Hover over "Add Activity", then hover over "Document Processing". Finally, click on "Apply Rules..."
  3. When the "Add Activity" window pops up, you can change the name in the Step Name if you like, but in this tutorial we're going to keep the default of "Apply Rules".
  4. Click "EXECUTE" located in the top right corner of the pop up window.


  1. Now you should have an Apply Rules Batch Process Step in your Batch Process.
  2. You will need to set your Scope to the folder level your documents reside at. For our example, our Scope is set to Folder and the Folder Level is 1. You will never need to set this property to a Page Folder Level.


Configuring the Apply Rules Activity

  1. Click on the ellipsis icon to the right of the Rules Property.


  1. When the "Rules" window pops up, navigate to and click the check boxes next to the Data Rule objects you want to apply.
  2. The selected Data Rules will show up in a list on the left side of the window. They will be displayed in the order they will be applied.
  3. Click the up and down icons located above the Rules list to change the order of the selected rule in the list.
  4. When you are finished adding and reordering your Data Rules, click "OK" located in the top right of the pop up window.


  1. Check the box next to the Flag Issues property if you want the folder to be flagged when the Raise Issue action is fired. This will make it easier to find the issues during review.