Apex Designer Documentation
What's New
Getting Started
Projects
Business Objects
Processes
User Interfaces
App Behaviors
Files
Dependencies
Project Settings
Libraries
Patterns and Best Practices
App Showcase

Business Objects

Define the information model for an app

Blank Profile Image
Written by David Knapp
Updated 4 months ago
3 min read

Business objects define the information model for an app.

business objects diagram

Business Object Concepts

A business object:

  • has a name (Supplier for example)
  • can have properties (name and code for example)
  • can have relationships to other business objects (locations for example)
  • can have behaviors containing business logic (checkCredit for example)
  • can have a data source where it is stored (Postgresql for example)
  • has access rules (Admins can create, update and delete but Planners can only view for example)

Special Kinds of Business Objects

There are four special types of business objects:

  1. A Join Business Object creates a "view" across two or more business objects to simplify querying. You will learn more in Business Object Join Views.
  2. A Base Type "specializes" a native type (an email base type is a special type of string). You will learn more in Base Types .
  3. An External Class adds Apex Designer metadata for classes that are not created with Apex Designer (Angular FormGroup for example). You will learn more in Business Object Settings.
  4. A Mixin is a "partial" business object that add properties and behaviors to other business objects (Last Modified mixin for example). You will learn more in Business Object Mixins.

Working with Business Objects

Business Objects are managed in Apex Designer with two pages:

  1. Business Objects Page
  2. Business Object Page

Business Objects Page

The Business Objects Page is accessed by clicking category on the ribbon.

business objects page

Project Business Objects

The Project Business Objects section is shown on the left.

You can click on a business object to open it.

You can create a new business object by entering the name in the "Add a business object..." field.

You can filter the business objects by entering text in the "Filter List" field next to the heading.

Mixins

The Mixins section is shown in the center. The section operates the same as the Project Business Objects section.

Library Business Objects

The Library Business Objects section is shown on the right. It lists all the business objects that are available from the library dependencies on the project.

Icon Buttons

There is a set of icon buttons shown at the top right:

reorderList toggles the page to display the three column presentation

shareDiagram toggles the page to display the Business Objects Diagram

content_pastePaste adds a copied business object

assignment_turned_inTodos manages todo items for business objects

Business Object Page

The business object page is accessed by clicking a business object on the Business Objects Page.

business object page

Business Object Page Sections

Working left to right and top down, the sections of the Business Object page are:

  • Properties lists the properties of the business object (see Business Object Properties for more information).
  • Relationships lists the business objects that this business object is related to (see Business Object Relationships for more information).
  • Behaviors lists the additional behaviors (beyond create, read, update, delete) for the business object (see Business Object Behaviors for more information).
  • Mixins lists any mixins that are applied to this business object (see Business Object Mixins for more information).
  • Indexes lists any indexes for this business object (see Business Object Indexes for more information).
  • Where used lists all the design artifacts that reference this business object grouped by project. Expanding a project shows links to the assets.
    Where used section
  • Join Views lists any join views that this business object participates in (see Business Object Join Views for more information).

Icon Buttons

Icon buttons on the top right include:

code View Generated Files shows the source files that are generated for this business object.

autorenew Generate Business Object generates just this business object (as opposed to Generate App on the toolbar which generates the whole app).

content_copy Copy makes a copy of this business object for pasting in this project or another.

visibility Access Rules opens the Access Control dialog (see Business Object Access Rules for more information).

assignment_turned_in Todos opens the todo list for this business object.

Powered by Apex Designer
Terms of ServicePrivacy Policy
© 2017-2022 Apex Process Consultants