09 Plugins

09 Plugins



Plugins

Plugins menu list all the existing plugins along with plugin details.  In this section we shall discuss the following,

  1. View Plugins and Plugin Steps
  2. Plugins Search
  3. Advanced Search
  4. Upload Plugin Zip
  5. Upload New Plugin jar
  6. Actions: Edit, Delete



View Plugins

To view available plugins,

  1. Use Menu Toggle to expand the main menu.
  2. Click on Plugins menu.
  3. View the Plugin details in tabular format. 


Figure 9a: View Plugins



  1. Click on any Plugin Name to view the Plugin Steps. The snapshot below shows the steps in Oracle-Server Plugin.


Figure 9b: Steps in a Plugin


  1. An explanation of each of the columns is provided in the table below.


Table 15Plugin Details Table 

Field Name

Description

Plugin Name

Displays the name of the Plugin. Click on the Plugin Name link to get more details such as steps in the plugin and plugin step units.

Framework Version

Displays the version of the Framework

Plugin Version

Displays the version of the Plugin.

Created

Displays the number of Requests in execution.

Last Modified

Displays the status of the Agent: Running, Unknown or Stopped. Unknown status is shown when server is not sure about the status of the agent due to factors such as abrupt shutdown or network failure.

Actions:



Edit ( )

Click edit icon to edit the plugin. Once you click edit you can upload a file to update the plugin. You can also roll back as discussed in the section “6.5.2 Upload Plugins: Update” below.


Delete (    )

Click to delete the plugin. A plugin cannot be deleted if its steps are being used in an active workflow. 

Plugin Details:

Name

The name of the Plugin Step or Entry.

Type

The type that could be Step or Entry

Unit

The License Step Units associated with the step.





Plugins Search

To search for plugins,

  1. Use the Menu Toggle to expand the main menu.
  2. Click on Plugins menu item
  3. Enter search string to filter the records real time. 

Figure 9c: Plugin Search


  1. Type MSSQL in the Search box in the top right corner. You can now see the search results for MSSQL as seen below. 

Figure 9d: Filtered Plugin Search Results


  1. This completes the Search features.



Advanced Search

To make an advanced search for plugins, 

  1. Use the Menu Toggle to expand the main menu.
  2. Navigate to the Plugins menu.


Figure 9e: Plugins Menu



  1. Filter requests using advanced search options. The advanced search options are explained in the table below.

  1. Click Advanced Search.
  2. Column field displays. Click the arrow to see the drop down list. Select a column on which you wish to filter.  


Figure 9f: Advanced search - Select Column


  1. Plugin Name is selected as the column. Select a comparator from the drop down list.


Figure 9g: Advanced Search – Select Comparator


Table 16: Advanced Search Options by column Plugin Name has the following options for comparator:

Field

Description

Equal To

To search entries by the exact entered text.

Not Equal To

To search entries not matching the entered text.

Like

To search entries containing the entered text

Begins With

To search entries that begins with the entered text.

Ends With

To search entries that ends with the entered text.


  1. Select like in Comparator.


Figure 9h: Advanced Search Value




  1. You can see the Plugin name like Oracle filter below. The records have been filtered accordingly. 

Figure 9i: Advanced Search Filter


  1. You can click the x to remove filter as seen below.


Figure 9j: Remove Advanced Search Filter









  1. Remove the filter.
  2. Now select Created in the Column fieldThe options in the drop down list in comparator is seen below. Depending on the option chosen in cloumn the list in the Comparator field changes.


Figure 9k: Advanced search on Date- Created Date


Table 17: Advanced Search Options by Created Date, Last Updated Date:

Field

Description

Exact Date

To search entries by the exact entered date.

Before

To search entries before the entered date.

After

To search entries after the entered date.

In Between 

To search entries in between the entered dates.

Not In Between

To search entries not in between the entered dates.



  1. This completes the features of Advanced Search.






Plugin Upload

Plugin UI screen is used to upload plugins and to 

Once plugins are available on AutomationEdge server Process Studio can synchronize plugins by downloading/updating plugins from AutomationEdge server. 

One or more plugins can be uploaded as a zip file or plugins can be uploaded as individual jar files. Three scenarios of Plugin Upload are discussed in the following sections. This is followed by a summary table of all possible Plugin Upload scenarios.



Upload New Plugin Zip

