Skip to main content

Suite Builder Comprehensive Guide

This guide provides a systematic, end-to-end approach to SuiteBuilder. It covers every core component (records, fields, lists, forms, subtabs, sublists, and navigation) and shows how to design, build, and govern customizations in a consistent way.

Use this guide as the primary workflow map. For deep dives, see:

SuiteBuilder Component Map​

ComponentPurposeTypical Navigation
Custom RecordsCreate new record types with their own fields, permissions, and formsCustomization -> Lists, Records, & Fields -> Record Types
Custom FieldsAdd fields to standard or custom recordsCustomization -> Lists, Records, & Fields -> (field type)
Custom ListsDefine controlled value sets for list/record fieldsCustomization -> Lists, Records, & Fields -> Lists
Custom FormsLayouts and role-specific UI for records and transactionsCustomization -> Forms -> Entry Forms or Transaction Forms
SubtabsOrganize fields into logical sectionsCustomization -> Forms -> Subtabs
SublistsShow related records or line detailsCustomization -> Forms -> Sublists
Center Tabs/Categories/LinksNavigation structure per roleCustomization -> Centers and Tabs
Custom Segments (if enabled)Add classification-like dimensions to transactionsCustomization -> Lists, Records, & Fields -> Custom Segments

Note: Menu labels can vary by role or enabled features.

Systematic Build Workflow​

Phase 1: Define Requirements and Data Model​

Key questions:

  • What data must be stored, reported, and controlled?
  • Are these values a list, a record, or a segment?
  • Who needs access (roles and permissions)?

Outputs:

  • Data dictionary (fields, types, and owners)
  • Relationship map (parent/child and lookups)
  • Role and access matrix

Phase 2: Create Core Objects​

Actions:

  • Create custom records for new entities
  • Create custom lists for simple controlled values
  • Create custom segments if you need classification fields across transactions

Outputs:

  • Record types, list values, and segment definitions
  • Initial permissions for each object

Phase 3: Add Fields and Relationships​

Actions:

  • Add custom fields to records and transactions
  • Define list/record relationships and sourcing
  • Set validation, defaults, and display behavior

Outputs:

  • Field map (IDs, types, sourcing, validation)
  • Relationship fields and link records (if needed)

Phase 4: Design Forms and Layouts​

Actions:

  • Create or copy entry and transaction forms
  • Group fields into subtabs
  • Configure sublists and line fields
  • Assign forms to roles

Outputs:

  • Form variants by role or process
  • Layout standards for each record or transaction

Phase 5: Security and Governance​

Actions:

  • Apply record and field permissions
  • Verify form access and role-based visibility
  • Document naming conventions and ownership

Outputs:

  • Security matrix validated in sandbox
  • Governance checklist completed

Phase 6: Testing and Deployment​

Actions:

  • Test with real role permissions and sample data
  • Validate searches, reports, and integrations
  • Deploy via SDF or controlled release steps

Outputs:

  • UAT signoff
  • Deployment and rollback plan

Choose the Right Object Type​

NeedBest FitWhy
A standalone business entity with multiple fieldsCustom RecordFull data model, permissions, searches, and forms
A simple controlled value listCustom ListLightweight and reusable value set
A classification dimension used across transactionsCustom SegmentWorks like Department/Class (if enabled)
A new field on an existing recordCustom FieldExtends a standard record without replacing it

Rule of thumb: if the values need their own fields or lifecycle, use a custom record. If they are just a short set of values, use a custom list.

Component Playbooks​

Custom Records​

Use custom records when you need a new entity that behaves like a native record.

Key design points:

  • Define the record purpose and ownership
  • Plan parent/child relationships
  • Decide numbering and naming strategy
  • Set permissions and access for roles
  • Create a default entry form

Common patterns:

  • One-to-many: parent record with a child record list
  • Many-to-many: use a linking record that references both sides

Custom Fields​

Use custom fields to extend standard or custom records.

Focus areas:

  • Field type and storage behavior
  • Sourcing and filtering
  • Validation and default values
  • Display type and role visibility

See Custom Fields for details.

Custom Lists​

Use custom lists for controlled values that do not require their own record fields.

Guidelines:

  • Keep values clean and stable
  • Use internal IDs for integrations
  • Mark values inactive instead of deleting
  • Reuse the list across multiple fields when possible

Custom Forms​

Use custom forms to tailor UI layouts, default values, and field visibility.

Guidelines:

  • Start from a standard form and copy
  • Create role-specific forms when processes differ
  • Keep field order consistent across similar forms

See Custom Forms for details.

Subtabs​

Use subtabs to group fields by topic or workflow stage.

Guidelines:

  • Keep subtabs focused and predictable
  • Use consistent naming across related records
  • Avoid too many tabs on a single form

Sublists​

Use sublists to display related data or line items.

Guidelines:

  • Show the most important fields in the sublist view
  • Hide or move rarely used columns
  • Use inline editing only where process allows it

Use centers and tabs to organize navigation for each role.

Guidelines:

  • Group links by role tasks (not by system modules)
  • Keep the number of center tabs limited
  • Assign centers explicitly to roles for consistency

Security and Access Checklist​

  • Record permissions aligned to roles
  • Field-level visibility reviewed for sensitive data
  • Forms assigned to the correct roles
  • Center tabs and links aligned to user tasks
  • Inactive values hidden where appropriate

Reporting and Search Readiness​

  • Custom fields set to show in list views when needed
  • Saved searches updated to include new fields
  • Custom record searches created for operational reporting
  • External integrations updated for new field IDs

Coverage Checklist (All SuiteBuilder Components)​

  • Custom records
  • Custom fields
  • Custom lists
  • Custom forms (entry and transaction)
  • Subtabs
  • Sublists
  • Center tabs, categories, and links
  • Custom segments (if enabled)
  • Role-based security and form assignment