Create and Manage Entity Types

Learn how to create, configure, edit, and manage ingestion entity types in Sprinto, including custom fields, reference fields, entity records, and monitoring visibility.

Entity types define how ingestion data is structured inside Sprinto.

Each entity type acts as a schema that determines:

  • Which fields exist

  • What type of data is stored

  • How records are organised

  • How ingestion plans map incoming payloads

Entity types provide a reusable data model for ingestion workflows.

Once configured, ingestion plans can store records against these entity types.


Before You Begin

Ensure that:

  • You have access to the Ingestion module

  • You understand the type of data being ingested

  • You know which fields are required

  • Related entity relationships are identified, if applicable


Access the Entities Page

To manage entity types:

  1. Log in to the Sprinto dashboard.

  2. Go to Ingestion.

  3. Select the Entities tab.

The Entities dashboard displays all configured entity types.


Understand the Entities Dashboard

The Entities page provides a central view of all entity types.

Each entity type represents a logical data structure.

The dashboard typically includes:

Column
Description

Name

Entity type name

Description

Optional explanation

Entities

Number of records linked to the entity type

Actions

Opens entity records

You can review entity counts and open related records directly from this page.


Open Entity Management

The Manage Entity option provides access to entity configuration.

Open Manage Entity

  1. Go to the Entities tab.

  2. Click Manage Entity.

Sprinto opens the entity management drawer.

The drawer displays:

  • Existing entity types

  • Field counts

  • Entity configuration options


Create an Entity Type

Create an entity type when ingestion requires a new data structure.

Add an Entity Type

  1. Open Manage Entity.

  2. Click Add Entity Type.

  1. Configure entity details.

  2. Save the entity type.

The new entity type becomes available immediately.


Configure Entity Details

Each entity type includes several configuration sections.

Basic Information

Define:

  • Entity type name

  • Description

Entity names should clearly represent the ingested object.

Examples include:

  • Device

  • Incident

  • Asset

  • Repository

  • CloudAccount


Standard Fields

Entity types automatically include standard system fields.

These fields are always present.

Standard fields commonly include:

Field
Description

Name

Human-readable record name

Identifier

Unique record identifier

URL

Source reference link

Last Seen on Source

Latest observed timestamp

Standard fields cannot be removed.


Add Custom Fields

Custom fields allow additional metadata to be stored.

Use custom fields to capture ingestion-specific values.

Add a Custom Field

  1. In the Custom Fields section, click Add Custom Field.

  1. Enter the field configuration.

  2. Save the field.

You can add multiple custom fields.


Custom Field Configuration

When adding a field, configure:

Field
Description

Field Name

Name of the field

Data Type

Stored value type

Description

Optional explanation

Allow User Editing

Allows manual updates


Supported Data Types

Entity fields support multiple value types.

Data Type
Description

String

Text-based value

Boolean

True/false value

Long

Integer value

Double

Decimal number

Timestamp

Date and time value

JSON

Structured JSON object

Choose a data type that matches the incoming payload.


Allow User Editing

Enable Allow User Editing to permit manual updates to field values.

When enabled, additional options become available.

Add Editable Options

  1. Enable Allow User Editing.

  2. Add a selectable option.

  3. Click Add.

  1. Repeat as needed.

These options become available during entity editing.


Add Reference Fields

Reference fields create relationships between entity types.

Use reference fields when one entity depends on another.

Examples include:

  • Device → User

  • Incident → Asset

  • Resource → Account

Add a Reference Field

  1. Open the Reference Fields section.

  2. Click Add Reference Field.

  1. Configure the relationship.

  2. Click Add Entity.

Multiple reference fields can be added.


Reference Field Configuration

Configure:

Field
Description

Field Name

Relationship name

Reference Type

Relationship type

Target Entity

Linked entity type

Target Field

Field used for mapping

Description

Optional explanation

Reference fields help connect ingestion datasets.


Edit an Entity Type

Existing entity types can be modified.

Edit an Entity Type

  1. Open Manage Entity.

  2. Select the required entity type.

  3. Click Edit.

  1. Update the configuration.

  2. Click Update Entity to save changes.

Changes become available immediately.


View Entity Records

Each entity type contains ingestion records.

You can view these records directly from the Entities dashboard.

Open Entity Records

  1. Locate an entity type.

  2. Click View Entities.

Sprinto opens the entity details page.


Entity Details Page

The entity details page contains multiple tabs.

Tabs include:

  • Details

  • Entities

  • Monitoring

Each tab provides visibility into a different aspect of the entity type.


Details Tab

The Details tab displays schema information.

This includes:

  • Entity metadata

  • Field definitions

  • Configuration information

Field tables display:

Column
Description

Field Name

Entity field

Type

Stored value type

Required

Whether the field is mandatory

Description

Field explanation


Entities Tab

The Entities tab lists all records stored for the entity type.

Each row represents an ingested record.

You can:

  • Search records

  • View identifiers

  • Review timestamps

  • Open record details


View an Entity Record

Open an individual record to inspect ingestion output.

Open Entity Record Details

  1. Go to the Entities tab.

  2. Locate a record.

  3. Click View.

Sprinto opens the entity record page.


Entity Record Details

The entity record view displays:

Metadata

Includes:

  • Entity identifier

  • Created timestamp

  • Updated timestamp

  • Source reference

Field Values

Displays all mapped custom values.

Raw Data

Displays ingestion metadata or payload structure.

Monitoring Visibility

Shows checks associated with the entity.


Monitoring Tab

The Monitoring tab shows checks associated with the selected entity type.

This allows you to review:

  • Linked monitoring checks

  • Status visibility

  • Related evaluation coverage

Monitoring helps validate how ingestion entities participate in workflows.


Entity Workflow

A typical entity lifecycle follows this sequence:

  1. Create an entity type.

  2. Define fields.

  3. Configure references.

  4. Save the entity schema.

  5. Attach the entity to ingestion plans.

  6. Ingest records.

  7. Review entity records.

  8. Monitor related checks.


Best Practices

Use the following recommendations when creating entity types:

  • Use clear entity names

  • Add descriptions for custom fields

  • Use reference fields only when relationships exist

  • Match field types to source payloads

  • Keep field structures reusable

  • Limit JSON fields when structured fields are available

  • Use editable fields sparingly

  • Review entity records after ingestion


Last updated