Batch

A Batch is a hierarchy of folders and pages which serves as the fundamental unit of capture in Grooper.

Remarks

Batches can exist in one of two environments: Test or Production. Test batches are only visible to administrators working in Grooper Design Studio. Production batches are visible to all system users who have the appropriate access rights.

Inherits from: Grooper Node

Properties

The following 9 properties are defined.

Property Name	Description
General
Priority	Type: Int32, Default: 3, Range: 1 - 5 The priority of the batch. The Priority value controls the order in which tasks are processed, with the value 1 representing the highest priority level, and the value 5 representing the lowest priority level. (i.e. Items of priority 1 are processed before items of Priority 2, and so on. The batch must be paused before this property can be edited.
Current Step	Type: Batch Process Step The Batch Process Step within the Batch Process which this batch is currently processing through. The batch must be paused before this property can be edited.
Description	Type: String Specifies a description for the item.
Batch Information
Created	Type: DateTime The date and time when this batch was created.
Created By	Type: String The user id under which the batch was created.
Current Step No	Type: Int32, Default: 0 The current step of the batch process that this batch is on.
Current Step Name	Type: String The current step of the batch process that this batch is on.
Current Step Activity Name	Type: String The name of the activity associated with the current step.
Status	Type: ProcessingStatus, Default: None The current status of the batch. Can be one of the following values: None - No status has been assigned. Ready - Ready to be processed. Working - Processing is in progress. Completed - Processing is completed. Paused - Processing has been paused. Error - An error has occurred.

Commands

	Command Name	Shortcut Keys	Description
	Add Multiple Items		Creates multiple items as children of the selected object.
	Clear Children		Deletes all children of the selected object(s).
	Batch - Clone To Production		Clones the batch into production, and launches it into a Batch Process.
	Batch - Clone To Test		Clones this production batch to the 'Production Clones' folder of the test branch.
	Batch - Combine		Combine the selected batches into a single batch.
	Export to Zip Archive		Exports a set of Grooper nodes to a ZIP archive.
	Batch - Pause		Pause processing on the batch.
	Batch - Process		Process the batch through the current step.
	Publish to Grooper Repository		Publishes one or more Nodes to one or more Target Grooper Repositories.
	Batch - Reset		Move the batch to a different Batch Process Step, optionally resetting tasks for folders or pages which have already been processed.
	Batch - Resume		Resume processing on the batch.
	Unpublish		Unpublishes a set of Grooper Nodes to a Target Grooper Repository.
	Batch - Update Process		Updates or changes the Batch Process associated with this batch.

Tabs

Tab Name	Description
Batch - General	Provides a user interface displaying the properties of a Batch and a list of Tabs showing various details about the Batch including Processing Status, Processing History, Event Log History, Current Tasks, Activity Statistics, a Batch Viewer and Batch Details.
Batch - Batch Viewer	Provides a user interface for viewing and managing the contents of a Batch.
Grooper Node - Scripting	Provides script viewing, compilation, management, and basic editing features.
Grooper Node - Contents	Provides a user interface for viewing and managing the children of a Grooper Node.
Grooper Node - Advanced	Displays detailed information about Grooper Node objects, and provides administrative functions for managing them.

Used By