To Add a Custom Data Field
You can add a custom data field to an existing data access class by using the Screen Editor or Data Class, as described in the following sections:
Both of the editors opens the Create New Field Dialog Box dialog box, which you use to enter the parameters of the new field and to launch the New Field wizard, which includes an XML declaration of the new field in the DAC item for the modified data access class. If the DAC item for the modified data access class is absent in the customization project, the wizard creates the appropriate item. Also, the wizard creates a Table item with a description of the custom column added to the table for the custom field.
You can select the way a custom field will be stored in the database when you add the field to a data access class. You can add a custom field as one of the following:
- Without mapping to the database
- As a new column to the database table by altering the table schema
- As a name-value pair to a dedicated table without altering the table schema
The detailed information is described in the following sections:
- To Add a Custom Field Without Mapping to the Database
- To Add a Custom Field as a New Column
- To Add a Custom Field as a Name-Value Pair
- To Delete a Custom Field
To be able to create a control for the new field to be displayed on a form, you have to publish the project to make the system create the column in the database table and compile the customization code. After the publication, you can add the control for the new field to a form by using the Screen Editor. See To Add a Box for a Data Field or To Add a Column for a Data Field for details.
By Using the Data Class Editor
You generally use the Data Class to add a custom field to a data access class (DAC) and store the changes in the customization project as a DAC item. To do this, perform the following actions:
- Start customization of the data access class, as described in To Start the Customization of a Data Access Class.
- On the toolbar of the Data Class page, click Create New Field.
- In the New Field dialog box, which opens, specify the custom field parameters that are described in Create New Field Dialog Box.
- Click OK to save changes in the customization project.
By Using the Screen Editor
If you customize a form by using the Screen Editor, you may need to create a custom data field to be used to create a new control on the form. By using the editor, you can create a new field in the main DAC of the data view that provides data for the object selected in the Control Tree. To do this, perform the following actions:
- In the Control Tree of the Screen Editor, select the node of a container to which you intend to add a new control, or a subnode within the container node.
- Click the Add Data Fields tab item.
- On the table toolbar of the tab item, click New Field.
- In the Create New Field dialog box, which opens, specify the custom field parameters, which are described in Create New Field Dialog Box.
- Click OK to save your changes to the customization project.
To Add a Custom Field Without Mapping to the Database
To add a custom field without mapping to the database, perform the following actions:
- Open the Create New Field dialog box for the data access class By Using the Data Class Editor or By Using the Screen Editor.
- In the dialog box, specify the custom field parameters and select NonPersistedField in Storage Type.
- Click OK to add the field to the data access class.
The New Field wizard includes an XML declaration of the new field in the DAC item
for the modified data access class. The new field declaration contains the data type
attribute that specifies an unbound field, such as [PXString]
.
To Add a Custom Field as a New Column
- Open the Create New Field dialog box for the data access class by using the Data Class Editor or by using the Screen Editor.
- In the dialog box, specify the custom field parameters and select DBTableColumn in the Storage Type box to make the system append the column to the original table in the database.
- Click OK to add the field to the data access class.
To Add a Custom Field as a Name-Value Pair
To add a custom field a name-value pairs stored in a dedicated table of MYOB Acumatica, perform the following actions:
- Open the Create New Field dialog box for the data access class By Using the Data Class Editor or By Using the Screen Editor.
- In the dialog box, specify the custom field parameters and select NameValuePair in Storage Type.
- Click OK to add the field to the data access class.
The New Field wizard includes an XML declaration of the new field in the DAC item for the modified data access class. If the DAC item for the modified data access class is absent in the customization project, the wizard creates the appropriate item. The wizard doesn't generate any definitions to change the database schema.
To Delete a Custom Field
To delete a custom field or custom attributes on a field from the data access class, open the data access class in the Data Class Editor and delete the custom field from the field list. If you work in Microsoft Visual Studio, publish the customization project to update the file with the customized data access class in the file system. After the project has been published, the customization will be removed from the data access class.