Log View Search Criteria Tab

The Search criteria tab is the second of five tabs when you add or manage a Log View. It decides what users search on, and what they can never see. Business users get the most from a Log View when it opens with the one field they know, such as an order number, while Restrictions quietly keep everything else out of scope.

Animated walkthrough: two fields in the default search setup, and the search panel users get.

1. Open the Search criteria tab. Here the Default search setup holds O2C - Order ID only.
2. Click Edit on Default search setup, then Add new clause.
3. Pick the field O2C - Customer ID and the operator =. Leave the value empty: users type it.
4. Click Confirm and close, then Save and show. The search panel shows exactly the two fields.
5. Type CUST-002 in O2C - Customer ID and click Search. The result lists that customer's orders, with the Customer ID column filled.

Understanding the Search criteria tab

Users see and change the default search setup and the optional fields (teal) within the time range (blue); the Restrictions (red) apply to every search, and users can't see their values or change them.

The options of the Search criteria tab.

For how users run a search, see How to perform a Search.

Which Search Field values users see

Add every field users need to see. A Log View shows the values of the Search Fields it includes: those in the Default search setup, the Optional fields, the Group by fields (Grouping tab), and the columns of the Display result tab.

• A field used only in a Restriction filters the events, but its value stays hidden.
• For a field the Log View doesn't include, a user sees nothing: the field isn't listed on the event's Search Field Values tab. An administrator sees the field marked Hidden, without its value. Only the built-in Admin view shows every value.

The System Parameter HideSearchFieldValuesInLogViews (default true) controls this, and HideAdditionalFieldValuesInLogViews can hide or mask built-in event fields. The full rule, with seven walkthroughs, is in Which Search Field Values a Log View Shows.

Time Interval Configuration

Assign a Time Interval Configuration to set the time ranges users may pick when they search.

Select the Time Interval Configuration to use with the Log View.

Once a configuration is selected, quick access links above the dropdown open the selected configuration or Add New to create one; see the example on What is a Time Interval Configuration.

• Without a configuration, users get a free date range: a date picker with presets such as Today, Last 7 Days, and Last 365 Days. It starts on today.
• With a configuration, users pick one of its ranges from a dropdown, starting on the first. They can switch to a free date range only when the configuration allows detailed time search.

Animated walkthrough: the Log View offers the four ranges of the configuration, and no free date range.

1. On the Search criteria tab, pick the Time Interval Configuration Contoso: Order follow-up (last hour, day, week, and month).
2. Click Save and show.
3. Open the time range in the Log View. It lists the configuration's four ranges, and nothing else, because this configuration doesn't allow detailed time search.

Restrictions

Restrictions limit the events the Log View can ever return, for example to one customer or one environment.

Note

Users can't see the value of a Restriction or change it, and they can't get around it by changing the other search options.

1. On the Search criteria tab, click Edit on the Restrictions card. Assign restrictions opens for the Log View.
2. Click Add new clause, and pick the Field, the Operator, and the Value, for example O2C - Customer ID = CUST-004. Combine several clauses with And/Or, and group them with Add new bracket.
3. Click Confirm and close, then Save and show.
4. The search panel shows only the default search setup. Search without a value: the result holds only that customer's orders, and the O2C - Customer ID column reads N/A on every row.

Animated walkthrough: from an empty Restrictions card to a Log View that only ever returns one customer's orders.

The N/A column is by design. With Display result on Default, a field used in a Restriction becomes a column, but its values are never shown, so users don't learn what the administrator restricted on.

The dialog works like the search panel in Advanced mode. Its Field list offers every Search Field, the built-in Log Event fields (Log Status Code, Message Type, Endpoint Name, Direction, Log Text, and the others), and the Comment fields. To limit a Log View to Repository Model items, such as Endpoints, Systems, or Integrations, use the Data to search tab instead.

A Restriction doesn't make its field's value visible, and it doesn't hide it either. To show the value, also add the field to the Default search setup, the Optional fields, or a column; then its values show as usual.

Animated walkthrough: the Restriction filters on the customer, but the customer's value stays hidden.

Default search setup

The default search setup decides which Search Fields the search panel shows, with the operator and value each starts with. When it has two fields, users see only those two, and type a value. A clause without a value is left out of the search, so an empty field doesn't filter. The walkthrough at the top of this page adds a second field.

Check Collapse display on the card to show the search fields panel collapsed when the Log View opens.

The default search setup of the Log View: users search on the order number.

Optional fields

Optional fields are more fields users may add to their search. The Optional fields picker offers every Search Field, 26 built-in Log Event fields, and the Comment fields (Text, Latest Text, Created, and Created By). Built-in fields you may want include:

• Log Status Code - Whether processing went fine; for example, 0 is OK in BizTalk. See Log Status Codes.
• Sequence Number - The number of a step in a run, when you know exactly which event to get.
• Log text - The text logged with the event, to narrow down the result.

An Optional field's value shows in the event details. It also gets a column in the result list (with Display result on Default) and shows its values from the first search; users may also add it to their search. To control the columns yourself, use the Display result tab.

Animated walkthrough: the Optional field's column shows its values from the first search, and users may also search on it.

1. On the Search criteria tab, click Edit on Optional fields.
2. Tick Contoso: Order Total, click Confirm and close, then Save and show.
3. In the Log View, type ORD-10001 in O2C - Order ID and click Search. The Order Total column shows the order's total, though the search doesn't use the field.
4. To search on the field too, switch on Advanced mode and click Add new clause.
5. Pick the field Contoso: Order Total and the operator Not Empty, and click Search. The search now uses the Optional field: only the events that have an order total are left.

Auto Start Search

When checked, the search runs as soon as the Log View opens, with the values of the default search setup over the starting time range (see Time Interval Configuration). Clauses without a value are left out, so an empty default search setup lists every event in that range.

Next Steps

• Log View Data to Search Tab - Which events are in scope
• Add or Manage Log View - All five tabs
• Add or manage Search Field - Make a business value searchable

Related Topics

• What is a Log View?
• Log View General Tab
• Log View Display Result Tab
• Log View Grouping Tab
• Search Fields
• Time Interval Configurations
• Which Search Field Values a Log View Shows
• HideSearchFieldValuesInLogViews
• Working with Log Views