To upload plugins zip,

  1. Use the Menu Toggle to expand the main menu if required.
  2. Navigate to the Plugins menu.
  3. View Upload button on the extreme right. There are two options. You may click the Upload button or click the arrow key next to the Upload button and select New Plugin.


Figure 10a: Upload Plugins- Select Operation



  1. The Upload button gives you an option to choose a plugin zip file as shown below. 

Figure 10b: Upload Plugins- Choose Zip file option



  1. Alternately you could choose New Plugin from the drop down arrow next to upload button to upload a new Plugin jar file. 

Figure 10c: Upload New Plugin jar








  1. Click Upload buttonBrowse for a Plugin zip file availble with AutomationEdge Plugin Distribution releases. 
  2. Here we have browsed for the Database-plugins zip file as seen below. 

Figure 10d: Upload Plugins- Choose jar file option



  1. You can now see the Upload Plugin progress bar. 

Figure 10e: Upload Plugins- Choose plugin Zip file 



  1. The Plugins Upload Preview page appears. 

Figure 10f: Upload Plugins Details and Selection

    

  1. If you save without choosing any plugin- by selecting the Upgrade checkbox an error message as shown below is displayed.  

Figure 10g: Upload Plugins- No Plugins selected 




  1. Choose the Upgrade check box to upload new a plugin or an upgraded plugin to overwrite an existing plugin. 
  2. You may select Assign to All Tenants or leave it unchecked. 
  3. Click Save.


Figure 10h: Select Upgrade/Downgrade checkbox


  1. An Upload plugin progress indicator appears in both cases for Assign to All Tenants checkbox checked or unchecked 

Figure 10i: Plugin Upload Progress Indicator 







  1. Plugin upload successful message is displayed. 


Figure 10j: Plugins Upload Status



  1. You can now see the newly uploaded plugins in the Plugin view. 

Figure 10k: Upload Plugins View



  Note:

There was only one plugin on AutomationEdge server prior to Uploading new plugin zip file. Now there are three plugins.




Upload existing Plugins zip file 

You can re-upload a Plugin zip file. The steps are similar to those demonstrated above.

  1. Click Upload button. Once again choose file for the Database Plugin zip file. Click Upload button.


Figure 10l: Choose plugin Zip file for existing plugins



  1. The Plugins Upload Preview page appears. The Assign to all Tenants checkbox is enabled, since these plugins were already assigned to all Tenants during the previous upload.


Figure 10m: Assign to All Tenants already selected






  1. Select one or more checkboxes to upgrade as desired. Click Save.


Figure 10n: Select Plugins to upgrade



  1. The Plugin Upload status page appears with Plugin update successful message.


Figure 10o: Plugin Upload Status








Upload New Plugin jar file

New Plugin gives you an option to upload a plugin by selecting a new Plugin jar file It also gives an option to Assign To All Tenants or you may assign the plugin to Tenants later from the Plugin Assignments menu..


Following are the steps to upload a New Plugin jar file.

  1. Navigate to the plugins menu. Click the arrow next to Upload button and click New Plugin. 

 Figure 10p: New Plugin option


  1. Choose the jar of a plugin that has not been uploaded yet. You may assign to all Tenants. Click Upload. 

Figure 10q: Choose Plugin jar


  1. The Upload Plugin progress bar appears.


Figure 10r: Upload Plugin jar Progress bar


  1. Plugins uploaded successfully message appears. 

Figure 10s: Plugin uploaded successfully message


  1. This completes the process of uploading a new jar file successfully.


Upload Existing Plugin jar file

As the name suggests Upload New Plugin is only for new Plugin jar files. If you upload the jar of an existing Plugin, it throws a Duplicate Plugin error as seen below. 

Instead use the Actions Edit option to update an existing Plugin using a jar file. Actions Edit option is discussed in the following section. 

Figure 11a: Upload jar option for existing Plugin throws error




Actions

In the tabular listing of plugins three options are available in the actions column as follows.

Edit 

Actions Edit option is used to update an existing plugin using a jar file.

  1. Click () icon next to a Plugin to edit the plugin.
  2. Click Choose File and browse for the updated jar file.


Figure 11b: Edit existing Plugin to upload new jar



  1. The new Oracle-Server Plugin jar is chosen. Click Update.


Figure 11c: Edit/Update Plugin

  1. The plugin/plugins are uploaded and you see the success message. 


Figure 11d:  Plugin Edit/Upload Success Message




Delete

