Add or manage Search Field
Search Fields are the foundation of self-service integration monitoring in Nodinite. This guide walks you through creating and managing Search Fields—transforming raw integration data into searchable, actionable business intelligence.
What you'll achieve:
- Extract business-critical values from any message format (XML, JSON, EDI, CSV, flat files)
- Enable end-to-end tracking by correlating messages across all your systems
- Empower business users with self-service search using familiar business terms
- Connect to external systems with clickable Search Field Links for seamless navigation
- Search retroactively by applying new fields to historical data through re-indexing
- Group related messages together for complete transaction visibility
New to Search Fields? Read What is a Search Field? to understand the concepts before diving into configuration.
A Search Field applies to Log Events in all Log Databases and can target specific Message Types for precise data extraction.
What You Will Learn
By following this guide, you'll master:
- Creating Search Fields with the right data types and naming conventions
- Configuring expressions to extract values from messages (no coding required for standard formats)
- Setting up Search Field Links to connect Nodinite with your business systems
- Assigning Message Types for targeted or global extraction
- Testing expressions with real data before deployment
- Re-indexing strategies to apply fields to historical data efficiently
Step 1: Add or Manage a Search Field
There are two ways to create and manage Search Fields in Nodinite:
- From the Search Fields Overview in the Administration section (this guide)
- Best for: Planning and managing multiple Search Fields centrally
- Full control over all configuration options
- Using the Search Field Wizard within Log Views
- Best for: Quick ad-hoc creation while analyzing logs
- Context-aware setup with sample data from current view
To create a new Search Field, navigate to the Search Fields Overview and click the Add Search Field button.
The Add Search Field button in the Search Fields Overview.
Step 2: Name and Configure the Search Field
Choose a clear, business-friendly name and the appropriate data type for your Search Field. These choices determine how users will search and filter data in Log Views.
Search Field configuration screen.
Mandatory Fields
Name – The display name shown to all users in Log Views.
- Must be unique across all Search Fields
- Use business terms, not technical jargon (e.g., "Order Number" not "OrderID_Field")
- Can be changed at any time without losing data
- Examples: "Customer ID", "Invoice Number", "Transport Booking Number"
Data Type – Determines which search operators are available in Log Views and how values are stored.
Tip: Choose the most specific data type for your data. Using "Text" for numbers prevents range queries (>, <). Using "Integer" for GUIDs causes extraction failures.
| Data Type | Description | Example value | Example operators |
|---|---|---|---|
| Text | Free text | Order123, Invoice456 | =, Like, Not Like, Contains, ... |
| Integer | Whole number | 1, 42, 1337 | <, >, <>, =, ... |
| Long Integer | Large whole number | 1234567890 | <, >, <>, =, ... |
| Real number with 2 decimals | Floating point | 123.45, 67.89 | <, >, <>, =, ... |
| GUID | Globally unique identifier | 550e8400-e29b-41d4-a716-446655440000 |
=, <>, Contains, Empty, ... |
| Double | Double-precision number | 3.14159, 2.71828 | <, >, <>, =, ... |
| Date time with offset | datetimeoffset (Transact-SQL) | YYYY-MM-DDThh:mm:ss[.nnnnnnn][{+\|-}hh:mm]YYYY-MM-DDThh:mm:ss[.nnnnnnn]Z (UTC) |
<, >, <>, = and more |
| Bitwise Integer | Bitwise value | 0x1F, 0x2A | =, <>, Contains, Starts with, ... |
The data type determines which operators (equals, greater than, contains, etc.) are available for filtering.
Optional Fields
Description – Explain what this Search Field represents and when to use it.
- Visible to all users when hovering over the field in Log Views
- Include business context: "The unique identifier from our CRM system"
- Mention any special formatting or validation rules
Web Site – Link to related documentation or business system.
- Can point to internal wikis, process documentation, or system URLs
- Examples: Link to your data dictionary, business glossary, or API documentation
- Helps users understand data lineage and context
Step 3: Manage Search Field Expressions
Search Field Expressions define how values are extracted from your integration messages. A single Search Field can have multiple expressions—each targeting different Message Types or data formats.
Click the Edit button to add or manage expressions for this Search Field.
Click the Actions button to edit or delete a selected expression.
Understanding Expression Types
Nodinite provides 12 built-in expression plugins—no coding required for standard formats:
For XML Messages:
- XPath – Standard XPath extraction
- XPath with RegEx – Extract and filter with regular expressions
- XPath on Message Context – Extract from message context properties
- XPath on Wrapped XPath – Multi-level XPath extraction
For JSON Messages:
- JSON Path – JSONPath extraction
For Text/EDI/Custom Formats:
- RegEx – Regular expression pattern matching
- RegEx with capturing groups – Extract multiple values
- RegEx on Message Context – Pattern match on context properties
- RegEx on Message Context with capturing groups – Multi-value context extraction
For Flat Files:
- Flat File CSV – Extract from CSV files
- Flat File Fixed Width – Extract from fixed-width files
For Advanced Scenarios:
- Message Context Key – Direct context property access
- Formula – Combine and transform values with 31 built-in functions
Best Practice: Start with the simplest expression type for your data format. Use Formula only when you need to combine multiple sources or transform data.
Expression – The pattern/path/formula used by the Logging Service to extract values.
Expression Type – Choose the plugin that matches your message format and extraction needs.
Assigning Message Types
Message Types determine which messages this expression will process. You can be specific (target individual message types) or global (apply to all).
Click the Message Type name to jump to its definition in the Repository Model.
Global – Apply this expression to all Message Types.
- When to use: Universal fields like "Message ID" or "Timestamp" that appear in every message
- Caution: Adds processing overhead to every message. Use only when truly universal.
- Performance tip: Use multiple targeted expressions instead of one complex global expression
Specific Message Types – Apply only to selected Message Types.
- When to use: Most scenarios—target specific formats and systems
- Benefits: Better performance, clearer debugging, prevents false positives
- Example: Create separate expressions for "Invoice from SAP" vs "Invoice from Shopify"
Optional Flag – Controls warning behavior when no value is extracted.
- Enabled (checked): No value = normal processing, no warning logged
- Disabled (unchecked): No value = warning logged in Nodinite
- When to use optional: For fields that may legitimately be absent (e.g., "Return Reason" on non-return orders)
Testing Your Expression
Always test expressions before saving! The Test Expression tab lets you validate with real data from your Log Databases.
Processing States:
- OK (Green) – Expression successfully extracted one or more values.
- Warning (Yellow) – No value found. Check expression syntax or mark as Optional.
- Error (Red) – Expression failed. Check syntax, data format, or Logging Service status.
| 1. OK | 2. Warning | 3. Error |
|---|---|---|
 |
 |
 |
