Documentation forOrion Platform

Create and edit Orion Maps

This Orion Platform topic applies only to the following products:

NAMNPMNTASAMUDTVMANVNQMWPM

With Orion Platform 2019.2, you can use the Map Editor to create and customize Orion Maps:

You can add Orion Maps to your views in a widget.

See the Orion Maps post on THWACK.

If your user account does not have Node Management rights, you can save maps only as entities without status. You can display such maps in a widget or in the View mode, but you cannot nest maps without status into other maps.

Create an Orion Map from scratch

  1. Click My Dashboards > Orion Maps in the Home section.

  2. In the Map Management page, click New Map. An empty canvas opens. You are now in Edit mode.

  3. Select desired entities in the Entity Library and drag them to the canvas. Any relationships to mapped entities, such as topology connections, manual dependencies, or ADM relations, are automatically displayed.

  4. Filter the list of entities shown from the Entity Type drop-down. Select the filter button to choose from a number of options, such as, Machine Type, Polling Method, or Status. If your desired option is not shown, click the edit pencil to open a dialogue box and type in any relevant property to filter by.

  5. To display more details about the entity, click an entity on the map. The details are displayed in the panel on the right. The panel lists related entities, connected entities, alerts, and recommendations (VMAN) for the selected entity.

  6. To identify an entity from the list on the map, click the menu icon next to the entity in the list, and click Center map on this entity. This also changes the focus of the map. To view related or connected entities, click Show related entities or Show connected entities. The panel displays entities relevant for the selection.

  7. To place an entity, click and drag selected individual entities from the list, or use Shift to grab all entities between two selections. Drag the selections to the canvas to place the nodes in staggered grid formation. By click and dragging across the canvas, you can perform a marquee selection of entities.

  8. Adjust the position of entities on the map. You can use the following shortcuts:

    Shortcut Explanation
    = Zoom in.
    - Zoom out.
    Ctrl + Mouse wheel up Zoom in.
    Ctrl + Mouse wheel down Zoom out.
    Space bar + Click + Drag Pan the map in the viewport.
    Map Editor Only
    Del

    Remove the selected object(s) from the map. Excludes auto-discovered connections.

    Ctrl + S Save the map.
    Ctrl + Shift + S Save the map under a new name.
    Esc Clears object selection.
    Arrows Nudge the selected object.
    Shift + arrows Move the selected object.
    Ctrl + Z Undo previous map modification
    Ctrl + Y Redo previously undone map modification

  9. To preview the map, click More > View. This opens the map in View mode.

    In View mode, you can:

    • Hover over an entity to display the pop-up.
    • Review the list of entities on the map.
    • Click an entity to display the Inspector Panel.

    You cannot add entities from the Inspector Panel. To add entities, you need to switch to the Edit mode.

  10. To save the map, click More > Edit to return to the Edit mode.

  11. Click Save and provide a unique name. The Orion Map is saved. If your user account does not have Node Management rights, the saved map does not have a status and does not appear in the list of entities.

Select multiple entities in Map Editor

The multi-select tool allows you to select, click, and position multiple entities at one time. Click and drag to individually pick entities from the entity list, or use the Shift Key to grab a group of entities, and drag your selections onto the canvas as a unit.

The click and drag process performs a marquee selection of entities. Once your placement is complete, use the Control key again to select and adjust the properties of multiple entities when necessary.

Create a new map from an auto-generated Orion Map

  1. Go to the details view of the entity you want to base your map on, and click the Map subview.
  2. Add related or connected entities on the map.
  3. Position the elements as needed.
  4. Click Open Map in Editor in the top right corner. The map opens in the Map Editor.
  5. Complete the map definition, and save the map.

Duplicate and edit an existing Orion Map

If you want to create a map similar to one you have already created, save the map using another name, and adjust your copy of the map.

If you have Administrator privileges, you can display maps created by other users. To edit a map created by another user, you must first save a copy of the map you wish to edit, ensuring the original remains intact.

Only the owner of a map can save edits to the original map. Users who are not the owner can edit a map's copy, but not the original.

To duplicate and edit an Orion Map:

  1. Click My Dashboards > Home > Orion Maps.
  2. To edit a map created by other users, toggle the All users switch on.
  3. Select the map to adjust, and click Edit.
  4. Click More > Save as.
  5. Provide a name for the copied map and edit as required.

Find related and connected map entities

From the Orion Maps Editor, you can view relationship information across a stack of connected entities. Connected entities are any nodes or interfaces that are connected based on NPM's Topology data or SAM's Application Dependency Connections. Related entities are all other nodes, such as volumes or applications, associated with a server.

  1. Locate and add an entity to the map. Click the menu icon to the right of the entity ().
  2. Select Show Related Entities or Show Connected Entities. This opens a panel of all related entities or connections respectively.
  3. From the panel, you can search and filter based on entity type. Additionally, you can continue to click new options, and each opens a new panel of connected or related entities.

