2023:Object Library (Node Type): Difference between revisions

From Grooper Wiki
← Older editNewer edit →
m Dgreenwood moved page Object Library to 2023:Object Library
Line 20: Line 20:


==== Import the Grooper ZIP ====
==== Import the Grooper ZIP ====
 
{|class="how-to-table"
|-
|
Copy the Grooper ZIP containing the '''Object Library''' to your Grooper server and Open Grooper Design Studio.
Copy the Grooper ZIP containing the '''Object Library''' to your Grooper server and Open Grooper Design Studio.


Line 28: Line 30:


The "Import ZIP Archive" dialog will pop up.
The "Import ZIP Archive" dialog will pop up.
 
|
[[File:2023 ObjectLibrary 02 01 Import 01.png]]
|-
|
#<li value=3> Using the '''''Filename''''' property, select the Grooper ZIP you wish to import.
#<li value=3> Using the '''''Filename''''' property, select the Grooper ZIP you wish to import.
# Press the "Execute" button when finished.
# Press the "Execute" button when finished.
|
[[File:2023 ObjectLibrary 02 01 Import 02.png]]
|-
|
#<li value=5> If successful you will see a dialog noting the file was imported.  Press "OK" to continue.
#<li value=5> If successful you will see a dialog noting the file was imported.  Press "OK" to continue.
# The '''Object Library''' will be imported to the selected '''Project'''.
# The '''Object Library''' will be imported to the selected '''Project'''.
|
[[File:2023 ObjectLibrary 02 01 Import 03.png]]
|}


==== Compile the Object Library ====
==== Compile the Object Library ====

Revision as of 13:12, 6 February 2024

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