Skip to main content
English (US) Nederlands

Assets Server action plug-ins setting - menuAssignments

  • Updated

The menuAssignments setting is one of the settings of an Action plug-in that can be configured in its configuration file. For more information, see Assets Server Action plug-ins - configuration settings.

Required Yes
Description

Controls from which menu(s) the plug-in is available, this can be a combination of the following:

  • The main button toolbar
  • The context menu of a file or folder

Menu assignments are required in the action configuration, you will need to define at least one to make the plug-in available in the user interface.
Basic setting 
<action>
    <menuAssignments>
                <menuAssignment>...</menuAssignment> 
        </menuAssignments>
</action>

Menu assignment - <menuAssignment/>

One or more menuAssignment tags can be defined.

Note: Each menuAssignment "id" can only be defined once; it is not allowed to assign menu items to the application menu multiple times.

Parameters

id

Menu id, defines to which menu the plug-in will be added. Possible values:

  • assetContextMenu - adds a sub item to the plug-in menu in the context menu of an asset. Add this menu assignment when the plug-in requires an asset selection.
  • toolBar - adds a button in the application's main button toolbar.

  • folderContextMenu - adds a command to the context menu of a folder. Requires Assets Server 6.63 or higher. Users need to have the 'Action plug-ins' permission assigned (ROLE_ACTION_PLUGINS) to see the menu command.

Required.
order

The menu order, used to define the order of plug-in items (1, 2, 3, etc) as they appear in the menu. The actual order is a a result of all active plug-in order values combined.

Required.

Examples

Typical menu assignments for a plug-in that requires no selection

<menuAssignments>
    <menuAssignment id="toolBar" order="1"/>
<menuAssignments>

Typical menu assignments for a plug-in that requires an asset selection

<menuAssignments>
    <menuAssignment id="assetContextMenu" order="3"/>
    <menuAssignment id="toolBar" order="3"/>
<menuAssignments>

Related articles

Comment

Do you have corrections or additional information about this article? Leave a comment!
Do you have a question about what is described in this article? Please contact Support.


0 comments

Please sign in to leave a comment.