Object Library (Node Type)

This article is about the current version of Grooper. Note that some content may still need to be updated.
2025	2023

extension Object Library nodes are .NET libraries that contain code files for customizing the Grooper's functionality. These libraries are used for a range of customization and integration tasks, allowing users to extend Grooper's capabilities.

Examples include:

• Adding custom Activities that execute within Batch Processes
• Creating custom commands available during the Review activity and in the Design page.
• Defining custom methods that can be called from code expressions on Data Field and Batch Process Step objects.
• Creating custom Connection Types for CMIS Connections for import/export operations from/to CMS systems.
• Establish custom Grooper Services that perform automated background tasks at regular intervals

Object Libraries are used to customize Grooper with scripting. They can be used to create a variety of new tools, including custom Activities, custom object commands, custom CMIS Connection types and more.

More information on scripting can be found on the Scripting Setup article. This includes an example of how to create an Object Library that creates a simple custom Grooper Command.

How To: Upload and compile an Object Library

This tutorial is for users who are attempting to import an Object Library developed by BIS or another Grooper user into their own environment. This will explain how to upload an Object Library to a Project in your environment and compile it.

Upload the Grooper ZIP

1. Go to the Grooper Design page.
2. Select the Project where you want to import the Object Library.
   • Note: If the Grooper ZIP is itself a Project that contains the Object Library, you will need to import from the Projects folder node.
3. Press the "Upload" button in the top navigation bar.
4. Press the "Choose File" button. Use the File Explorer to select the Grooper ZIP.
5. Press the "Upload" button.
6. The Object Library will be imported into the selected Project

Compile the Object Library

In order for the Object Library to work, its code must first be compiled.

1. Select the Object Library you wish to compile.
2. Navigate to the "Scripting" tab.
3. Press the "Compile" button.
4. Grooper will notify you when the compile is successful or has failed. Click "OK" to continue.

   • Compiling the script in Grooper creates the release DLL necessary to execute your script. After compiling, you will see two new files: the compiled DLL and an XML descriptor file

5. Go to the webserver host machine and recycle the Grooper App Pool in IIS.
   • Changes will not take effect until the Grooper App Pool is recycled.
   • Recycling the app pool is necessary for the application to "see" the new DLL.
6. If the script is executed by a Grooper service, services will need to be restarted as well. This will ensure the services register the newly compiled DLLs.
   • Example: An Object Library scripts a custom Activity. Activity Processing services will need to be restarted before they can execute the custom Activity's tasks.
   • Example: An Object Library scripts a custom CMIS Connection type. Import Watcher services will need to be restarted before they can import content using the custom CMIS Connection type. Activity Processing services will need to be restarted before executing Export tasks utilizing the custom CMIS Connection type.
7. Your script is now active in Grooper. You should test the script in Grooper at this point.

How To: Manually install the compile tool

In some cases the Grooper compile tool (MSBuild) does not install correctly, preventing users from compiling scripts (The "Compile" button will be greyed out). In this case, you can manually install the compile tool.

1. Download "MSBuild.zip" from https://grooper.bisok.com/Downloads/MSBuild/MSBuild.zip
2. Extract the ZIP contents.
3. Copy the "MSBuild" folder to the "Script Templates" folder in your Grooper install directory.
   • By default this location will be C:\Program Files\BIS\Grooper\Script Templates
4. If Design Studio is open, close it and re-open it. You should now be able to compile scripts.