Skip to main content

Work with Plugins

System Administrator manages plugins. Admin has view-only access to plugins except the option to set plugin properties.

Known issue: Plugins do not sync in the Process Studio due to time difference between the Process Studio and AE server.

The chapter includes the following topics:

View plugins​

You can view the plugin details and plugin steps.

To view plugin details:

  1. In the menu, click Plugins → Plugins. The Plugin Utilization page appears.

    Plugin Utilization page
    Plugin Utilization page

  2. View the following field details:

    Field nameDescription
    Plugin NameDisplays the name of the plugins.
    Plugin VersionDisplays the current version of the plugin that is uploaded and assigned as the primary plugin.
    A Primary next to the plugin name indicates that the plugin version is the primary version across all tenants.
    However, if the System Administrator has made changes to the tenant assignments, then the assigned plugin version could be primary only for a specific tenant and there will be no Primary against the plugin version. For example, see the following screenshot:
    Plugin tenant example
    AE-Core plugin version 3.0 is the primary plugin across all tenants, while AmazonS3 plugin version 8.4 is the primary version for a specific tenant only.
    Assign To New TenantsDisplays Yes or No.
    - Yes: The plugin is automatically assigned to all new tenants.
    - No: The plugin is not assigned to new tenants by default.
    Release VersionDisplays the release version from which you want to upload the plugin.
    Framework VersionDisplays the current AE framework version.
    Last modifiedDisplays the date and time when the plugin details were last updated.
    ActionsDisplays the following action icons:
    - Plugin Steps (Plugin Steps): Click to view the plugin details.
    - Plugin Utilization (Plugin Utilization): Click to view the utilization details of the selected plugin.

    To work with action icons: On the Plugin Utilization page, in the Actions column:

    • Select a plugin and then click Plugin steps. The selected plugin's step details appear.

      Selected plugin's step details
      Selected plugin's step details

      View the following field details:

      Field nameDescription
      NoDisplays the serial number of the step.
      NameDisplays the name of the plugin step.
      TypeDisplays if the plugin has steps and / or entries.
      Metering UnitsDisplays the units of steps or entries consumed in a workflow or process.

      Click Plugin steps. The dialog closes.

    • Select a plugin and then click Plugin steps. The plugin's workflow utilization details appear.

      The plugin's workflow utilization details
      The plugin's workflow utilization details

      View the following field details:

      Field nameDescription
      NoDisplays the serial number.
      Workflow NameDisplays the name of the workflow in which the plugin step or entry is used.
      UnitsDisplays the step units utilized in each workflow.
      Note:
      The step units add up as consumption of License step units.

      Click Plugin steps. The dialog closes.

Configure plugin properties​

You can configure properties of some plugins at two levels, Tenant and Agent.

To configure plugin properties:

  1. On the Plugin Utilization page, in the Actions column, click Configure plugin properties. The plugin configuration dialog appears.

    The plugin properties configuration dialog
    The plugin properties configuration dialog

  2. View and / or enter the following field details:

    Field nameDescription
    Tenant level property configuration
    Property NameDisplays the name of property for which you can configure the details. For example:
    - <plugin> Runtime Port
    - Ignore white spaces in the path
    ValueIn the Actions column, click Edit and enter the value for the property. For example, for:
    - <plugin> Runtime Port: Enter the port number.
    - Ignore white spaces in the path: Select true or false.
    In the Actions column, click Plugin steps to confirm the value.
    LevelDisplays the level at which the property is applied. For example, Tenant indicates that the updated property will be applicable to all users of the tenant.
    Agent DetailsDisplays the property is applied to all agents of the tenant.

  3. Click Save. The details are saved and applied at Tenant level to all agents of the tenant.

    The plugin properties configuration dialog
    Plugin properties saved

  4. To configure properties at Agent level:

    Note

    Between property configuration at Tenant and Agent level, properties configured at Agent level will be applicable for the plugin.

    1. Click + Add Property Value. A row to add property appears.

      Agent level property settings
      Agent level property settings

    2. Select or enter the details for the respective fields, and then click Plugin steps. The details are saved.

    3. Click Save. The details are saved and applied at Agent level to the selected agent of the tenant.

Last updated on