Batch Process - General

View, edit, and manage the properties and publication status of a Batch Process.

Remarks

The Batch Process General tab provides a focused interface for configuring the properties of a Batch Process, validating its configuration, and managing its publication status. This control is designed for process designers and administrators, supporting both property editing and workflow lifecycle management in a streamlined, side-by-side layout.

Purpose

Use this tab to inspect and modify process properties, validate the configuration, and publish or unpublish the process for production use. The interface is optimized for clarity and productivity, supporting both iterative design and controlled deployment of batch workflows.

UI Components

• Properties Panel:
  Located on the left, this panel displays a categorized, interactive grid of all editable properties for the selected process.

  • Edit properties inline with real-time validation and contextual help.
  • The {save} and {cancel} buttons become active when edits are made, allowing you to apply or revert changes.

• Toolbar:
  The toolbar above the property grid provides quick access to process lifecycle commands:

  • {validate}: Validate the configuration of the process and its steps.
  • {publish}: Publish the process, making it available for production use.
  • {unpublish}: Remove the process from production use.
  • {save}: Save changes to process properties.
  • {cancel}: Discard unsaved changes and revert to the last saved state. Button states are context-sensitive, enabling or disabling based on the process's current status and whether there are unsaved changes.

• Splitter Controls:
  The layout uses a vertical splitter, allowing you to resize the properties panel for optimal viewing.

Usage Guidance

1. Edit process properties in the property grid.
   • After making changes, click {save} to apply or {cancel} to revert.
2. Use the {validate} button to check the configuration for errors or warnings before publishing.
3. Use {publish} to make the process available for batch creation and production use.
4. Use {unpublish} to remove the process from production, preventing new batches from using it.
5. Resize the panel as needed for your workflow using the splitter.

Example

The following diagram illustrates the typical layout of the Batch Process General tab:

┌───────────────────────────────────────────────────────────────────────────────┐
│ PROPERTIES                   {validate} {publish} {unpublish} {save} {cancel} │
├───────────────────────────────────────────────────────────────────────────────┤
│ {Property Grid}                                                               │
│ ┌───────────────────────────────────────────────────────────────────────────┐ │
│ │ Category: General                                                         │ │
│ │  - Name: {Text Box}                                                       │ │
│ │  - Description: {Text Area}                                               │ │
│ │  - Content Type: {Drop-down}                                              │ │
│ │  - Steps: {Expandable List}                                               │ │
│ │  ...                                                                      │ │
│ └───────────────────────────────────────────────────────────────────────────┘ │
└───────────────────────────────────────────────────────────────────────────────┘

• {Property Grid}: Edit process properties and steps.
• {validate}: Check the process for configuration errors or warnings.
• {publish}: Make the process available for production use.
• {unpublish}: Remove the process from production.
• {save}, {cancel}: Manage property changes.

Accessibility

• All controls are fully navigable by keyboard and mouse.
• The property grid supports keyboard navigation, inline editing, and contextual help.
• The layout is resizable for user preference and accessibility needs.
• Button states and tooltips provide guidance for available actions.

Command Buttons

Button	Shortcut Key		Summary
verified validate		►	Validate the configuration of this batch process. The validate button checks the configuration of the Batch Process and its steps for errors or warnings. Use this command to ensure all required properties are set and that the process is ready for publishing or production use. Validation results are displayed in the property grid, with errors and warnings highlighted for review. Only enabled when there are no unsaved changes.
publish publish		►	Publishes the working version of a Batch Process, making it available for production use. Use this command to activate a Batch Process so it can be used for processing documents. If a published version already exists, it will be archived before publishing the new version. If the current working version matches an archived version, the archived version will be re-published. The published process is set to read-only and stored in the 'Processes' folder. The 'Published Date' and 'Published Version Id' properties are updated on both the working and published versions. If no changes have been made since the last publish, the command will not create a new version.
disabled_visible unpublish		►	Unpublishes a Batch Process, making it unavailable for production use in the local Grooper repository. Use this command to deactivate a Batch Process that was previously published. The active published version is archived and removed from the 'Processes' folder. The working version's 'Published Version Id' and 'Published Date' properties are cleared. The Batch Process will no longer be available for processing new Batch objects. This does not delete the process or its configuration; it only removes it from production use.
save save		►	Save changes. The save button applies any edits made in the property grid to the batch process. Only enabled when there are unsaved changes. Commits all property edits and updates the process. The property grid will refresh with updated values after saving.
cancel cancel		►	Discard changes. The cancel button reverts any unsaved edits in the property grid, restoring the last saved state. Only enabled when there are unsaved changes. Use to undo edits and return to the previous configuration. The property grid will reload the last saved values after canceling.

Child Controls

Name	Type		Summary
Properties	Property Grid	►	Displays the properties of this batch process in a categorized, editable grid. The Property Grid presents all configurable properties of the selected Batch Process in a structured, interactive format. Properties are grouped by category for easy navigation. Edit values directly in the grid; changes are validated in real time. Contextual help is available for each property, including summaries, usage notes, and validation messages. When edits are made, the {save} and {cancel} buttons become active, allowing you to apply or revert changes. Keyboard navigation and inline editing are fully supported. Right-click to access context menu commands such as Clear, Reset, Copy, and Paste.

Used By

Design Tab Host