NW Cfg: Context Menu Actions Panel

Document created by RSA Information Design and Development on Sep 14, 2017Last modified by RSA Information Design and Development on Oct 13, 2017
Version 8Show Document
  • View in full screen mode
  

In the Context Menu Actions panel, Administrators can view built-in context menu actions, and add, edit, or delete custom context menu actions that appear as options in a context menu.

Workflow

context menu Workflow

What do you want to do?

                  
RoleI want to ...Show me how
AdministratorCustom Context Menu Actions panelAdd Custom Context Menu Actions.

Related Topics

Quick Look

The following figure is an example of the Context Menu Actions panel.

Context menu action panel

             
1Displays the Context Menu Actions Panel
2Toolbar allows the user to Add, Edit, Delete Context Menu Actions

Toolbar and Features

The Context Menu Actions panel has a grid and a toolbar. The following table describes the toolbar options and grid features.

                                                       
FeaturesDescription
Displays the Context Menu Configuration dialog, in which you can create a new context action.
Refreshes the list.
Deletes the selected context actions. NetWitness Suite does not request confirmation that you want to delete the action. The selected actions are immediately deleted with no opportunity to cancel.
Displays the Edit Context Action dialog, in which you can edit an existing context action.
Menu Item The menu item as it appears in the context menu.
When creating a context menu action, the parameter is displayName.
Here is a line of sample code:
"displayName": "User Agent String Lookup”
ID The unique ID for the context action. When creating a context menu action, the parameter is id.
Here is a line of sample code:
"id": "UserAgentStringAction"
Version The version number of the context action. When creating a context menu action, the parameter is version.
Here is a line of sample code:
"version": "1"
Type The type of context action.

When creating a context menu action, the parameter is type. All NetWitness Suite context action types begin with this string: 
UAP.common.contextmenu.actions.
The last part of the string identifies the menu within NetWitness Suite, for example, URLContextAction or LivePostContextAction.

Here is a line of sample code:
"type": "UAP.common.contextmenu.actions.URLContextAction"
Modules The names of the modules in which the context action is available. Currently all built-in context menu actions are for the Investigation module.
When creating a context menu action, the parameter is modules.
Here is a line of sample code:
"modules": [ 
         "investigation" 
     ],
Module Classes The CSS classes that identify the names of the module views in which the context action is available. Currently all built-in context menu actions are for the Investigation module and the non-meta key module classes are described in detail below.
Here are a few lines of sample code:
"moduleClasses": [ 
         "UAP.investigation.navigate.view.NavigationPanel”, <-- Enabled in Navigate pane--> 
        “UAP.investigation.events.view.EventGrid”
     ],
CSS Classes The CSS classes to which the context menu action applies. The CSS classes define where the context menu shows up inside investigation when you right-click. When creating a context menu action, the parameter is cssClasses.
Here is a line of sample code:
"cssClasses": [ 
         “client”
]

Most of the CSS Classes that you can add are meta keys. You can also add certain non-meta key CSS classes. See additional details and examples below.

CSS Classes and Examples

CSS classes can be meta keys and non-meta keys.

Meta Key CSS Classes

One type of CSS class that you can add is meta keys. For meta keys that have a period, change the period to a dash when defining a CSS class. For example, the meta key alias.host becomes the CSS class alias-host. The meta key ip.src becomes the CSS class ip-src.  

Non-Meta Key CSS Classes

Built-in non-meta key CSS Classes are also available. The classes in the following table define actions and the part of the user interface where the action is available.

                                        
CSS ClassTypeDescription
meta-value-session-link ActionOpen on meta session count number
meta-value-name-link ActionOpen on meta value name
nw-event-value Action
 
Use for reconstruction context actions on meta value
UAP.investigation.navigate.view.
NavigationPanel
User interfaceApplies to Navigate view
UAP.investigation.events.view.
EventGrid
User interfaceApplies to Event View
UAP.investigation.reconstruction.view.
content.ReconstructedEventDataGrid
User interfaceApplies to Event Reconstruction View

Example

This is a commented example of a context menu action to validate the user agent from the Client Application (client) meta key. The comments are removed automatically once applied in the Administration System view. The new menu item is displayed after restarting the browser.
{
     "displayName": "User Agent String Lookup”, <!-- What name shows up in NW UI --> 
     "cssClasses": [ 
         “client”  <!-- What meta key to launch from --> 
     ], 
     "description": "", 
     "type": "UAP.common.contextmenu.actions.URLContextAction", 
     "version": "1", 
     "modules": [ 
         "investigation" 
     ], 
     "local": "false", 
     "groupName": "externalLookupGroup”, <!-- What group to show link in. Remove line to show in main list --> 
     "urlFormat": "http://www.useragentstring.com/?uas={0}&getText=all”, <!-- The {0} gets replaced with whatever was right clicked on --> 
     "disabled": "", 
     "id": "UserAgentStringAction", 
    "moduleClasses": [ 
         "UAP.investigation.navigate.view.NavigationPanel”, <-- Enabled in Navigate pane--> 
        “UAP.investigation.events.view.EventGrid” <-- Enabled in Event View pane --> 
     ], 
     "openInNewTab": "true", 
     "order": "15" 

Previous Topic:NTP Settings Panel
You are here
Table of Contents > References > Context Menu Actions Panel

Attachments

    Outcomes