Customization Guide

version: 2026 R2

Customization Guide
Introduction
Getting Started
Knowledge Prerequisites
To Prepare an Environment
To Assign the Customizer Role to a User Account
User Access Rights for Customization
Exploring the Source Code
To Explore the C# Code of a BLC
To Explore the C# Code of a DAC
To Explore the ASPX Code of a Form (Classic UI)
To Explore the HTML Code of a Form (Modern UI)
To Explore the TypeScript Code of a Form (Modern UI)
To Find a Customization of the ASPX Code
To Find Source Code by a Fragment
To Develop a Customization Project
To Perform Final Testing of a Customization
To Deploy a Customization Project
Asking Questions
Acumatica Customization Platform
Customization Project
Types of Items in a Customization Project
Deployment of a Customization Result
Publication of Customization Projects in a Multitenant Site
Customization Tools
Customization Framework
Changes in Webpages (ASPX)
Changes in the Application Code (C#)
DAC Extensions
Access to a Custom Field
From a Method
From a BQL Statement
From a Field Attribute
Customization of Field Attributes in DAC Extensions
Supported DAC Extension Formats
Graph Extensions
Event Handlers
Customization of an Action
Overriding Attributes of a DAC Field in the Graph
Run-Time Compilation
Extension Library
Extension Library (DLL) Versus Code in a Customization Project
Changes in the Database Schema
Custom Processes During Publication of a Customization
Managing Customization Projects
Getting Started with Customization Projects
Customization Projects: General Information
Customization Projects: To Deploy an Instance
Customization Projects: To Create a Customization Project
To Open a Project
To Update a Project
To Delete a Project
To Export a Project
To Replace the Content of a Project from a Package
To Merge Multiple Projects
To Add a Custom Feature Switch
Custom Feature Switches
The Features.xml File
Managing Customization Projects by Using the Web API
Customization Web API: General Information
Customization Web API: delete
Customization Web API: getPublished
Customization Web API: getProject
Customization Web API: import
Customization Web API: publishBegin
Customization Web API: publishEnd
Customization Web API: unpublishAll
Managing Customization Projects by Using the PXCommandLine Tool
PXCommandLine Tool: General Information
PXCommandLine Tool: ValidateExtensions
PXCommandLine Tool: UploadCustomization
PXCommandLine Tool: ValidateCustomization
PXCommandLine Tool: RemoveCustomization
PXCommandLine Tool: PublishCustomization
PXCommandLine Tool: BuildProject
PXCommandLine Tool: DeleteProject
PXCommandLine Tool: MergePackages
PXCommandLine Tool: ExportSnapshot
PXCommandLine Tool: RunUpdatePlugins
PXCommandLine Tool: UpdatePages
Publishing Customization Projects
To Prepare a Project for Publication
To Publish a Single Project
To Publish the Current Project
To View a Published Customization
Publishing Customization Projects
Project Publication: General Information
Project Publication: To Deploy a Customization Project
Project Publication: To Publish Two Customization Projects
Publishing with the Cleanup Operation
Publication with Cleanup: General Information
Customizing a Multitenant Instance
Multitenant Customization: General Information
Unpublishing Customization Projects
Project Unpublishing: General Information
Project Unpublishing: To Unpublish a Single Project
Project Unpublishing: To Unpublish All Projects
Managing Items in a Project
Adding Customization Items to Customization Projects
Customization Items: General Information
Customization Items: To Add Items to the Customization Project
Customization Items: To Update an Item in the Customization Project
Customized Screens
To Add a Page Item for an Existing Form
To Delete a Page Item from a Project
To Add a New Custom Form to a Project
To Delete a Custom Form from a Project
To Delete Items from the Project on the Edit Project Items Page
Customized Data Classes
To Add a DAC Item for an Existing Data Access Class to a Project
To Delete a DAC Item from a Project
To Convert a DAC Item to a Code Item
To Move a DAC Item to an Extension Library
Code
To Create a Custom Business Logic Controller
To Create a Custom Data Access Class
To Customize an Existing Graph
To Customize an Existing Data Access Class
To Add Custom Code to a Project
To Add a Customization Plug-In to a Project
To Delete a Code Item From a Project
To Move a Code Item to the Extension Library
Custom Files
To Add a Custom File to a Project
To Update a File Item in a Project
Detecting the Project Items Modified in the File System
To Delete a Custom File From a Project
Generic Inquiries
Custom Reports
To Add a Custom Report to a Project
To Delete a Custom Report from a Project
To Navigate a Custom Report in a Project
Dashboards
Site Map
Database Scripts
Best Practices
To Add a Custom Table to a Project
To Update Custom Tables in the Project
To Add a Custom Column to an Existing Table
To Increase the Size of a Column in an Existing Table
To Add a Custom SQL Script to a Project
Creating a Custom SQL Script
Using the SQL Script Attributes
Writing Custom SQL Scripts for Interpretation
To Edit a Custom SQL Script
To Delete an Sql or Table Item From a Project
System Locales
To Add a System Locale to a Project
To Delete a System Locale from a Project
To Update a Custom System Locale in a Project
To Navigate to the System Locales Form
Import and Export Scenarios
To Add an Integration Scenario to a Project
To Delete an Integration Scenario from a Project
To Update an Integration Scenario in a Project
To Navigate to the Import Scenarios Form
Shared Filters
To Add a Shared Filter to a Project
To Delete a Shared Filter from a Project
To Update a Shared Filter in a Project
To Navigate to the Filters Form
Access Rights
To Add Access Rights to a Project
To Delete Access Rights from a Project
To Update Access Rights in a Project
To Navigate to the Access Rights by Screen Form
Wikis
To Add a Custom Wiki to a Project
To Delete a Custom Wiki from a Project
To Update a Custom Wiki in a Project
To Navigate to the Wiki Form
Web Service Endpoints
Analytical Reports
To Add a Custom Analytical Report to a Project
To Delete a Custom Analytical Report from a Project
To Update a Custom Analytical Report in a Project
To Navigate to the Report Definitions Form
Push Notifications
Business Events
To Add Business Events to a Project
To Delete Business Events from a Project
To Update Business Events in a Project
To Navigate to the Business Events Form
Mobile Application
To Add a Form To Mobile Site Map
To Update Main Menu of a Mobile App
To Manage the Workspaces of the Mobile App
To Update a Mobile App Screen
To Remove a Screen of a Mobile App
To Reverse Changes Made to Mobile App
User-Defined Fields
To Add a User-Defined Field to a Customization Project
Webhooks
Connected Applications
Customizing Elements of the User Interface
Existing Form
To Start a Customization of a Form
To Delete a Customization of a Form
To Add a Form Container
To Add a Grid Container
To Add a Tab Container
To Add a New Tab Item to a Tab
To Add a Dialog Box
To Delete a Container
Form Container (PXFormView)
To Open a Container in the Screen Editor
To Set a Container Property
To Add a Nested Container
To Add a Box for a Data Field
To Add a Layout Rule
To Add Another Supported Control
To Reorder Child UI Elements
To Delete a Child UI Element
Grid Container (PXGrid)
To Add a Column for a Data Field
To Add a Control to the Form View of a Grid
To Provide Hyperlinks for a Grid Column
Tab Container (PXTab)
Tab Item Container (PXTabItem)
Dialog Box (PXSmartPanel)
To Open a Smart Panel in the Screen Editor
Box (Control for a Data Field)
To Select a Box in the Screen Editor
To Set a Box Property
To Change the Type of a Box
Layout Rule (PXLayoutRule)
To Select a Layout Rule in the Screen Editor
To Set a Layout Rule Property
Panel (PXPanel)
Group Box (PXGroupBox)
To Open a Group Box in the Screen Editor
To Create a Group Box for a Drop-Down Field
To Set a Group Box Property
Label (PXLabel)
Radio Button (PXRadioButton)
To Bind a Radio Button to a Value in the List of a Data Field
Button (PXButton)
To Use a Button in a Dialog Box
To Use a Button to Invoke a Method
Java Script (PXJavaScript)
Toolbars, Action Buttons, and Menus
Other Control Types
Configuring the Layout of Forms
Form Layout: General Information
Form Layout: User and System-Wide Configuration
Form Layout: To Personalize a View of a Form
Form Layout: To Make System-Wide Form Configuration
Form Layout: To Add a Box to a Form
Form Layout: To Add a Section to a Tab
Form Layout: To Add a New Tab to a Form
Form Layout: To Add a Column to a Lookup Table
Defining Conditional Properties
Conditional Properties: General Information
Conditional Properties: To Disable an Action
Conditional Properties: To Require an Element
Conditional Properties: To Hide an Element
Adding User-Defined Fields to Customization Projects
User-Defined Fields in Customization Projects: General Information
User-Defined Fields in Customization Projects: Process Activity
Customizing Business Logic
Data Access Class
To Start the Customization of a Data Access Class
Use of Entity Attributes Instead of Custom Fields
To Add a Custom Data Field
To Create a New DAC
To Create a DAC Extension
To Enable a DAC Extension Conditionally (IsActive)
Data Field
To Customize a Field on the DAC Level
To Customize a Field on the Graph Level
To Set a Default Value
To Change the Label of a Field
To Make a Field Mandatory
To Customize the Table of a Selector Field
To Provide Multilanguage Support for a Field
Graph
To Create a Custom Graph
To Add a New Member
To Add an Action
Data View
To Override a Data View
To Override a Data View Delegate
Adding Actions to Forms
Actions on Forms: General Information
Actions on Forms: To Add an Action to Open a Form
Actions on Forms: To Add an Action to Run a Report
Actions on Forms: To Add a Side Panel
Workflow
Customizing the Database Schema
To Create a Custom Table
To Create a Custom Column in an Existing Table
To Create an Extension Table
Requirements for an Extension Table Schema
DAC Extension Mapped to an Extension Table
To Add a Custom SQL Script to a Customization Project
Integrating the Project Editor with Microsoft Visual Studio
To Work with a Code Item
To Work with Data Access Classes
To Debug the Customization Code
To View and Debug Acumatica ERP Source Code
To Synchronize Code Changes with the Customization Project
To Create an Extension Library
Useful Tips
Integrating the Project Editor with a Version Control System
To Save a Project to a Local Folder
To Update the Content of a Project from a Local Folder
To Integrate the Customization Project Editor with Source Control
Troubleshooting Customization
To Discover the Method That Has Thrown an Exception
To Write to the Trace Log from the Code
To Log All Exceptions to a File
To Debug the Customization Code
To Validate a BQL Statement
To Measure the Execution Time of a BQL Statement
To Discover the Cause of Performance Degradation
To Force the Platform to Execute Database Scripts
Examples
Examples of User Interface Customization
Dragging, Moving, and Deleting UI Controls and Grid Columns
Adding Input Controls
Adding Advanced Controls
Adding Columns to a Grid
Modifying Columns in a Selector
Examples of Functional Customization
Adding Data Fields
Customizing DAC Attributes
Modifying a BLC Action
Modifying a BLC Data View
Declaring or Altering a BLC Data View Delegate
Extending BLC Initialization
Altering the BLC of a Processing Form
Putting a Sales Order on Credit Hold Status Programmatically
Implementing the XML Import and Export Functionality in a Custom Form
Defining a Workflow
Extending the Existing Workflow Without Coding from the Customization Project Editor
Defining a New Workflow
Customizing a Predefined Workflow from Code
Customizing a Predefined Workflow with the Workflow Visual Editor
Using a Composite State with the Workflow Editor
Customizing a Composite State From Code
Use Cases
Calculating Field Values (with PXFormula)
Adding a Field from Another DAC
Generating an Excel from Code
Glossary

Back to home page