Scripting Setup - Revision history

Dgreenwood at 19:11, 17 March 2026

2026-03-17T19:11:00Z

← Older revision		Revision as of 14:11, 17 March 2026
Line 28:		Line 28:
	#* This should '''''not''''' be the production web server or processing servers.		#* This should '''''not''''' be the production web server or processing servers.
	#* Scripting on a production server can cause problems for performance and stability.		#* Scripting on a production server can cause problems for performance and stability.
			#* Visual Studio 2022 is the supported version for developing with Grooper 2025.
	# You must install the '''Grooper SDK''' Visual Studio extension.		# You must install the '''Grooper SDK''' Visual Studio extension.
	#* Grooper SDK is required to successfully edit scripts and debug them in Visual Studio. It synchronizes your debug session with a browser window, creating a developer experience similar to standard web application debugging in Visual Studio. It also provides commands to push local edits to the Grooper Repository and check for any changes made by other developers.		#* Grooper SDK is required to successfully edit scripts and debug them in Visual Studio. It synchronizes your debug session with a browser window, creating a developer experience similar to standard web application debugging in Visual Studio. It also provides commands to push local edits to the Grooper Repository and check for any changes made by other developers.

Dgreenwood: /* Common Overrides */

2025-10-09T19:12:14Z

Common Overrides

← Older revision		Revision as of 14:12, 9 October 2025
Line 601:		Line 601:
	* <code>ValidateProperties()</code> - Validates the properties of the object, returning a list of validation errors. Derived classes may override this method to add validation logic. Classes which override this message should always call <code>MyBase.ValidateProperties()</code>, add any new error messages to the returned list, and then return the list.		* <code>ValidateProperties()</code> - Validates the properties of the object, returning a list of validation errors. Derived classes may override this method to add validation logic. Classes which override this message should always call <code>MyBase.ValidateProperties()</code>, add any new error messages to the returned list, and then return the list.
	* <code>ToString()</code> - Returns a string value representation of the object. This may be overridden to return a custom string value that is displayed in the property grid. For example, an EmbeddedLexicon object overrides <code>ToString</code> to return the number of Lexicons and/or Entries that it represents.		* <code>ToString()</code> - Returns a string value representation of the object. This may be overridden to return a custom string value that is displayed in the property grid. For example, an EmbeddedLexicon object overrides <code>ToString</code> to return the number of Lexicons and/or Entries that it represents.

			== Debugging a Custom Service in Grooper ==
			=== Step-by-Step Workflow ===
			<big>Create an Object Library</big>
			* Define a new Object Library in Grooper to host your custom service.
			<big>Design your custom service</big>
			* Implement your service class (e.g., <code>ImportDustin</code>) inheriting from <code>ImportWatcher</code> or <code>ServiceInstance</code>.
			<big>Compile the service from the Design page</big>
			* Build the project in Debug mode with full symbol generation (.pdb file).
			* Ensure the output DLL and PDB are placed in the working directory.
			<big>Install the service using Grooper Command Console (GCC)</big>
			* Use the full type name (e.g., <code>DustinService.ImportDustin</code>) when installing the service.
			<big>Configure the service from the Design page</big>
			* Go to the Object Library and configure the service settings (e.g., credentials, parameters).
			<big>Run the Design page from your custom service's Visual Studio project</big>
			* Run your custom library from Visual Studio to launch the Design page as the debug target.
			<big>Start the service from the Machines folder</big>
			* Navigate to the Machines folder from the Design page.
			* Select the "Services" tab.
			* Select your custom service and click Start.
			===Expected Result===
			If everything is configured correctly, breakpoints in your custom service code will hit during execution.

Dgreenwood: /* Scripting templates */

2025-09-23T14:27:42Z

Scripting templates

← Older revision		Revision as of 09:27, 23 September 2025
Line 404:		Line 404:
	* "Timer Service" to create custom services that run at regularly scheduled intervals (Both Import Watcher and System Maintenance Service inherit from Timer Service).		* "Timer Service" to create custom services that run at regularly scheduled intervals (Both Import Watcher and System Maintenance Service inherit from Timer Service).
	* "Custom Web Service" to create custom services that use web calls (The Grooper Licensing service inherits from Timer Service).		* "Custom Web Service" to create custom services that use web calls (The Grooper Licensing service inherits from Timer Service).
			<br clear=all>

	=== Serialization ===		=== Serialization ===

Dgreenwood: /* Scripting templates */

2025-09-23T14:27:28Z

Scripting templates

← Older revision		Revision as of 09:27, 23 September 2025
Line 396:		Line 396:

	=== Scripting templates ===		=== Scripting templates ===
			[[File:2025-templates.png\|thumb\|600px\|right\|When creating a new item, press "Show All Templates" to see the Grooper templates.]]
			When you create a new Grooper scripting project in Visual Studio, there are several templates that can help get you started creating Object Libraries.

	When ~~you create~~ a new Grooper ~~scripting project in Visual Studio~~, ~~there are several templates~~ that can ~~help get you started creating Object Libraries~~.		When adding a new item to your solution, press the "Show All Templates" button to see the Grooper templates. You will see multiple script templates for commonly created objects, such as:
			* "Custom Code Activity" to create custom Grooper activities you can add to a Batch Process.
			* "Object Command" to create custom commands that can be applied from the Design page or by users in the * Review interface.
			* "Timer Service" to create custom services that run at regularly scheduled intervals (Both Import Watcher and System Maintenance Service inherit from Timer Service).
			* "Custom Web Service" to create custom services that use web calls (The Grooper Licensing service inherits from Timer Service).

	=== Serialization ===		=== Serialization ===

