Creating an Add-on Tool

Add-on tools can be created by using the User Tool Creator, which is a home screen Add-on.

Installation

An Admin needs to install the User Tool Creator from using the Add-on Manager.

Installing New Add-on Tools

The User Tool Creator is used to install additional Add-on Tools. This section goes through the various inputs for each of the tools.

Tool Name: The name of the tool shown in green text in the Add-on Tool button.
Description: The description shown in black text underneath the Name. Long descriptions will wrap to the next line and increase the height of the Add-on Tool button.
Icon: Any Font Awesome icon to show in green next to the Name. Potential Font Awesome icons can be found at the website https://fontawesome.com/v4.7.0/icons/ and take the form of “fa fa-<icon>”
Target URL: The target is the URL that you want opened. This can link to a website or most commonly is a Seeq Data Lab Notebook in Add-on Mode . In order to get the Target URL for a Seeq Data Lab Notebook, open the desired Notebook in Add-on Mode and copy the URL that includes “/addon/” that indicates the Notebook is in Add-on Mode. Example: CODE `https://try.seeq.com/data-lab/F75365B4-C764-4236-8B5B-AE3AC54FE0E6/addon/Add-on_Tool.ipynb?`
Location: Choose whether the Add-on Tool should launch a new tab or window. Tab - Open in new tab Window - Open in new window and choose the characteristics of the window such as width and height in pixels and position on screen.
Reuse Display: Identifies whether a new window is opened each time the tool card is clicked or if it reuses the currently open tab/window.
Include Seeq Workbook Parameters: The special `workbookId`, `worksheetId`, `workstepId`, and`seeqVersion` parameters will automatically be appended to the Target URL when the Add-on is launched.
Add Query Parameter: Define custom query parameters to include in the Target URL The Target URL with all query parameters will be passed to the special variable, `jupyter_notebook_url`, when the Add-on is launched.

Managing User Created Add-on Tools

Once an Add-on Tool is created it will automatically be adopted by the Add-on Manager, but can take up to 1 hour to appear in the Add-on Manager. The Add-on Manager can then be used to manage access or uninstall the Add-on.

Uninstalled Add-ons will have their underlying project archived. If the project is still required after uninstalling it can be restored from the Trash of the user who owned the project (located on the users home screen)