2023:Object Library (Node Type)

From Grooper Wiki

STUB

This article is a stub. It contains minimal information on the topic and should be expanded.

An Object Library is a .NET framework library containing custom objects used to customize the way Grooper works.

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.

How To

Import 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.

⚠

PLEASE NOTE: In version 2023, Object Libraries must be compiled in the Grooper Windows client (thick client), even if they are functional in the web client.

Import the Grooper ZIP


Copy the Grooper ZIP containing the Object Library to your Grooper server and Open Grooper Design Studio.

  1. Right click 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.
  2. Select Share > Import ZIP Archive...

The "Import ZIP Archive" dialog will pop up.


  2. Using the Filename property, select the Grooper ZIP you wish to import.
  3. Press the "Execute" button when finished.


  2. If successful you will see a dialog noting the file was imported. Press "OK" to continue.
  3. The Object Library will be imported to 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. Wait for the script to complete compiling. You will see a message in the "Output" window noting it compiled successfully (or failed).
  5. Close and re-open Grooper Design Studio.
    • This is an important but sometimes overlooked step. You must close and re-open Grooper Design Studio in order to register the newly compiled DLLs.

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.
Retrieved from "https://wiki.grooper.com/index.php?title=2023:Object_Library_(Node_Type)&oldid=19234"