Dgreenwood: /* Scripting templates */

2025-09-23T14:03:48Z

Scripting templates

← Older revision		Revision as of 09:03, 23 September 2025
Line 396:		Line 396:

	=== Scripting templates ===		=== Scripting templates ===

			When you create a new Grooper scripting project in Visual Studio, there are several templates that can help get you started creating Object Libraries.

	=== Serialization ===		=== Serialization ===

Dgreenwood: /* More on Scripting */

2025-09-23T14:01:07Z

Dgreenwood: /* Creating and debugging Grooper scripts */

2025-09-03T13:40:14Z

Creating and debugging Grooper scripts

← Older revision		Revision as of 08:40, 3 September 2025
Line 132:		Line 132:

	== Creating and debugging Grooper scripts ==		== Creating and debugging Grooper scripts ==
			<section begin="Object Library" />
	=== Example Object Library for a simple Command ===		=== Example Object Library for a simple Command ===

Line 372:		Line 372:

	<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmacxocc402bz0e0i4mp7l9jw?embed_v=2&utm_source=embed" loading="lazy" title="2025Wiki - Scripting Setup - 09 Saving to Grooper and compiling (with "Save")" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>		<div style="position: relative; box-sizing: content-box; max-height: 80vh; max-height: 80svh; width: 100%; aspect-ratio: 1.7777777777777777; padding: 40px 0 40px 0;"><iframe src="https://app.supademo.com/embed/cmacxocc402bz0e0i4mp7l9jw?embed_v=2&utm_source=embed" loading="lazy" title="2025Wiki - Scripting Setup - 09 Saving to Grooper and compiling (with "Save")" allow="clipboard-write" frameborder="0" webkitallowfullscreen="true" mozallowfullscreen="true" allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>
			<section end="Object Library" />

	== Thing you can't do in web client scripts ==		== Thing you can't do in web client scripts ==

Dgreenwood: /* Attributes */

2025-08-12T21:03:18Z

Attributes

← Older revision		Revision as of 16:03, 12 August 2025
Line 459:		Line 459:
	* <code>Category</code>: Specifying a category will create titled groups in the property grid. Any properties with equivalently named categories will be grouped under that category name.		* <code>Category</code>: Specifying a category will create titled groups in the property grid. Any properties with equivalently named categories will be grouped under that category name.
	*: Example: <code>[Category("File Store Information"), Viewable]</code>		*: Example: <code>[Category("File Store Information"), Viewable]</code>
	* <code>TypeConverter</code>: Provides a way of converting types of values to other types, as well as for accessing standard values and subproperties. See #[Property Grid Editors and Type Converters] for more information.		* <code>TypeConverter</code>: Provides a way of converting types of values to other types, as well as for accessing standard values and subproperties. See [[#Property Grid Editors and Type Converters]] for more information.
	* <code>UI</code>: Used to design value editors that can provide a user interface (UI) for representing and editing the values of Grooper objects. See [[#Property Grid Editors and Type Converters]] for more information.		* <code>UI</code>: Used to design value editors that can provide a user interface (UI) for representing and editing the values of Grooper objects. See [[#Property Grid Editors and Type Converters]] for more information.
	* <code>AppliesTo</code>: Class attribute that includes a public Type property, indicating an exclusive type to which the class applies.		* <code>AppliesTo</code>: Class attribute that includes a public Type property, indicating an exclusive type to which the class applies.

Dgreenwood: /* Attributes */

2025-08-12T20:45:46Z

Attributes

← Older revision		Revision as of 15:45, 12 August 2025
Line 464:		Line 464:
	* <code>Viewable</code>: The viewable attribute is required for properties that will be displayed to the user. Developed to allow for the filtering of object collections, based on type application.		* <code>Viewable</code>: The viewable attribute is required for properties that will be displayed to the user. Developed to allow for the filtering of object collections, based on type application.
	* <code>Required</code>: The required attribute causes the property to generate a validation error if the property is not set.		* <code>Required</code>: The required attribute causes the property to generate a validation error if the property is not set.
	* <code>AllowedScopes()</code>: ~~Useful when setting a custom~~ Activity's allowable processing scopes. May be one or more of the following:		* <code>AllowedScopes()</code>: Used to set an Activity's allowable processing scopes. May be one or more of the following:
	** <code>GrooperDb.ProcessingScope.Batch</code>		** <code>GrooperDb.ProcessingScope.Batch</code>
	** <code>GrooperDb.ProcessingScope.Folder</code>		** <code>GrooperDb.ProcessingScope.Folder</code>

Dgreenwood: /* More on Scripting */

2025-08-12T20:36:03Z

← Older revision		Revision as of 09:01, 23 September 2025
Line 390:		Line 390:

	== More on Scripting ==		== More on Scripting ==

			=== Grooper Object inheritance ===

			Nearly everything in Grooper inherits from "Grooper Object". Check out the [[Grooper Object]] and [[List of Grooper Objects]] pages for a full list of all objects that inherit from Grooper Object.

			=== Scripting templates ===

	=== Serialization ===		=== Serialization ===

← Older revision		Revision as of 15:36, 12 August 2025
Line 389:		Line 389:

	== More on Scripting ==		== More on Scripting ==

	~~THIS SECTION IS UNDER CONSTRUCTION!~~

	~~THIS INFORMATION MAY BE OUT OF DATE AND IS ACTIVELY BEING REVIEWED~~

	=== Serialization ===		=== Serialization ===