- 5 minutes to read

Add or manage Search Field

In this section, you will learn how to add or manage a Search Field.

As a Nodinite Administrator, there are 2 ways to manage Search Fields:

  1. From the Search Fields Overview in the administration part of the Web Client (this guide)
  2. Using the Search Field Wizard available for Nodinite Administrators within Log Views

Step 1: Add or Manage Search Field

From the Search Fields Overview, Click on the Add Search Field button, to create a new Search Field.
Add new Search Field Button
'Add Search Field' button


Step 2: Name the Search Field

Now give your Search Field a unique name.
Add or manage Search Field
Edit Search Field properties

Mandatory fields

  • Name: The Search Field must have a unique user-friendly name assigned. You can safely change this name at any point later.
  • Data Type is required to provide the proper relational operators when working with the Log Views.

The Data Types are driven by a database configuration and additional data types may be added in future versions of Nodinite. The following data types are currently documented:

Data Type Description Example value Example operators
Text =, Like, Not Like, Contains, ...
Integer a whole number 1, 42, 1337 <, >, <>, =, ...
Long Integer <, >, <>, =, ...
Real number with 2 decimals <, >, <>, =, ...
GUID =, <>, Contains, Empty, ...
Double <, >, <>, =, ...
Date time with offset =, <>, <, Empty, ...
Bitwise Integer =, <>, Contains, Starts with, ...

Data Types

Optional fields

  • Description - You can and should give your Search Fields a user-friendly description of its intended purpose
  • Web Site - You can provide a quick link for users when working with and viewing the Search Field. This quick link is usually a WIKI/Sharepoint site with additional documentation

Step 3: Manage Search Field expressions

You can Edit the Search Field Expressions for the Search Field. There can be any number of Search Field Expressions assigned on a Search Field.
Configured Search Field expressions

SearchFieldExpressions

Click on the Actions button; You can either Edit or Delete selected search field expression.
Actions

Edit - Loads the configuration for the selected Search field expression. Next, you can test and then update the configuration.

Expression

The Expression is the statement the Logging Service uses to extract values from the message body or context data on messages matching the Message Type.

Expression Type

Expression Type is the type of expression or plugin that extracts unique values (code/logic/syntax/format).

Message Type

Messages (payload/context) of Message Type to apply expression on.

Select the Message Types that this Expression should be applied on (usually at least one).

Message Type

Clicking on the link of the Message Types will open the corresponding message type from the Repository Model.

Link To Message Type

Global - Use expression on ALL Message Types.

Note: Use this feature only when you need it. All inbound messages will be processed, looking for a value to extract. This will add significant processing overhead to the Logging Service.

Optional - Optional means that messages that lack value, are not flagged in the warning state.

Processing State

From the Test expression tab, you can validate your configuration with actual data.

There are three types of processing states which are expressed as a cogwheel with a green, yellow, or red sign.

  1. OK - green, evaluation gave 1 or more results
  2. Warning - yellow, evaluation gave no result (failed to find data from provided expression)
  3. Error - Red, some major error either in the expression/plugin or the Logging Service is offline/not accessible
1. OK 2. Warning 3. Error

Update

When done, make sure to click on the 'Update' button to save changes to the Search Field Expression.
Update

Note: If you just click 'Close', your changes might be lost!

Nodinite provides a handy useful feature for your business that adds a clickable link from Log Views where Search Field values are displayed. These values can be more or less simple and/or more or less complex. Either way; For instance, if the Id stem from some internal transaction and that Id is NOT easy to read nor to remember. To avoid error-prone copy/paste operations, Nodinite can take this value and insert it into any of the available Search Field Links for that Search Field (opens the resulting URI in a new tab). Your business users, can thereby quickly, and almost without any instructions, navigate to other systems faster, with the correct data.

Search Field Link
As seen in a Log View

By clicking on the 'Edit' button, a modal dialogue is shown where one can configure one or more Search Field Links. SearchFieldLinksModalURLTestValue

The following properties can be edited for a Search Field Link:

  • Enabled - Whether the Link should be enabled making search field results as a link or not. This is useful if one temporary want to disable the link without deleting it
  • Name - The name of the link ex. OrderId, City.
  • URL - The URL where to browse when the link is clicked (which opens a new tab in the web browser)
  • Description - A suitable description that is shown when hovering the mouse pointer over the link

URL can contain an optional parameter '{value}' e.g. https://www.google.com?q={value}. The value will be replaced by the Search Field Expression value. E.g. OrderId, City, ... By entering a test value, and clicking on the link symbol at the right side of the URL-field, you can test the link (opens a new tab in the browser).

Save

When done, make sure to click 'Save' to save changes to the Search Field.
Save

When closing the dialogue you will be presented a modal to re-index selected Message Types.
Reindex

Note: Make sure to keep the number of re-index operations to a minimum, since all data (note read-only Nodinite Log databases) based on involved Message Types will be reprocessed by the Nodinite Logging Service. A re-index operation cannot be aborted!.


Next Step

Add or manage Log View
Add or manage Message Types

Search Fields Overview
Search Field Expressions
Repository Model
Logging Service
Message Type Overview