Document toolboxDocument toolbox

Models configuration

First time execution

Go to Devo’s main menu and click on Applications > Service Operations. Please refer to the installation section if Service Operations does not appear in the list of available applications.

After the application’s initial loading process, you should see Service Operation’s welcome sections:

Service Operations manages two types of models: global and domain-specific. Typically, the first execution will yield no available results for domain models, and the application will inform about this status as shown in the previous screenshot. In the following sections of this document, the full procedure to create a new model will be explained, but at this point it is also possible to click on the Global maps tab and select one of the Devo-curated models that are available off-the-shelf. Please refer to the Global maps section in this documentation for more information on the access and usage of global models.

Click on the Go to administration button. The administration section of Service Operations will be loaded and it will go straight into the models management section, listing all available models in the current domain:

Creating a new model

Creating models in Service Operations is a fairly iterative process that commonly starts with sketching the general service or application model to monitor, and how it breaks down in terms of main building blocks, subsystems, and so forth, generally reaching the lowest level of detail with the atomic KPIs and/or KQIs that rule the operational, performance or business related-status of their affecting entities. Once that rough design of the service model is done, it becomes a far simpler task to begin translating that design in terms of actual entities and relationships in Service Operations. As a general recommendation, it is a good idea to work with two browser tabs simultaneously, the first one to navigate and perform the actual configurations on Service Operations and the second one to run and refine any queries that will be necessary for the model creation.

Please follow the steps specified in the next section to complete the creation of a new model:

  1. Go to the administration interface by clicking on the config icon in the Service Operations main menu.

  2. Click on Manage models under the Models main section on the left menu. A list of all available maps in the domain and their associated categories will be shown:

  3. Click on the Create new model button. The interface changes to the model editing mode, showing a blank configuration for the newly created one.
  4. Once there, to configure the new map, collapse the left menu (button 1 in the image): Hide the main menu of the administration module.
  5. Contextual editing tools: Add entity "+", etc., (button 2 in the image): addition, cloning or deletion of entities in the model. Since it is a context-based tool, the number of active options will vary depending on the selected entity in the map.
  6. General map setting (beside button 3, "Publish", in the image): Shows or hides the general configuration parameters of the model.

Creating entities

Click on the "+" button to add a new entity to the model. A form will be shown with all necessary parameters to be set in order to create the new entity:

Entity definition section

Parameter

Description

Value type

Auto mode

Overall behavior of the entity in terms of its status calculation. When auto-mode = off, the value of the entity will be retrieved from the result of the associated query defined for it. If auto-mode = on, the result of the value will be ignored and overrode with the warning and critical status definition as specified below.

Enabled / disabled

Name

Name of the entity

Text string

Description

Textual description of the entity

Text string

Icon

Graphical representation of the entity

Icon of the Devo icons list

Family group

Logical group the entity belongs to

Text string

Query

LinQ-format Devo query used to calculate the numeric value of the entity. The numeric value assumed by the entity will correspond to the last ‘select’ clause in the query

Query in LinQ format

Discovery key (Component value)

Column value used to identify all entity instances

Single value from the last grouping key of the specified Devo query

Inventory query

LinQ-format Devo query used to retrieve the inventory information referred to the same entity.

Query in LinQ format

Critical status definition

List of status criteria that correspond to ‘critical’ status for a summary entity

Criteria from a list

Warning status definition

List of status criteria that correspond to ‘warning’ status for a summary entity

Criteria from a list

Metadata section

Parameter

Description

Value type

Type

Main category that defines the entity being modeled.

Some of the entity types are utilized for automatic calculations of service metrics and incidents. For example, the ‘KPI’ type is reserved for any fundamental entity that monitors a concrete metric affecting its parent node.

Additionally, types ‘user’, ‘session’ and ‘device’ are utilized by the User Experience module to automatically compose the status of the service from an end-user perspective.

List of predefined values

Subtype

Subtype of the entity, more oriented to the environment or purpose it is defined, e.g., business-specific, operational, etc.

List of predefined values or custom string

Additional metadata fields

Customizable data fields per entity that can hold any sort of additional information or parameters.

Typically, these metadata fields are utilized as filtering criteria together with ‘type’ and ‘subtype’.

Metadata fields are configured as key/value pairs. The key is defined as a string, whereas the value has two different possibilities: static value (treated as another string) or a query

Key, value pairs, composed by string + string or string + LinQ query


Impact assessment section

Parameter

Description

Value type

Issue symptoms

Textual information that can provide a guidance on the best way to understand or diagnose an incident whenever it occurs

Text string

Next best actions

Textual information listing the steps that could be taken to fix or mitigate the impact of an incident.

Multiple text strings

Impact evaoluation definition

Query that is triggered any time an incident affects the corresponding entity to calculate the amount of entities directly affected by it.

For example, if an entity definition models the operational status of a web server, the impact evaluation query could be defined to calculate the subset of client hosts that have received an HTTP 500 code as a result of any connection request.

LinQ query

Impact evaluation unit

