Object General Settings

Explains how to configure an object’s General Settings, including naming, workflow behavior, searchability, display options, and platform inclusion.

circle-check

Overview

General Settings define the core identity, behavior, and visibility of an Object. These settings determine how the object is named, displayed, searched, and where it appears across the platform.

Most settings can be updated after creation. Some settings are immutable and should be configured carefully.

During Object configuration, General Settings appears as Step 1:

  1. General Settings

  2. Related Objects

  3. Customize Fields

  4. Customize Layout

  5. Permissions


Object Identity Fields

Object identity fields define how the Object is labeled in the UI and referenced internally.

  • Object Name (required): The plural, user-facing name of the Object. This name appears in navigation, list views, and settings. Example: Orders

  • Entity Name (required): The singular form of the Object name. Used when referring to an individual Record and in system messaging. Example: Order

  • Object API Name: The programmatic identifier used in API endpoints and automations. It’s generated from the object name and can be changed via API, but doing so is discouraged because it may break integrations. This value remains consistent across businesses that share the same schema, unlike the object ID, which is unique per business.

  • Object ID: A system-generated unique identifier for the Object. Read-only.


Workflow and Filtering

These settings control whether the Object behaves as a static data container or a lifecycle-driven workflow.

  • Contains Workflow: Enables stage-based lifecycle behavior for the Object. When enabled, the Object becomes a workflow (pipeline) object that supports stages, lifecycle tracking, and related system fields. This setting is immutable after object creation, so enable it only for objects that must move through a defined process. For more information see, Object Workflows.

  • Enable Quick Filters: Allows users to filter Records in list views using predefined filters.

  • Display & Search: Controls how Records are labeled and discovered across the platform.

  • Display Name Template: Controls how Records are labeled and displayed throughout the UI.

    • Uses field placeholders (for example, {{ name }} or {{ first_name }} {{ last_name }}) to dynamically generate Record labels

    • Useful when a single primary field isn’t enough to clearly identify a Record

    • Helps improve clarity in lists, lookups, and relationship fields

    • The Display Name field is not shown by default for most Objects, since a standard primary field usually provides sufficient identification

  • Fields to Include in Search: Specifies which fields are searched when users search for Records of this Object. Include fields users are most likely to search by, such as names or identifiers.

circle-info

Note: Only supported field types (for example, text-based or searchable identifier fields) can be included; non-searchable field types such as files, long-form content, or certain structured fields are excluded from search indexing.


Description and Visuals

Description and Visuals define the Object’s purpose and establishes its visual identity across the platform to improve recognition and administrative clarity.

  • Object Description: A short description of the Object’s purpose. This appears in settings and helps administrators understand how the object is intended to be used.

  • Default Color & Default Icon: Define the Object's visual identity across the platform. The default color appears in the toolbar and related Object blocks (and can be overridden in certain contexts), while the default icon provides a consistent visual marker in navigation and Record views.


Enabling Activities and Tracking Entity Value

Enabling Activities and Tracking Entity Value settings determine where the Object appears and which platform features it participates in.

  • Enable Activities: Allows activities (such as tasks or logged actions) to be associated with Records of this object. See Activities.

  • Track Entity $ Value: Enables value tracking for Records of this object, allowing Kizen to calculate totals such as pipeline or commerce value.


What's Next

After configuring your General Settings, continue to Object Workflows to define lifecycle stages (if the object contains a workflow), or proceed to Related Objects to connect this object to others in your data model.

Last updated

Was this helpful?