Plugins

Plugins extend TAS with additional features, such as connections to AI services, integrations with external systems, or new smart events and crons. On the Plugins page you can see the installed plugins and their status, configure them, and install new versions from the plugin store. The page is available to administrators; open it from the Administration menu using the Plugins tile in the Application management and configuration group.

The page has three tabs: Plugins, Configuration and Plugin store.

Plugins

No.ElementPurpose
1PluginsTab with the installed plugins.
2ConfigurationTab with plugin settings.
3Plugin storeTab with plugins available for installation.
4CloseReturns you to the Administration menu.
5Updates onlyShows only plugins that have a newer version in the store. The number in brackets is their count.
6Update allDownloads and installs the latest versions of all plugins that have one.
7NamePlugin name.
8Installed versionVersion on the server.
9Available versionVersion in the store. A red label with an arrow means a newer version is available. ✓ Up to date means you have the latest one.
10CategoryFor example ai, integration, security, utility.
11AuthorWho published the plugin.
12CapabilitiesWhat the plugin adds: its own REST API, crons, functions for calculations, smart events or AI tools.
13StatusActive, Error (the plugin failed to load) or Restart required.
14Row actionsThe View, Update and Remove menu.

The Updates only and Update all buttons and the Available version column are shown only when the installation has a plugin store configured. When an installation or removal is waiting for a restart, a Restart button appears in the header.

ActionWhat happens
ViewOpens the plugin detail. Double-clicking the row does the same.
Update (version)Downloads the new version from the store and installs it. Offered only when a newer version is available.
RemoveAfter you confirm Do you really want to remove the plugin?, the plugin is deleted from the server. To remove it completely from all instances, the backends must be restarted.

Plugin detail

The detail shows the status, version, description, author, category, TAS compatibility (the range of TAS versions the plugin is intended for), Folder name on the server and Capabilities. If the plugin failed to load, a red box with the reason is shown at the top. The screenshot shows a plugin intended for older TAS versions, which is why it failed to load.

Installation and restart

A new or updated plugin version takes effect only after the backends are restarted. Procedure:

  1. Install or update the plugin (the Update or Update all action, or Install in the store). Before installing, the application checks that the package contains a valid plugin descriptor, that the plugin is compatible with your TAS version and that the server can write to the plugins folder.
  2. The plugin gets the Restart required status and Restart appears in the header.
  3. Click Restart. The application asks Do you really want to restart all backends? and warns you that you are restarting the whole application for all users.
  4. After you confirm, Restarting backends… is displayed and the application waits until the backends start again (at most 2 minutes). It then reports Restart initiated on all backends.
A restart disconnects all users
A restart shuts down all backends at once. Users briefly lose their connection and requests in progress are interrupted. The backends are started again by the server environment. Therefore, restart outside working hours and notify users in advance, for example with a news item.

Configuration

On the left is a list of plugins that have their own settings; on the right is the settings form of the selected plugin. Some plugins have settings in JSON form, where each key represents one named connection. Save your changes with the Save or Save and close button. If you switch to another plugin with unsaved changes, the application asks Save changes?.

In the screenshot there is no plugin with settings, so No plugins with configuration found is displayed.

Plugin store

No.ElementPurpose
1SearchSearches for a plugin by name.
2CategoryAll, AI, Integration, Security, Tools, Utility, Other.
3SortSorts by name in ascending or descending order.
4Plugin cardName, version in the store, installed version, description and author.
5Action buttonInstall, Update, Installed or Restart required, depending on the plugin status.

The store offers only plugins compatible with your TAS version. If the installation has no store configured, Plugin store is not configured is displayed.

Related: Crons, Configuration, Logs.

Configuration

Email Queue
Syca (opens in a new tab)

Powered by HelpDocs (opens in a new tab)