View source for Object Library (Node Type)

{{AutoVersion}}

<blockquote>{{#lst:Glossary|Object Library}}</blockquote>

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

'''''Be sure to check out the [[Scripting Setup]] article for more information on how to set up a Grooper scripting environment.'''''

== 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 ===

# Go to the Grooper Design page.
# 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.
# Press the "Upload" button in the top navigation bar.
# Press the "Choose File" button. Use the File Explorer to select the Grooper ZIP.
# Press the "Upload" button.
# 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.
# Select the '''Object Library''' you wish to compile.
# Navigate to the "Scripting" tab.
# Press the "Compile" button.
# Grooper will notify you when the compile is successful or has failed. Click "OK" to continue.
#:*<li class="fyi-bullet"> 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
# 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.
# 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.
# Your script is now active in Grooper. You should test the script in Grooper at this point.

== Example from the Scripting Setup article ==

'''''This example is transcluded from a larger article. Visit the [[Scripting Setup]] article for more information'''''
{{#lst:Scripting Setup|Object Library}}

== How To: Manually install the compile tool ==

In rare 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.

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