Add-on Installation

seeq.addons.correlation.__main__.cli_interface()

Command line utility to install the Correlation Add-on Tool

seeq.addons.correlation.__main__.create_udfs(api_client, *, permissions_groups: list | None = None, permissions_users: list | None = None)

Creates the required Formula UDFs for the Correlation app

Parameters:

• api_client (seeq.sdk.api_client.ApiClient) – The seeq.sdk API client that handles the client-server communication

• permissions_groups (list) – Names of the Seeq groups that will have access to each tool

• permissions_users (list) – Names of Seeq users that will have access to each tool

Returns:

- – The Correlation UDFs will be available in Seeq Workbench

Return type:

None

seeq.addons.correlation.__main__.install_app(sdl_url_, *, sort_key='a', permissions_group: list | None = None, permissions_users: list | None = None)

Installs Correlation as an Add-on Tool in Seeq Workbench

Parameters:

• sdl_url (str) – URL of the SDL container. E.g. https://my.seeq.com/data-lab/6AB49411-917E-44CC-BA19-5EE0F903100C/

• sort_key (str, default 'a') – A string, typically one character letter. The sort_key determines the order in which the Add-on Tools are displayed in the tool panel.

• permissions_group (list) – Names of the Seeq groups that will have access to each tool. If None, the “Everyone” group will be used by default.

• permissions_users (list) – Names of Seeq users that will have access to each tool. If None, no individual users will be given access to the tool.

Returns:

- – Correlation Analysis will appear as Add-on Tool(s) in Seeq Workbench

Return type:

None

seeq.addons.correlation.__main__.install_nbextensions()

Installs the Jupyter nbextensions required to render the Add-on

Returns:

-

Return type:

None

seeq.addons.correlation.__main__.logging_attempts(_user)

Allows user to re-enter credentials multiple times in the event of authentication failure

Parameters:

_user (str) – Seeq username that needs to be authenticated

Returns:

-

Return type:

None