Activity Processing (Service) - Revision history

Dgreenwood: /* Install an Activity Processing service with a Processing Queue */

2026-06-11T18:33:53Z

Install an Activity Processing service with a Processing Queue

← Older revision		Revision as of 13:33, 11 June 2026
Line 86:		Line 86:

	Commonly, a '''Processing Queue''' is created and implemented to throttle certain '''Activities''', such as '''Recognize''' or '''Export''', restricting the maximum number of threads that can be used to process those steps (thus freeing up compute for other '''Activities''').		Commonly, a '''Processing Queue''' is created and implemented to throttle certain '''Activities''', such as '''Recognize''' or '''Export''', restricting the maximum number of threads that can be used to process those steps (thus freeing up compute for other '''Activities''').
	* [[Export (Activity)#Processing Queue Guidance\|Refer to this section of the ~~Render~~ article for more information]]		* [[Export (Activity)#Processing Queue Guidance\|Refer to this section of the Export article for more information]]
	* In this example, we describe how to implement a single-threaded '''Activity Processing''' service that executes '''Export''' steps using a '''Processing Queue'''.		* In this example, we describe how to implement a single-threaded '''Activity Processing''' service that executes '''Export''' steps using a '''Processing Queue'''.

	=== Install an Activity Processing service for the Render activity ===		=== Install an Activity Processing service for the Render activity ===

Dgreenwood: /* How To */

2026-06-11T18:19:01Z

How To

← Older revision		Revision as of 13:19, 11 June 2026
Line 29:		Line 29:
	<section begin="multithreaded_service" />		<section begin="multithreaded_service" />
	'''Activity Processing''' services allow you to automate '''Code Activity''' tasks. If you do not assign a '''Processing Queue''' to the '''Activity Processing''' service, it will pick up tasks in the "default queue", automatically processing any tasks that aren't in a specific '''Processing Queue'''. Creating an '''Activity Processing''' service without a '''Processing Queue''' is generally the easiest way to get started automating steps in a '''Batch Process'''.		'''Activity Processing''' services allow you to automate '''Code Activity''' tasks. If you do not assign a '''Processing Queue''' to the '''Activity Processing''' service, it will pick up tasks in the "default queue", automatically processing any tasks that aren't in a specific '''Processing Queue'''. Creating an '''Activity Processing''' service without a '''Processing Queue''' is generally the easiest way to get started automating steps in a '''Batch Process'''.


	In this scenario, we will install an '''Activity Processing''' service with ''no'' associated '''Processing Queue''' and give it a certain number of threads to use. This service will pick up and process any '''Code Activity''' tasks for '''Batch Process Steps''' with no '''Processing Queue''' assigned.		In this scenario, we will install an '''Activity Processing''' service with ''no'' associated '''Processing Queue''' and give it a certain number of threads to use. This service will pick up and process any '''Code Activity''' tasks for '''Batch Process Steps''' with no '''Processing Queue''' assigned.


	{\|class="attn-box"		{\|class="attn-box"
Line 41:		Line 39:
	Before starting, be aware:		Before starting, be aware:
	* Grooper Command Console must be run as an administrator to install, edit, start and stop services.		* Grooper Command Console must be run as an administrator to install, edit, start and stop services.
	* During installation, you will need to provide a service account. Be sure this account has the correct permissions. [[#Service account permissions\|~~See above~~ for required permissions.]]		* During installation, you will need to provide a service account. Be sure this account has the correct permissions. [[Activity Processing#Service account permissions\|Refer here for required permissions.]]
	\|}		\|}

Dgreenwood at 18:18, 11 June 2026

2026-06-11T18:18:03Z

@@ Line 31: / Line 31: @@
-In this scenario, we will install an '''Activity Processing''' service with ''no'' associated '''Processing Queue''' and give it a certain number of threads to use.
+In this scenario, we will install an '''Activity Processing''' service with ''no'' associated '''Processing Queue''' and give it a certain number of threads to use. This service will pick up and process any '''Code Activity''' tasks for '''Batch Process Steps''' with no '''Processing Queue''' assigned.
-* This service will pick up and process any '''Code Activity''' tasks for '''Batch Process Steps''' with no '''Processing Queue''' assigned.
 {|class="attn-box"
@@ Line 59: / Line 83: @@
 '''''THE LONG STORY SHORT HERE IS DO NOT OVER-ALLOCATE YOUR AVAILABLE THREADS!  GROOPER CAN BEHAVE ERRATICALLY IF YOU DO!'''''
 |}
 <section end="multithreaded_service" />
 === Install an Activity Processing service with a Processing Queue ===
 '''Processing Queues''' allow '''Activity Processing''' services to divide CPU threads amongst different steps in a '''Batch Process'''.  This is mechanism that allows you to control how many threads are utilized by specified steps.

Dgreenwood at 18:10, 11 June 2026

2026-06-11T18:10:48Z

← Older revision		Revision as of 13:10, 11 June 2026
Line 9:		Line 9:
	* When specified, only the '''Activity Processing''' service will only process tasks for '''Batch Process''' steps with that '''Processing Queue''' assigned.		* When specified, only the '''Activity Processing''' service will only process tasks for '''Batch Process''' steps with that '''Processing Queue''' assigned.
	** Be aware, while an '''Activity Processing''' service can only be configured to point to a single '''Processing Queue''', multiple '''Activity Processing''' services may be added to the Grooper service list (each referencing their own '''Processing Queues''').		** Be aware, while an '''Activity Processing''' service can only be configured to point to a single '''Processing Queue''', multiple '''Activity Processing''' services may be added to the Grooper service list (each referencing their own '''Processing Queues''').

	~~{{GrooperServiceUserRights}}~~

	== About ==		== About ==
Line 22:		Line 20:

	You could then set up an '''Activity Processing''' service to process all '''Code Activity''' steps in a '''Batch Process''' with the maximum allowable processing threads available.		You could then set up an '''Activity Processing''' service to process all '''Code Activity''' steps in a '''Batch Process''' with the maximum allowable processing threads available.

			=== Service account permissions ===

			{{LeastPrivilegeServiceAccounts}}

	==How To==		==How To==

Dgreenwood at 12:49, 18 May 2026

2026-05-18T12:49:32Z

← Older revision		Revision as of 07:49, 18 May 2026
Line 1:		Line 1:
	~~{{AutoVersion}}~~
	{{AutoVersion}}		{{AutoVersion}}

Dgreenwood at 12:49, 18 May 2026

2026-05-18T12:49:21Z

← Older revision		Revision as of 07:49, 18 May 2026
Line 1:		Line 1:
	{{~~Migrated~~}}		{{AutoVersion}}
	{{~~2024~~:{{~~PAGENAME~~}}}}		{{AutoVersion}}

			[[Image:ActivityProcessingService.png\|right\|thumb\|250px\|Activity Processing Services process unattended activities.]]

			<blockquote>{{#lst:Glossary\|Activity Processing Service}}</blockquote>

			When configuring an '''Activity Processing''' service, a '''[[Processing Queue]]''' may or may not be specified.
			* When unspecified, the service will assign work using the "default" '''Processing Queue'''. The '''Activity Processing''' service will pick up tasks for any '''Batch Process Steps''' that ''do not'' have an assigned '''Processing Queue'''.
			* When specified, only the '''Activity Processing''' service will only process tasks for '''Batch Process''' steps with that '''Processing Queue''' assigned.
			** Be aware, while an '''Activity Processing''' service can only be configured to point to a single '''Processing Queue''', multiple '''Activity Processing''' services may be added to the Grooper service list (each referencing their own '''Processing Queues''').

			{{GrooperServiceUserRights}}

			== About ==
			'''Unattended Activities''' in a '''Batch Process''' can be automated using an '''Activity Processing''' Grooper service. The '''Activity Processing''' service will act like a Windows service and automatically start tasks in a '''Batch''', as processing threads in your system's resources become available. This is one of the ways Grooper leverages your system resources for parallel processing.

			Imagine you're running Grooper on a machine with eight (8) processing threads. If you have a '''Batch''' with five (5) '''Batch Folders''', and each one is on the '''Recognize''' step of the '''Batch Process''', there's no need for your system to process each '''Batch Folder''' sequentially (with each '''Batch Folder''' waiting to be processed until the one before it is finished).
			* You have 8 threads and 5 '''Batch Folders''' in this scenario.
			* Each one of those threads can process one '''Batch Folder''' as a single task.
			* With 8 available threads, all 5 '''Batch Folders''' could be processed concurrently by 5 individual threads.
			* This is ''multi-threaded'' '''Activity''' processing.

			You could then set up an '''Activity Processing''' service to process all '''Code Activity''' steps in a '''Batch Process''' with the maximum allowable processing threads available.

			==How To==
			=== Install an Activity Processing service without a Processing Queue ===
			<section begin="multithreaded_service" />
			'''Activity Processing''' services allow you to automate '''Code Activity''' tasks. If you do not assign a '''Processing Queue''' to the '''Activity Processing''' service, it will pick up tasks in the "default queue", automatically processing any tasks that aren't in a specific '''Processing Queue'''. Creating an '''Activity Processing''' service without a '''Processing Queue''' is generally the easiest way to get started automating steps in a '''Batch Process'''.


			In this scenario, we will install an '''Activity Processing''' service with ''no'' associated '''Processing Queue''' and give it a certain number of threads to use.
			* This service will pick up and process any '''Code Activity''' tasks for '''Batch Process Steps''' with no '''Processing Queue''' assigned.

			{\|class="attn-box"
			\|-
			\|
			⚠
			\|
			'''Be aware of the "n minus one" rule!'''

			Services are assigned a number of CPU threads when you install them. For some services, like '''Import Watcher''', the will always run using a single thread. '''Activity Processing''' services can run using multiple threads.

			Keep in mind, your machine only has a certain number of processing threads available. You '''''will''''' run into errors if you over-allocate your available threads.

			Remember too, the operating system itself must always have a single thread available to run. So, the absolute maximum number of threads you can assign to all your services '''''should not''''' go beyond the total number of threads available minus one reserved for the operating system. Hence, the "n minus one" rule.

			The "n minus one" rule is as follows:
			* If "n" is the maximum number of threads available on your machine, the maximum number of threads you can distribute to Grooper services is "n" minus one.

			'''Be aware of the "n minus x" rule!'''

			Other programs running in the background will need threads to run as well.
			* If SQL is installed on the same machine as your Grooper services, you should follow an "n minus two" rule, reserving one for the OS and one for SQL.
			* If IIS ''and'' SQL are installed on the same machine as your Grooper services, you should follow an "n minus three" rule, reserving one for the OS, one for SQL, and one for IIS.
			* If ''other'' applications, such as anti-virus software, are running in the background you will need to reserve threads for those applications as well.

			'''''THE LONG STORY SHORT HERE IS DO NOT OVER-ALLOCATE YOUR AVAILABLE THREADS! GROOPER CAN BEHAVE ERRATICALLY IF YOU DO!'''''
			\|}

			Open '''Grooper Command Console'''

			{\|class="attn-box"
			\|-
			\|
			⚠
			\|
			Grooper Command Console must be run as an administrator to install, edit, start and stop services.
			\|}

			{{GrooperServiceUserRights}}

			# In '''Grooper Command Console''' enter the following command:
			<pre>services install <connectionNo> <typeName> <userName> <password> [threadCount] [queueName]</pre>
			:* '''<code><connectionNo></code>''' ''(required)'':
			::* Replace this with the integer representing the appropriate connection. Use the <code>connections list</code> command to get a list of your connections.
			:* '''<code><typeName></code>''' ''(required)'':
			::* Since we are installing an '''Activity Processing''' service, replace this with <code>ActivityProcessing</code>.
			:* '''<code><userName></code>''' and '''<code><password></code>''' ''(required)'':
			::* Replace these with the appropriate Active Directory credentials of your Grooper Service User.
			:* '''<code>[threadCount]</code>''' and '''<code>[queueName]</code>''' ''(optional)'':
			::* If you want to specify a specific thread count, replace <code>[threadCount]</code> with an appropriate integer. ''Not setting an integer here will assume the default setting of "multiple" threads.''
			::* If you want to specify a queue name, replace <code>[queueName]</code> with the name of an appropriate '''Processing Queue''' object. ''Leaving this blank will assume the Default processing queue''.
			<section end="multithreaded_service" />

			=== Install an Activity Processing service with a Processing Queue ===
			'''Processing Queues''' allow '''Activity Processing''' services to divide CPU threads amongst different steps in a '''Batch Process'''. This is mechanism that allows you to control how many threads are utilized by specified steps.

			Commonly, a '''Processing Queue''' is created and implemented to throttle certain '''Activities''', such as '''Recognize''' or '''Export''', restricting the maximum number of threads that can be used to process those steps (thus freeing up compute for other '''Activities''').
			* [[Export (Activity)#Processing Queue Guidance\|Refer to this section of the Render article for more information]]
			* In this example, we describe how to implement a single-threaded '''Activity Processing''' service that executes '''Export''' steps using a '''Processing Queue'''.

			=== Install an Activity Processing service for the Render activity ===

			An '''Activity Processing''' service is required to run the '''Render''' activity. This '''Activity Processing''' service must use a specially configured '''Processing Queue'''.
			* The '''Processing Queue''' assigned to any '''Render''' step must have its '''''Concurrency Mode''''' set to ''PerMachine''.
			* [[Render (Activity)#Set up Activity Processing for Render\|Refer to this section of the Render article for more information]]
			** This tutorial will instruct you how to set up a '''Processing Queue''' and '''Activity Processing''' service for a '''Render''' step in a '''Batch Process'''.

			== Addressing "ghost services" - Deleting services from Windows ==

			{{GhostServices}}

Dgreenwood: Removed redirect to 2024:Activity Processing (Service)

2025-02-28T22:38:39Z

Removed redirect to 2024:Activity Processing (Service)

← Older revision		Revision as of 17:38, 28 February 2025
Line 1:		Line 1:
	~~#REDIRECT [[~~2024:~~Activity Processing (Service)]]~~		{{Migrated}}
			{{2024:{{PAGENAME}}}}

Dgreenwood: Dgreenwood moved page Activity Processing (Service) to 2024:Activity Processing (Service)

2025-02-28T22:16:22Z

Dgreenwood moved page Activity Processing (Service) to 2024:Activity Processing (Service)

New page

#REDIRECT [[2024:Activity Processing (Service)]]