Manually connect entity objects

Starting with Orion Maps 2019.4, you can connect objects and define custom connections within the map editor. You must select two entities in order to activate the Connect Objects tool in the Orion Map Editor toolbar.

  1. Select two entities by holding the Ctrl key to select the entities you wish to connect. You can also select entities using click and drag.
  2. Click the entity connection button from the Connect Objects toolbar. This opens the Configure custom topology connection window.
  3. For the first entity, click Configure and select the desired interface to connect to. The panel displays all objects related to that specific entity. You can filter or search for a specific entity.
  4. Click Apply to associate the two objects.
  5. Repeat steps 3 and 4 to connect the second entity to an interface.
  6. Click Create.

Add custom images to Map Editor

Starting with Orion Maps 2019.4, you can enhance your maps by adding images outside of the monitored entities in Orion. This allows you to highlight the location of important elements, help users easily interpret a map, or enhance the overall look of your maps, such as adding your company's logo to a map.

From the Map Editor toolbar:

  1. Select the Insert Images icon.
  2. Browse to and select your desired image file.
  3. Once the image has been placed, you can click and drag the image to a new position on the map.
  4. Click and drag to select multiple images at once. Edits can be applied to all highlighted selections.

Make additional edits to the image, including bring an image forwards or backwards in relation to other images on the map. For more information, see Align canvas items.

Configure entity and image properties in Map Editor

From the map editor, placed entity or images can be configured using the toolbar and properties panel. The following tools are available depending on the number of map items selected as well as the type - an entity node, image, connection, or shape.

Selections

This allows you to quickly select multiple items on a map to further edit. There are several options available: Select all (Ctrl+a), Select Entities, Select Shapes, Select Images, and Select Labels.

Note: Select Labels applies only to custom text and does not select the labels under entities.

The properties panel options available change dependent on the selection.

Layouts

This tool allows you to change the layout of placed and selected entities on the map editor. By default, placed items can be manually moved using a snap-to layout. The Layouts tools allows you to reconfigure the positioning of multi-selected nodes based on force-direction, grid layout, or hierarchical layout.

Insert shapes, custom labels, images

Add shapes - rectangles or circles, text labels, or images onto your canvas to add depth or logical groupings within a map. Objects are added to the upper-left corner of the canvas, from which it can be dragged and placed as desired. You can then drag and "snap" other items, such as an entity, into the object.

The alignment of a shape, label, or image on the canvas can be changed from the Align Items menu.

Align canvas items

Objects, such as shapes, images, and labels, are layered behind entities and connections, and in the order they are added to the map. These objects can be selected, moved, and deleted. When objects are selected, the following options are available from the Align menu:

  • Left/Center/Right align
  • Top/Middle/Botton align
  • Distribute images vertically
  • Distribute images horizontally

Adjust the position of selected object using the following shortcuts:

Shortcut Explanation
Ctrl+J Bring the object forward one layer.
Ctrl+Shift+J Bring the object to the front.
Ctrl+[ Send the object back one layer.
Ctrl+Shift+[ Send the object to the back.

If multiple objects are selected in a set, moving them forward or backwards a "step" retains the current stacked order.

Properties Panel

The Properties Panel is designed to allow you to customize every item added to the map canvas. You can apply property changes to either a single selection or multiple selections, including items of different types.

When selecting multiple objects, attribute values that are the same for all selections are visible. If objects have contrasting values, the attribute is marked (multiple) to indicate there are differences.

Property Explanation
Size & Position

Adjust the height and width, X-Y positioning, or degree of rotation of an entity.

Toggle the aspect ratio lock to force a re-sized entity to preserve its original size ratio.

Text

Customize the content displayed within an entity, including the label, style, color, font type and size, and text position or alignment.

Word wrap allows you to change the character of text added to an object from Content:

  • Wrap to fit: text to fills the width of the object.
  • Wrap to width : restricts label to a specific pixel width.
Icon (nodes)

Customize the look and style of icon used for a node.

  • Change the image used for an icon from a library of available images. You can also upload your own icon to be used.
  • Use an icon based on the status of a node.
  • Change the node background shape and how large the node icon is in relation to the shape.

Additionally, you can toggle to show or hide the status badge for a entity.

Style

Customize the attributes of an item, such as the Fill Color, Border Width, Border Color, and Corner Radius.

Behavior (shapes and images)

Add a URL hyperlink to a shape or image. The full URL - including HTTP/HTTPS must be included.

When an item with a configured Behavior is clicked in an active map, a new window is opened, redirecting to the indicated URL.