Plugins
- Synopsis
- Full Details
In briefA plugin packages one or more job types, and sometimes connection types. Each plugin is enabled or disabled per tenant, and so is each of its job types. Only job types that are on, in a plugin that is on, are offered for new jobs. Turning something off never stops the jobs that already use it.
WhereAgents › Marketplace. Each card has an enable switch; opening a plugin shows its Job Types, with a switch for each, and any Related Connection Types.
When
- A job type you expect is missing from the builder.
- Your authors are offered job types your organization does not use — Corelation or WS_FTP Pro when you run only Windows Command jobs, say.
- You want to make a disabled plugin's job types available to your tenant again.
How
- Open Agents › Marketplace and find the plugin by search or category.
- To change the whole plugin, use its switch. To change one job type, open the plugin and use that job type's switch under Job Types.
- Turning something off opens a confirmation that says how many jobs use it. Select OK to go ahead.
- Open the builder and confirm the job type is offered, or no longer offered.
The full steps are in Manage plugins.
- Built-in, internal, legacy LSAM, OpCon MFT, OpCon RPA and EASE plugins are enabled by default — every plugin shipped today — and so is every job type in them.
- Job types you turn off stay off while the plugin is off, and when you turn it back on.
- An enabled OpCon MFT, OpCon RPA or EASE plugin still needs a relay that can serve its agent type and a registered agent.
- Turning off a job type takes it out of the Job Type list for every author in the tenant. Jobs that already use it keep running, but no new job can be given that type until it is back on.
- Turning a plugin off also takes its connection types out of the lists; turning a single job type off does not.
Plugins define the job types (connectors) jobs can run. See How connectors work.
Task walkthrough: Manage plugins. This page is the full configuration and troubleshooting reference.
A plugin packages one or more job types (and sometimes connection types). The Marketplace page lets an administrator see what's available, enable or disable plugins per tenant, and turn single job types of a plugin on or off.
Marketplace
The Marketplace page (Agents › Marketplace) shows each plugin as a card with its display name, internal name, category, version, how many job types it provides (12 job types) and an enable switch. The display name is the plugin's own — Windows LSAM, not the name of one of its job types — because the switch turns every one of those job types on or off together. When some of an enabled plugin's job types are turned off, the count says so: 3 of 12 job types on. A Default badge marks a plugin that is on by default and has not been changed for the tenant; a Disabled badge marks one that is off, and its card shows the plain total. Search and an All categories filter narrow the list.
Opening a plugin shows its description, its Job Types with a switch for each, and a Details list with its category, version and Job Types — the total, or N of M on when some are turned off. A plugin that provides connection types lists them under Related Connection Types, and each one opens a new connection of that type.
Turn job types on or off
A plugin's Job Types card lists every job type it provides by display name, sorted by name, with a switch beside each: Choose which of this plugin's job types are offered for new jobs. Turn one off and it is no longer offered for new jobs; the rest of the plugin is unchanged. So a tenant that runs Windows Command jobs can turn off Windows - Corelation, Windows - Fiserv DNA or Windows - WS_FTP Pro and keep the other Windows job types.
- A job type with no setting is on whenever its plugin is on — including a job type a later version of the plugin adds.
- While the plugin is off, every switch shows off and cannot be changed, with Turn on the plugin to choose which of its job types are offered. Your choices are kept: turn the plugin back on and the job types you turned off are still off, and the rest are on.
- Any job type can be turned off, the built-in and internal ones included.
- Settings are per tenant. They do not change what another tenant is offered.
- Turning a job type off never hides a connection type. Connection types follow the plugin switch only.
Before anything is turned off: how many jobs use it
Turning on a plugin or a job type applies at once. Turning one off — a job type's switch, or a plugin's switch on its card or its own page — first opens Turn Off Job Type or Turn Off Plugin, which counts the jobs that use it:
| The count | What the dialog says |
|---|---|
| Still counting | Checking which jobs use <name>… — OK waits; Cancel works |
| Jobs use it | <N> jobs in <W> workflows use <name>. They will keep running, but new jobs cannot use it. (for a plugin, its job types) |
| No job uses it | No jobs use <name>. New jobs will not be able to use it. (for a plugin, its job types) |
| The count failed | The number of jobs that use <name> could not be checked. Jobs that use it will keep running, but new jobs cannot use it. (for a plugin, its job types and them) — OK still works |
Each message ends Do you want to continue? OK makes the change; Cancel leaves the switch as it was. A plugin's count covers all of its job types, on or off. The count is of jobs in the current version of every workflow in the tenant, across every workspace, and it never names a workflow. Counting needs the permission to view job instances; without it, or when the count cannot be reached, the dialog says the number could not be checked and still lets you continue.
What turning off changes, and what it does not
| A job type or plugin that is turned off | |
|---|---|
| Job Type list in the job editor, and Quick Add by Job Type | Not offered for a new job, or for changing a job's type |
| An existing job of that type | Opens with its job type still selected, under its display name. You can keep it, or change to an offered type — once you do, the turned-off type is no longer offered for that job |
| Saving a workflow that holds such a job | Saves as before |
| Running such a job | Runs as before: turning a plugin or job type off does not stop the jobs that already use it |
| Connection types | Unchanged by a job type's switch; a plugin's switch still takes its connection types out of the lists |
A change can take up to five minutes to reach a job editor that is already open.
Categories: Database, File Transfer, Script, Container, Integration,
Utility, Custom and Internal, as the cards and the category filter show them. A plugin's
Details list shows its Category as the raw value instead: DATABASE, FILE_TRANSFER,
SCRIPT, CONTAINER, INTEGRATION, UTILITY, CUSTOM or INTERNAL.
Installation and enablement (per tenant)
| Setting | Notes |
|---|---|
| Plugin name | The internal name shown under the display name, e.g. builtin:command, opcon.lsam.sql. |
| Installed versions | Versions available to the tenant. |
| Default version | The version new jobs use. |
| Enabled | Whether the plugin is enabled for the tenant: the plugin's switch, which reads Enabled or Disabled on its page. |
Default visibility
| Plugin prefix | Default |
|---|---|
builtin:* (e.g. Run Command, Run Script, Wait for File) | Enabled by default |
internal:* (Null Job, Workflow Container) | Enabled by default |
opcon.lsam and opcon.lsam.* (legacy LSAM) | Enabled by default |
opcon.mft, opcon.rpa, opcon.ease (the relay-side REST connectors) | Enabled by default. Each is matched exactly — no other opcon.* name inherits it |
| Any other name | Disabled by default — must be opted in. No plugin shipped today is of this kind |
An enabled plugin is not the same as a usable one. The three REST connectors additionally need a relay that has reported it can serve their agent type, and a registered agent — see Relays.
- "A job type isn't available to build with" usually means it, or its plugin, has been turned off for the tenant. Every plugin shipped today is enabled by default, and so is every job type in it.
- Disabling a plugin removes its job types, and the connection types it provides, from the lists you build from. Jobs that already use them keep running, and the confirmation tells you how many there are first.
- Multiple versions can be installed, and one is recorded as the default version.
Troubleshooting
| Symptom | Likely cause | Resolution |
|---|---|---|
| A job type is missing in the builder | It, or its plugin, has been turned off for the tenant | Turn it back on in the plugin's Job Types, or turn the plugin on (Administrator). Allow up to five minutes for an open job editor to offer it. |
| An existing job shows a job type the Job Type list does not otherwise offer | That job type is turned off; the job keeps it | Nothing to fix: the job still saves and runs. Turn the job type back on to offer it for new jobs too (Administrator). |
| The Turn Off dialog says the number of jobs could not be checked | You cannot view job instances, or the count could not be reached | The change can still be made, and existing jobs keep running. Ask someone who can view job instances to check the count first if it matters. |
| The job-type switches are greyed out | The plugin is off | Turn the plugin on first; the job types you turned off before stay off. |
| Job types could not be loaded. on a plugin's page | The plugin's job types could not be read | Reload the page. |