Description or unit of the entities affected by an incident (e.g., “end-users”, “network nodes”)

String

Linking entities 

To link two already-created entities use the following procedure:

  1. Click on the source entity. The entity will be shown highlighted in the model, and a  icon in the upper part of the node will be displayed.

  2. Click on the  button, keeping the button pressed down by your mouse, and start dragging the arrow to its destination.

  3. Release the button on your mouse when the arrow is pointing at the border of the targeted entity.

NOTE: Remember the relationship you are establishing is based upon impact. That means, links should be read as ‘source entity impacts the status of the targeted entity’.

Linking entities using a link criteria

The mechanism described in the previous paragraph is the standard to link entities in an all-to-all way. That means, the following table of results shall be expected when linking entities using that approach:

Cardinality of source entity

Cardinality of target entity

Expected result

One (e.g., no discovery key defined or only one entity value discovered)

One

The established link is rendered as a one-to-one relationship

One

Many (e.g., a discovery key has been defined and there are multiple discovered entities)

Single one-to-one links are rendered, one per discovered target entity

Many

One

Single one-to-one links are rendered, one per discovered source entity

Many

Many

Full all-to-all relationships mesh

In some situations though, it is necessary to link sources and targets based upon some criteria. In the event of this, it is possible to set a linking criteria to ensure only those links will be created.

The procedure to observe is as follows:

  1. Create a link between two different entities using the procedure described in the previous section.

  2. Click on the link (arrow). A form in the right hand side of the screen will be displayed with two options:

  1. Use the dropdown selectors to set the linking criteria between the two entities. Service Operations will list all grouping keys defined in both source and target entities' value calculation queries. The way this should be interpreted is as follows: “link the entities whose value in the ‘from’ column matches exactly the value of the ‘to’ column".

  1. Click apply. The link criteria is established and displayed in textual form on top of the arrow between the two linked entities.

NOTE: By definition, only those entities with grouping keys in their value calculation definition can be linked using this mechanism. If Service Operations cannot retrieve the grouping keys for both queries, a message in the same form will be displayed informing of this situation.

Setting the general configuration for the model

These settings describe the general characteristics and structure of a model. Among other things, these settings are used to configure the overall behavior of Service Operations mainly by enabling or disabling its main functional modules. Ancillary configurations are also performed in this block, such as the predefined analysis time range, etc:

Parameter

Description

Value type

Model name

Name of the model

Text string

Model icon

Icon used to describe the model in a visual way

Uploaded filename | URL

Category

Logical group the model belongs to

Selectable or custom category text string

Subcategory

Logical subgroup the entity belongs to

Selectable or custom subcategory text string

Time range

Default time window utilized to report the status of the different entities and metrics

Selectable numeric value and unit (e.g., 24 - hours)

Level - N name

Descriptive name of the N-level in the hierarchy

Text string

Inventory query

LinQ-format Devo query used to retrieve the inventory information referred to the same entity.

Query in LinQ format

Visual theme

Application visualization theme or visual skin

Light | Dark

Accent color

Main application color for visual components and texts

RGB coded in hexadecimal (#XXYYZZ)

PDF report tile

File name of the .pdf reports

Text String

PDF logo

Image file attached to the .pdf report as corporate logo

Uploaded filename | URL


Configuration subsections for Topology map

Parameter

Description

Value type

Enabled

Status of the module

Enabled | Disabled

Order in main menu

Location in Service Operations main menu

Integer within 1 to 10 interval. 1 = first item in Service Operations main menu (left), 10 = last item (right)

Layout

Default layout schema applied to the nodes visualization in the map

Hierarchy, Radial, Standard, Sequential, Organic, Structural, Lens

Orientation

Default layout orientation

Left to right, Right to left, Top to bottom, Bottom to top

Background image

Background image applied to the model

Uploaded filename | URL

Background image position

Rendering options for the background image

Contain | Cover | Center

Status panel

Availability of the status tiles panel

Enabled | Disabled

Status panel expanded

Show the status panel by default when accessing the topology map

Enabled | Disabled


Configuration subsections for Incidents viewer, Monitors, Incidents diagnostics, Traffic viewer, Alerts and Workflows, User Experience

Parameter

Description

Value type

Enabled

Status of the module

Enabled | Disabled

Order in main menu

Location in Service Operations main menu

Integer within 1 to 10 interval. 1 = first item in Service Operations main menu (left), 10 = last item (right)

Administration of models

Under the Manage models section of the Service Operations administration section it is possible to perform the following actions:

  1. List or filter out models based upon their category.

  2. Perform the following actions:

    1. Edit: Go to the editing section with the selected model.

    2. Copy / clone: Create a new model using the selected one as template.

    3. Delete: Erase the selected model.

Administration from the editing section

There is a number of additional options available for the management of models, and accessible through the general settings menu in the editing section:

  1. Combine model: Allows the addition of the entities and nodes definition of another existing model within the current one.

  2. Rename / copy: Create a copy of the current model.

  3. Delete: Erase the current model.