Add or manage Search Field
Create and manage Search Fields to extract business-critical values from integration messages. Search Fields enable self-service monitoring, end-to-end tracking, and business intelligence across your integration landscape.
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.
Add a New Search Field
Navigate to the Search Fields Overview in the Administration section and click the Add Search Field button.
The Add Search Field button in the Search Fields Overview.
Tip
You can also create Search Fields directly from Log Views using the Search Field Wizard. This provides context-aware setup with sample data from the current view.
Configure Basic Properties
Enter a unique, business-friendly name and select the Data Type that matches your data. Optionally, add a Description and Web Site link.
Search Field configuration screen.
Mandatory Fields
| Field | Required | Purpose |
|---|---|---|
| Name | Yes | Unique display name shown in Log Views |
| Data Type | Yes | Determines available search operators and storage format |
Optional Fields
| Field | Purpose |
|---|---|
| Description | Explain what this field represents and when to use it |
| Web Site | Link to documentation or business glossary |
Data Type Options
| 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 are available for filtering.
Tip
Naming Best Practices:
- Use business terms: "Order Number" not "OrderID_Field"
- Be consistent: Use the same terminology across all Search Fields
- Avoid abbreviations unless universally understood
- Examples: "Customer ID", "Invoice Number", "Transport Booking Number"
Important
Choose the most specific data type for your data. Using "Text" for numbers prevents range queries (>, <). Using "Integer" for GUIDs causes extraction failures.
Add Search Field Expressions
Click the Edit button in the Search Field Expressions section to add or manage expressions.
Click the Edit button to add or manage expressions for this Search Field.
Search Field Expressions configuration interface.
Click the Actions button to edit or delete a selected expression.
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.
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
Tip
Start with the simplest expression type for your data format. Use Formula only when you need to combine multiple sources or transform data.
Expression Properties
| Field | Required | Purpose |
|---|---|---|
| Expression | Yes | The pattern/path/formula used to extract values |
| Expression Type | Yes | The plugin matching your message format |
| Message Types | No | Target specific types or apply globally to all |
| Optional | No | Controls warning when no value extracted |
Message Type Assignment
Click the Message Type name to jump to its definition in the Repository Model.
Global – Apply to all Message Types
- Use for universal fields like "Message ID" or "Timestamp"
- Caution: Adds processing overhead to every message
- Performance tip: Use targeted expressions instead of complex global ones
Specific Message Types – Apply only to selected types
- Use for most scenarios—better performance and clearer debugging
- Example: Separate expressions for "Invoice from SAP" vs "Invoice from Shopify"
Optional Flag
- Enabled (checked): No value = normal processing, no warning
- Disabled (unchecked): No value = warning logged
- Use when fields may legitimately be absent (e.g., "Return Reason" on non-return orders)
Test Your Expression
Use the Test Expression tab to validate with real data from your Log Databases.
Processing States
| OK (Green) | Warning (Yellow) | Error (Red) |
|---|---|---|
| Expression successfully extracted values | No value found - check syntax or mark as Optional | Expression failed - check syntax or data format |
 |
 |
 |
Tip
Always test expressions before saving! Use real data from your Log Databases to ensure accurate extraction.
Add Search Field Links (Optional)
Search Field Links transform extracted values into clickable links to external business systems. Users can click Search Field values in Log Views to jump directly to CRM, ERP, or other systems.
Example: A clickable Search Field Link in a Log View.
Click the Edit button in the Search Field Links section to configure one or more links.
Search Field Link configuration interface.
| Field | Required | Purpose |
|---|---|---|
| Enabled | No | Turn link on/off without deleting configuration |
| Name | Yes | Display text (e.g., "View in CRM", "Open Order") |
| URL | Yes | Destination URL with {value} placeholder |
| Description | No | Tooltip explaining what the link opens |
URL Template Examples
- Simple:
https://crm.company.com/orders/{value} - With query parameter:
https://erp.company.com/search?orderId={value}&view=full - If Search Field contains "12345", becomes:
https://crm.company.com/orders/12345
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).
Testing Links
Enter a sample value and click the link icon to test navigation before saving. Verify:
- URL is constructed correctly
- Target system loads the correct record
- Authentication/permissions work for end users
Save and Re-Index
Click the Update button to save expression changes, then click Save to finalize all Search Field configuration.
Update button saves expression-level changes.
Save and Close button finalizes Search Field configuration.
Important
After clicking Update for expressions, you must also click Save to persist all changes to the Search Field itself.
Re-Index Historical Data (Optional)
After saving, you can re-index to apply this Search Field to existing messages in your Log Databases.
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
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 errors.
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.
Next Steps
Add or manage Log View
Add or manage Message Types
Formula Expression Plugin
Related Topics
What is a Search Field?
Search Fields Overview
Search Field Expressions Overview
XPath Expression Plugin
RegEx Expression Plugin
JSON Path Expression Plugin
Repository Model
Logging Service
Message Type Overview
Log Views