Step 4: Add or Manage Search Field Links
Search Field Links transform static data into clickable hyperlinks—enabling users to jump from Nodinite directly into external business systems. This bridges the gap between integration monitoring and business operations.
Why use Search Field Links?
- Faster problem resolution: One click from logs to full system details
- Reduced context switching: No manual copy-pasting or URL construction
- Empowered users: Business teams can self-serve without knowing system URLs
- Seamless workflows: Turn integration data into actionable navigation
Example: A clickable Search Field Link in a Log View—one click to jump to the external system.
Click the Edit button to configure one or more Search Field Links for this Search Field.
Configuration Properties
Enabled – Turn the link on or off without deleting the configuration.
- Useful for temporarily disabling links during system maintenance
- Disabled links show the value as plain text
Name – The display text for the link.
- Examples: "View in CRM", "Open Order in SAP", "Track Shipment"
- Keep it short and action-oriented (2-4 words)
URL – The destination URL template using {value} as a placeholder.
- The
{value}parameter is replaced with the actual Search Field value - Example:
https://crm.company.com/orders/{value} - If the Search Field contains "12345", the link becomes:
https://crm.company.com/orders/12345 - Can use query parameters:
https://erp.company.com/search?orderId={value}&view=full
Description – Tooltip shown when users hover over the link.
- Explain what the link opens: "Opens the order details page in SAP"
- Helpful when you have multiple links for the same Search Field
Testing Search Field Links
Enter a sample value and click the link icon to test navigation before saving. Verify:
- URL is constructed correctly with your sample value
- Target system loads the correct record
- Authentication/permissions work for end users
Pro Tip: You can configure multiple links for the same Search Field. Example: A "Customer ID" field might link to both your CRM (customer profile) and ERP (account balance).
Step 5: Save and Re-Index
After configuring your Search Field, you need to save it and optionally re-index historical data.
Saving Changes
If you're editing an existing Search Field, click the Update button to save expression changes first.
Update button saves expression-level changes.
Important
After clicking Update, you must also click the Save button to persist all changes to the Search Field itself.
When all configuration is complete, click Save to persist your Search Field.
Re-Indexing Historical Data
After saving, you can re-index to apply this Search Field to existing messages in your Log Databases.
Example: Re-indexing selected Message Types to apply the new Search Field to historical data.
When to re-index:
- You added a new Search Field and want to search historical data
- You modified an expression and need to recalculate existing values
- You're preparing for compliance audits requiring retroactive search
- You're just testing—wait until production-ready to avoid overhead
Re-indexing Best Practices:
- Plan ahead: Re-indexing can be time-consuming on large databases. Schedule during low-traffic periods.
- Be selective: Only re-index the Message Types that need it. Don't select "All" unless necessary.
- Cannot abort: Once started, re-indexing runs to completion. Test thoroughly before starting.
- Read-only databases: Automatically excluded from re-indexing operations.
- Monitor progress: Check the Logging Service logs for re-indexing status and any errors.
Performance Tip: If adding multiple Search Fields, configure all of them first, then do one re-index at the end instead of re-indexing after each field.
Best Practices & Tips
Naming Conventions
- Use clear, business-friendly names: "Order Number" not "ord_num"
- Be consistent: If you use "Customer ID" in one place, don't use "Customer Number" elsewhere
- Avoid abbreviations unless universally understood in your organization
Expression Design
- Start simple: Use the most specific expression type for your data format
- Test with real data: Always use the Test Expression feature before deploying
- Be specific with Message Types: Avoid global expressions unless truly universal
- Document complex expressions: Use the Description field to explain business logic
Performance Optimization
- Choose the correct data type: "Integer" for numbers, "Text" for strings—don't use "Text" for everything
- Limit global expressions: They process every message regardless of type
- Batch re-indexing: Configure multiple fields, then re-index once
- Monitor extraction warnings: High warning rates may indicate incorrect expressions
Search Field Links
- Test before deploying: Verify URL templates work with sample data
- Use descriptive names: "Open in CRM" is clearer than "Link"
- Consider authentication: Ensure target systems support direct URL access
- Multiple links: Don't hesitate to add several links for different contexts
Maintenance
- Regular reviews: Audit Search Fields quarterly—remove unused ones
- Version control: Document changes to expressions in the Description field
- User feedback: Ask business users if Search Field names make sense
- Monitor performance: Track re-indexing times and extraction rates
Next Steps
Now that you've created your Search Field:
Learn More
What is a Search Field? – Understand the concepts and business value
Search Field Expressions Overview – Explore all 12 expression plugins
XPath Expression Plugin – Extract from XML messages
RegEx Expression Plugin – Pattern matching for text/EDI
JSON Path Expression Plugin – Extract from JSON messages
Formula Expression Plugin – Advanced transformations with 31 functions