Acumatica Framework Guide

version: 2026 R2

Acumatica Framework Guide
Acumatica Framework Overview
Acumatica Cloud xRP Platform
Application Programming Overview
Getting Started with Acumatica Framework
Querying of the Data
Business Logic Controller Declaration
Data View and Cache
Data Modification Scenarios
Business Logic Implementation
Preparing a Test Instance for Customization
Test Instance for Customization: General Information
Test Instance for Customization: To Deploy an Instance with Custom Maintenance Forms
Test Instance for Customization: To Deploy an Instance with Custom Maintenance and Data Entry Forms
Test Instance for Customization: To Deploy an Instance with a Custom Form That Implements a Workflow
Designing the Application
Designing the Database Structure and DACs
System and Application Tables
Naming Conventions for Tables (DACs) and Columns (Fields)
Common Columns and Data Types
Primary Key
Foreign Keys and Nullable Columns
Audit Fields
Concurrent Update Control (TStamp)
Attachment of Additional Objects to Data Records (NoteID)
Preservation of Deleted Records (DeletedDatabaseRecord)
Multitenancy Support (CompanyID, CompanyMask)
Multiple Branch Support (BranchID, UsrBranchID)
Designing the User Interface
Form Types
Form and Report Numbering
Item Grouping In the More Menu
Naming the Graphs and Event Handlers
Graph Naming
Naming Conventions for Event Handlers Defined in Graphs
Configuring ASPX Pages and Reports
Overview of ASPX Pages in Acumatica Framework
Technical Overview of the User Interface
Processing of a Button Click
Configuring the ASPX Page
Configuration of the Datasource Control
Configuration of Callback Commands
Configuration of Callbacks
Configuring Containers
Configuration of Container Controls
Use of the DataMember Property of Containers
Use of the SkinID Property of Containers
Use of the Caption Property of Containers
Use of Multiple Data Views for Boxes in Containers
Use of the PXPanel Container
Configuring Tables
Configuration of Grids
Use of the SyncPosition Property of PXGrid
Use of the DisplayMode Property of PXGridColumn
Use of the Type Property of PXGridColumn
Controls for Joined Data Fields
Configuring Tabs
Conditional Hiding of a Tab Item
Configuring Boxes
Input Controls
Use of the CommitChanges Property of Boxes
Use of the DataField Property of PXGroupBox
Use of the Caption Property of PXGroupBox
Use of the RenderStyle Property of PXGroupBox
To Enable Callback for a Control
Configuring Layout and Size
Predefined Size Values
Use of the StartRow and StartColumn Properties of PXLayoutRule
Use of the ColumnWidth, ControlSize, and LabelsWidth Properties of PXLayoutRule
Use of the ColumnSpan Property of PXLayoutRule
Use of the Merge Property of PXLayoutRule
Use of the GroupCaption, StartGroup, and EndGroup Properties of PXLayoutRule
Use of the SuppressLabel Property of PXLayoutRule
Maintaining Reports
Display of Reports
Display of Analytical Reports
Accessing Data
Querying Data in Acumatica Framework
BQL and LINQ
Data Access Classes
PXView and PXCache of the Data View
PXView Type and Views Collection
Query Cache
Data Query Execution
Translation of a BQL Command to SQL
Merge of the Records with PXCache
Comparison of Fluent BQL, Traditional BQL, and LINQ
Fluent BQL and Traditional BQL Equivalents
To Execute BQL Statements
To Process the Result of the Execution of the BQL Statement
Creating Fluent BQL Queries
Fluent Business Query Language
Data Access Classes in Fluent BQL
Search and Select Commands and Data Views in Fluent BQL
Constants in Fluent BQL
Parameters in Fluent BQL
To Select Records by Using Fluent BQL
To Update Data in Fluent BQL
To Use Parameters in Fluent BQL Queries
Creating Traditional BQL Queries
Traditional Business Query Language
Data Access Classes in Traditional BQL
PXSelect Classes
The Classes That Compose BQL Statements
Parameters in Traditional BQL Statements
Traditional BQL and SQL Equivalents
To Select Records By Using Traditional BQL
To Filter Records
To Order Records
To Query Multiple Tables
To Group and Aggregate Records in Traditional BQL
To Use Parameters in Traditional BQL
To Use Arithmetic Operations
To Compose a BQL Statement from an SQL Statement
DAC Aliasing and Self-Joins
UNION and UNION ALL Operations in Traditional BQL
Creating LINQ Queries
LINQ in Acumatica Framework
Deferred LINQ Query Execution
Fallback to the LINQ to Objects Mode
To Select Records by Using LINQ
To Append LINQ Expressions to BQL Statements
Defining Relationships Between DACs
Master-Detail Relationship Between Data with PXDBDefault and PXParent
Relationship Between Data with PrimaryKeyOf and ForeignKeyOf
Selection of the Linked Data Through the Current Property
To Define a Primary Key
Using a Primary Key
To Define a Foreign Key
To Define a Unique Key
Using Dirty and Global Caches
Working with Data in Cache and Session
Modification of Data in a PXCache Object
Cache Mapping
Session
Session Sharing Between Application Servers
Storing of Graph Data in the Session
Use of Slots to Cache Data Objects
Implementing Business Logic
Working with Graph Extensions
Graph Extensions: General Information
Graph Extensions: Creating a Graph Extension Through the UI
Graph Extensions: Enabling a Graph Extension Conditionally (with IsActive)
Graph Extensions: SOShipmentEntry Extensions
Graph Extensions: POCreate, POOrderEntry, and POReceiptEntry Extensions
Working with Events
Event Handlers
Types of Graph Event Handlers
Execution of Event Handlers
Override of Event Handlers
Data Manipulation Scenarios
Insertion of a Data Record
Update of a Data Record
Removal of a Data Record
Saving of Changes to the Database
Sequence of Events: Insertion of a Data Record
Sequence of Events: Update of a Data Record
Sequence of Events: Deletion of a Data Record
Sequence of Events: Display of a Data Record
To Fetch Calculated Data from a Non-Scalar Source (in RowSelecting)
Sequence of Events: Saving of Changes to the Database
List of Events
Cancellation of Attribute Event Handlers
Validating Data
Data Validation: General Information
Data Validation: Validation of Field Values
Data Validation: Validation of a Data Record
Data Validation: Identifying Error-Causing Records with DAC Descriptors
Update of a Data Record on Update of a Field Value
Examples of Adding or Altering Graph Event Handlers
Working with Exceptions
Creating a Custom Exception
Working with Attributes
Code Reuse Through Attributes
Mandatory Attributes
Use of Attributes
Bound Field Data Types
Unbound Field Data Types
UI Field Configuration
Default Values
Complex Input Controls
Referential Integrity
Calculation of Field Values
Ad Hoc SQL for Fields
Aggregation of Attributes
Audit Fields
Data Projection
Access Control
Notes
Report Optimization
Attributes on DACs
Attributes on Data Views
Custom Attributes
Access to Protected Graph Members
Replacing Attributes for DAC Fields in CacheAttached
CacheAttached: General Information
CacheAttached: To Replace Field Attributes in CacheAttached
Defining the External and Internal Presentation of Field Values
External and Internal Presentation of Field Values: General Information
Working with Attachments
To Allow Attachments to a Particular Form
To Display an Attached Image on the Form
Configuring the UI from the Backend
Data for Controls
Configuration of the User Interface in Code
Configuration of Parameters in Code for the Customization Project Editor
Standard Buttons of the Form Toolbar
Requests for User Confirmation
Determination of Whether an Action Was Initiated in the UI
Company/Branch Box
To Configure an Input Mask and a Display Mask for a Field
To Display a Dialog Box
Defining Actions
Action Definition: General Information
Action Definition: To Define an Action for a Form
Action Definition: To Define an Action for a Table
Customizing Actions
Action Customization: General Information
Action Customization: Customization of an Action
Action Customization: Overriding of an Action Delegate Method
Action Customization: Changing of the Display Name of an Action
Action Customization: Disabling or Enabling of an Action
Action Customization: Visibility of an Action
Action Customization: Connotation for an Action
Action Customization: Action Attributes
Implementing an Asynchronous Operation
Asynchronous Operations: General Information
Asynchronous Operations: To Implement an Asynchronous Operation
Asynchronous Operations: Use of the Custom Information Dictionary
Asynchronous Operations: How They are Handled in Acumatica ERP
Implementing Processing Operations
Processing Operations: General Information
Processing Operations: Specifying a Workflow Action
Processing Operations: Specifying a Processing Delegate
Processing Operations: To Implement a Processing Operation by Using the Workflow
Processing Operations: To Implement a Processing Operation by Using a Delegate
Overriding a Graph Method
Override of a Method: General Information
Override of a Method: Overriding a Method Through the UI
Override of a Method: Overriding the Persist Method
Override of a Method: Customizing the Release Process for CA Documents
Creating Setup Forms
Configuration Parameters of the Application (Setup Forms)
Filtering Records Dynamically with Data View Delegates
Data View Delegates: General Information
Data View Delegates: Customization of a Data View
Data View Delegates: To Add a Filtering Query Dynamically
Aggregating Data
Data Aggregation: General Information
Data Aggregation: To Retrieve Aggregated Data
Displaying Data from Multiple DACs by Using PXProjection
Use of PXProjection: General Information
Use of PXProjection: Additional Configuration of the PXProjection Attribute
Use of PXProjection: Overriding a Projection of an Existing DAC
Use of PXProjection: To Display Multiple DAC Data on a Tab
Redirecting the User to Webpages
Redirection to Webpages: General Information
Redirection to Webpages: To Add Redirection Links to the Grid by Using the PXSelector Attribute
Redirection to Webpages: To Add Redirection Links to a Grid by Using an Action
Redirection to Webpages: To Add Redirection to a Report at the End of Processing
Updating Data with a Custom PXAccumulator Attribute
PXAccumulator: General Information
PXAccumulator: Implementation of a Custom PXAccumulator Attribute
PXAccumulator: Implementation of an Update with Restrictions
PXAccumulator: Insertion of Values Updated by an Accumulator Attribute
PXAccumulator: Customization of an Existing Accumulator Attribute
PXAccumulator: To Implement a Custom Accumulator Attribute
PXAccumulator: To Modify the Processing Form to Use the Field Updated by PXAccumulator
PXAccumulator: How an Accumulator Attribute Works
Customizing the Acumatica ERP Search
Search Customization: General Information
Search Customization: To Display a DAC in Universal Search Results
Search Customization: How the Search in DACs Works
Search Customization: Fields from Foreign DACs in the Search Index and Search Results
Reusing Business Logic with Dependency Injection
Dependency Injection: General Information
Dependency Injection: Service Definition
Dependency Injection: Service Registration
Dependency Injection: Use of Dependency Injection
Reusing Business Logic with Generic Graph Extensions
Generic Graph Extensions: General Information
Generic Graph Extensions: How Generic Graph Extensions Work
Generic Graph Extensions: Classes Declared in Acumatica ERP
To Insert Reusable Business Logic That Has Already Been Declared
To Sort Multiple Generic Graph Extensions
To Implement Reusable Business Logic
Troubleshooting Acumatica Framework-Based Applications
To Debug Acumatica Framework-Based Applications
Glossary

Back to home page