Start typing to search.

Guides

Use Data Explorer presets in practice

View Markdown

Save team-visible Data Explorer queries, parameterize changing values, use typed MongoDB record pickers, apply presets, and manage scope.

Data Explorer presets save a useful investigation: connector and resource scope, visual filters or a raw query, columns, sorting, output mode, and optional typed parameters. Team presets are stored in Envoy and appear in the Presets menu for matching scope.

Use presets for recurring support queries, migration review, exception queues, and relationship lookups. Use dashboards for fixed customer-facing workflows.

Start with a working exploration

  1. Open Data Explorer.
  2. Choose a connector and resource.
  3. Add the minimum base filter.
  4. Select useful columns and sort.
  5. Test pagination and export.
  6. Run the query and inspect the result.

Only promote the view to a preset after its filter and field types have been tested against representative data.

Save the current view

  1. Open Presets.
  2. Choose Save current as preset.
  3. Enter a clear team-visible name.
  4. Decide which visual filter values should remain fixed.
  5. Promote changing filter values to parameters.
  6. Save.

Envoy scopes the preset to the selected connector and resource. Presets are team artifacts, not private bookmarks.

Add typed parameters

Parameterize a filter when the value changes each time but the rest of the query should remain stable. For example, a visual MongoDB filter can store:

{
  "field": "migration_job_id",
  "operator": "eq",
  "value": "{{job}}",
  "valueType": "objectId"
}

Parameter types are:

  • string for text or externally defined IDs;
  • objectId for a validated 24-character MongoDB ObjectId;
  • mongoRecord for choosing a document from a MongoDB collection.

A mongoRecord parameter can display a friendly field while storing _id or another selected field. Configure its collection, label, search fields, base filter, and sort so the picker stays useful and scoped.

For a raw MongoDB preset, placeholders must be inside JSON string values:

{
  "method": "aggregate",
  "pipeline": [
    {
      "$match": {
        "migration_job_id": {
          "$oid": "{{job}}"
        }
      }
    }
  ]
}

Parameterized raw SQL and OData queries are not supported.

Respect MongoDB types

MongoDB _id and relationship fields are often ObjectIds, not strings. Set valueType: objectId on a visual filter or use { "$oid": "{{name}}" } in raw Extended JSON.

If a pasted filter returns no rows, inspect the collection schema and compare the runtime types before changing values.

Apply and manage presets

Choose a team preset from Presets. If it has parameters, Envoy prompts for values, substitutes them, applies the state, and runs the query. Recent parameter values can be remembered in the browser for convenience.

Use Manage team presets to inspect, rename, apply, or delete matching presets. The creator or an authorized administrator can rename a preset; deletion requires an administrator and is irreversible.

Design checklist

  • Use a clear, unique team-visible name.
  • Scope to the intended connector and resource.
  • Keep fixed status or tenant constraints literal.
  • Select only fields needed for the workflow.
  • Sort on indexed fields.
  • Type ObjectIds and dates explicitly.
  • Bound record-picker searches.
  • Test empty, invalid, and missing parameters.
  • Apply the preset from a fresh browser session before sharing it with the team.

See Data Explorer presets reference and Data Explorer.