My Plugin does not appear in OpenWorkdesk

[mkappel]

There could be several reasons why your either new or copied plugin instance does not appear in OpenWorkdesk.
Initial Situation: You created a new plugin with OpenWorkdesk Configurator. Either you created a new one or copied an existing one and created a new instance of the plugin. It doesn’t matter which type of plugin was created (master, record or document plugin). You finished the configuration and want to test the plugin in OpenWorkdesk.
Here are the possible reasons why the plugin does not appear in OpenWorkdesk.

First reason: Forgot to save the configuration
Of course it is necessary to save the configuration in OpenWorkdesk Configurator. The configuration is saved in the file owplugins.xml.

Second (and most) reason: Forgot to reload the (new) configuration
After changes to the configuration (doesn’t matter which one, boot, mime or plugin configuration) it is necessary to reload the configuration to make the changes effective to OpenWorkdesk. According to the following picture you have to login as an administrative user of OpenWorkdesk and go to the Settings plugin. Then select the OpenWorkdesk settings on left side and scroll down to the site settings. There are two buttons where you can reload the Plugin and Mime Configuration as well as the Boot Configuration. After reloading you have to logoff and login to make the changes effective.

[attachment=2]01.png[/attachment]

Third reason: Not assigned to respective role (only relevant for OpenWorkdesk Enterprise Edition)
OpenWorkdesk Enterprise Edition consists of a Role Manager which allows to assign each plugin respectively feature to a specific role. This means you can provide a group/department/role only the features they need for their work.
Therefor you have to assign your new plugin to the specific role. Login as an administrative user of OpenWorkdesk, go to the Administration plugin, select the appropriate role, select as Resource Category “Plugin” and assign the respective plugin by setting the radio box to allow. Don’t forget to save the changes in the bottom. If you login as a user who’s member of the just configured role the plugin should be available now. Otherwise see the next possible reasons.

[attachment=1]02.png[/attachment]

Fourth reason: Not enabled in Master Plugin (only relevant for document and record plugins)
It is possible to specify which record or document plugin (like “Add Bank Document” or “Edit Properties”) shall appear in which master plugin (like eFiles for Banking). So it makes sense to use the configured
- “Add Credit Document” plugin in the “Credit Files” plugin and the
- “Add Contract Document” plugin in the “Contract Files” plugin.
Therefor you can enable and disable the record and document plugins for each master plugin via the OpenWorkdesk Configurator.

[attachment=0]03.png[/attachment]

[mkappel]

Fifth reason: Not defined where the plugin shall appear (only relevant for document plugins)
As part of the configuration you can specify for document plugins where they should appear. Often used features (like “Edit Properties”) shall be available in front of each document, others only in context menu, according to the following picture.

[attachment=2]04.png[/attachment]

Via the OpenWorkdesk Configurator you can specify where each document plugin shall appear. For more information use the help in the Configurator by pressing F1.

[attachment=1]05.png[/attachment]

Sixth reason: The respective object type is not enabled (only relevant for document plugins)
You can define for which object type a document plugin can be used. This means that e.g. an “Add to Favorites” plugin is only available for documents so it is not possible to bookmark whole eFiles or tasks. The following picture shows the object type specification for the “Edit Properties” plugin so this works for custom types like tasks, documents, folders and work items of workflows.
Use the OpenWorkdesk Configurator to define the appropriate object types.

[attachment=0]06.png[/attachment]

[mkappel]

Seventh reason: Object class is not specified (only relevant for record and document plugins)
You copied an already existing plugin and created a new instance with already defined configurations.
Then a reason could be that specific object classes are defined for which a plugin is executable. Example: An “Edit Properties” plugin can only be used for Bank Documents but not for Credit Documents because for this type another plugin with different configurations exists.
According to the following picture you can define with OpenWorkdesk Configurator the object classes for which this item will work.

[attachment=0]07.png[/attachment]

[chfi]

Some additional information regarding the "third reason" that was mentioned above:
in case of having the OpenWorkdesk Enterprise Edition and using the DBRoleManager there is a pretty smart way to check the plugins that are assigned to your user ==> just open the so called configdump.jsp (e.g. http://localhost:8090/openworkdesk/configdump.jsp) to get more information like:
- all roles your user is member of
- all plugins/searchtemplates/… that are assigned to your user
==> this is the easiest way to check if any access rights are missing in your DBRoleManager