Actions Delete option is used to delete an existing Plugin.

  1. Click () icon next to the plugin to delete.  
  2. In this case let us click delete for Web-GUI.


Figure 11e: Delete Plugin



  1. Confirm plugin deletion.


Figure 11f: Plugin deletion confirmation Alert


  1. The plugin is deleted and you can now see the deletion success message. 


Figure 11g: Plugin Deletion Success Message


  1. This completes the process of Plugin deletion.






Plugin Assignments


Single Plugin Assigned to multiple Tenants

You may assign a Plugin to one or more Tenants by choosing the first radio button - Plugins in the Plugin Assignment menu.

  1. Navigate to PluginsPlugin Assignments menu.


Figure 12a: Edit to Assign a Plugin to Tenants



  1. The Plugins radio button is clicked by default.
  2. The first plugin available alphabetically is selected by default. Select a plugin from the drop down menu. 
  3. Click Edit button.
  4. You may unable or disable checkbox next to any Tenant on this page. In the snapshot below active-directory plugin is assigned to all Tenants. You may uncheck the checkbox next to any Tenant.


Figure 12b: Select Tenants for Plugin Assignment




  1. warning Revoke Assignment pop up appears. Acknowledge by clicking Ok.

Figure 12c: Warning for deselected Tenants



  1. Click Save.


Figure 12d: Save for Plugin Assignment



  1. A Plugin assignment successful message appears. 

 

Figure 12e: Plugin assigned successfully


  1. This completes the first option Single Plugin assigned to multiple Tenants.








Multiple Plugins Assigned to a Tenant

You may assign to a Tenant one or more plugins by choosing the second radio button - Tenant in the Plugin Assignment menu.

  1. Click the Tenants radio button. 
  2. Select a Tenant from the drop down list to which plugins are to be assigned. TENANT is chosen below.  

Figure 12f: Tenant radio button with TENANT selected



  1. Filter the Plugin Name list. In the snapshot below Server is typed in the filter search box. A filtered list of plugins is seen below.
  2. Click Edit.


Figure 12g: Filter Plugins to be assigned


  1. The checkbox next to both plugins is checked and disabled.  
  2. If checkbox is disabled, it indicates that the Plugin is assigned to all Tenants. Refer Note below.
  3. Click Cancel.


Figure 12h: Select Plugins to be assigned



 Note:

System Administrator can selectively assign or un-assign chosen Plugins from Plugin Assignments menu (Tenants option).  However, you may not be able to un-assign a plugin for a Tenant, if it has been assigned to all TenantsYou first need to un-assign the plugin to at least one Tenant from Plugin Assignments menu (Plugins option)




Unassign Plugin from at least one Tenant

Following, are the steps to un-assign a Plugin from at least one Tenant.

  1. Click the Plugins radio button. 
  2. Choose Oracle-Server from the drop down list.
  3. Click Edit. 

Figure 12i: Choose Plugin to un-assign from at least one Tenant



  1. Disable assignment of Oracle-Server plugin to at least one tenant. A Revoke Assignment warning pop up appears. Acknowledge by clicking Ok. 

Figure 12j: Warning of Inactivating Workflows 



  1. Click Save


Figure 12k: Unchecked Tenants for un-assignment


  1. Plugin assignment successful message appears. 

Figure 12l: Plugin Assignment Successful





Un-assign Plugin 

(Prerequisite: The Plugin must be unassigned to at least one Tenant) 


The following are the steps to un-assign one or more Plugins from a Tenant. 

  1. Now click the Tenants radio button.
  2. As seen in the sections above a Plugin cannot be Unassigned to a Tenant with Tenant Radio button selected if it is assigned to all Tenants.
  3. Hence, we unassigned Oracle-Server plugin to a Tenant with Plugin radio button.
  4. We can now un-assign the Plugin to a Tenant with Tenant radio button selected.
  5. Click Edit. 

Figure 12m: Un-assign Plugins to a Tenant


  1. The checkbox next to Oracle-Server 1.0 is now enabled.
  2. You may disable the checkbox and Save. 

Figure 12n: Disable checkbox for Plugin to un-assign


  1. The Revoke Assignment pop up appears. Acknowledge by clicking Ok. 

Figure 12o: Inactivating Workflows Warning


  1. Plugins Assignment successful message appears.  

Figure 12p: Plugin Assignment Success message



  1. This completes the second option Tenant assignment to Plugin.







      Links to better reach 

            Bot Store

             EPD