Customization Projects

Form ID: (SM204505)

You use this form to do any of the following:

  • Add a new customization project, which is a set of changes and additional files that are used to modify the MYOB Acumatica application
  • Open a customization project for editing in the Customization Project Editor
  • Validate a customization project or multiple projects (see Validation of a Customization Project for details)
  • Publish a customization project (or multiple projects) for a tenant or multiple tenants
  • Cancel the publication of customization projects
  • View the XML of the published customization project
  • Export a customization project as the deployment package
  • Import a customization project from an existing deployment package
  • Delete a customization project

Form Toolbar

The form toolbar includes standard buttons and form-specific buttons and commands. For the list of standard buttons, see Form Toolbar and More Menu. The form-specific commands can be shown as buttons on the form toolbar, as commands on the More menu, or in both places. These commands are listed in the following table in alphabetical order.

Command Description
DAC Attributes (Runtime Validation)

Determines whether there are any PXAttributeFamilyAttribute violations on a DAC field. This validation is performed at runtime.

DAC Field Types (Runtime Validation)

Verifies that the data type of each DAC field matches the field states generated at runtime. This validation is performed at runtime.

Export

For the selected customization project, exports the deployment package of the customization project—that is, the ZIP file with the project. You first click the row with the project and then click this command. The file has the same name as the exported customization project.

You click a project and then click this command.

Import

Initiates the import of a previously exported deployment package from a ZIP file. When you click this button or command, the system opens the Open Package dialog box, which has the Choose File button and the Upload button to execute the operation.

Lookup Definitions (Runtime Validation)

Verifies that the DAC fields with lookup boxes defined for a segmented key properly handle foreign key segments by means of PXDimensionAttribute. This validation is performed at runtime.

Publish

Initiates the process of publishing the selected customization projects (that is, those for which you have selected the check box in the Included column). When you click this command, the Compilation dialog box opens to display a log of information about the process.

If both the project validation and the compilation of the modified website are successful, the system displays the Publish button in the dialog box; you click this button to finalize the publishing and to update the website.

Publish to Multiple Tenants

Opens the Publish to Multiple Tenants dialog box, which is used to select the tenants to which the selected customization projects are published and to configure the publishing options. (You select the check box in the Included column for all projects to be published before clicking this command.) After publication is complete, the selected tenants share the customization data that is specific to the opened tenant and stored exclusively in the database.

See Customization Projects: Publication to a Multitenant Website or Publication of Customization Projects in a Multitenant Site for details.

Replace Highlighted Project Content

Initiates the import of a previously exported deployment package from a ZIP file to replace the content of the customization project that is currently selected in the table. This command opens the Open Package dialog box, which has the Choose File button and the Upload button.

Screens with Custom Workflow

Opens the Screens with Custom Workflow dialog box, which lists the forms whose workflow has been modified.

Unpublish All

Removes the publication of all listed customization projects from the website. This command does not delete the projects themselves.

This command is always available, regardless of whether any customization projects have been published.

Validate Certification Status

Checks the certification status of all customization projects.

Validate Highlighted Project

Initiates the process of validating the selected customization project. You first click the row with the project and then click this command.

The command opens the Validation Results dialog box, which displays a log of information about the process.

Validate Multiple Projects

Opens the Choose Projects dialog box, which is used to select the customization projects for validation.

View Published XML

Displays the Published Customization page, which displays the merged content of the customization projects that are currently published.

See Published Customization Page for details.

Publish to Multiple Tenants Dialog Box

By using this dialog box, you can publish customization projects to multiple tenants at once.

Element Description

This dialog box includes a table with the following columns.

Selected

A check box that indicates (if selected) that the system will publish the selected customization projects on the tenant.

Tenant Name

The tenant name that is used on the site map.

ID

The tenant identifier, which was generated automatically by the system when the tenant was created.

Parent ID

The identifier of the parent tenant that was used to create the tenant in the MYOB Acumatica ERP Configuration Wizard.

This dialog box has the following elements below the table.
Apply Changes Only to Database (Skip Website Update)

A check box that indicates (if selected) that the system applies to the selected tenants only the database changes introduced by the selected customization packages.

If you have published all the selected customization projects in the website for a tenant, you do not need to update website files while publishing to the other tenants. You can apply only the database changes.

For details, see Customization Projects: Publication to a Multitenant Website.

Execute All Database Scripts (Including Previously Executed)

A check box that indicates (if selected) that the system cleans all the information about previously executed scripts of the customization project and executes them once more while publishing the selected projects.

If you have published all the selected customization projects in the website for a tenant, you do not need to run the executed scripts once again while publishing the projects to the other tenants. The system will run only any scripts that were not executed earlier.

For details, see Customization Projects: General Information.

This dialog box has the following buttons.
OK

Closes the dialog box and initiates the process of publishing the selected projects to each tenant selected in the table of the dialog box. As a result, the published customization content is saved in the database for each selected tenant.

Cancel

Closes the dialog box without any changes.

Screens with Custom Workflow Dialog Box

In this dialog box, which opens when you click Screens with Custom Workflow on the More menu, you can view the list of forms with modified workflows for all published customization projects, without the need to open the Customization Project Editor and investigate each customized screen.

Tip: The dialog box lists only the forms whose workflow has been modified by using Workflow UI.

The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Element Description

The dialog box includes a table with the following columns.

Screen ID

The ID of the form for which a custom workflow has been created, or whose workflow has been customized.

Screen Name

The name of the form for which a custom workflow has been created, or whose workflow has been customized.

This dialog box has the following button.

Close

Closes the dialog box.

Choose Projects Dialog Box

You use this dialog box, which opens when you click Validate Multiple Projects on the More menu, to select customization projects for validation.

The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Element Description

The dialog box includes a table with the following columns.

Included

An unlabeled check box that you select to include the customization project specified in the row in the validation process.

Published

A read-only check box that indicates that the customization project has been published.

Project Name

The name of the customization project.

Description

The description of the customization project.

This dialog box has the following button.

Validate

Starts the validation of the selected customization project or projects.

Validate and Show All Messages

Starts the validation of the selected customization project or projects and displays the results of the validation in the Validation Results dialog box.

Cancel

Closes the dialog box without running the validation.

Validation Results Dialog Box

The system displays this dialog box when you click a row with a customization project and then click Validate Highlighted Project on the More menu. The system also displays the dialog box when you click Validate and Show All Messages in the Choose Projects dialog box,

The dialog box contains a text area for viewing the results of validation for each customization project selected in the Choose Projects dialog box. The dialog box also contains the OK button, which you click to close it.

Table

This table lists all the customization projects that have been created for the instance of MYOB Acumatica. The columns of the table are described below.

Column Description
Included

An unlabeled check box that indicates (if selected) that the system will execute the selected command for the project in this row.

Published

A check box that indicates (if selected) that the project is published.

Project Name

The unique name of the project. The project name is also a link you can click to open the project in the Customization Project Editor, which is used to configure the project changeset for the website.

Level

A number representing the level that is used to resolve any conflicts that arise if multiple modifications of the same items of the website are merged.

If you leave this box empty, the default value is 0.

Tip: Use higher values for projects that contain more important changes.
Screen Names

A system-generated list of the identifiers of the screens that have been modified in the project.

Description

The description of the customization project, which may be a short explanation of the changes.

Certification Status

The certification status of each uploaded customization project. A customization project can have one of the following statuses:

  • Certified: The project has been imported into the MYOB Acumatica instance and is available in the database with the certified customization projects.
  • Not Certified: The project has been imported into the MYOB Acumatica instance and is not available in the database with the certified customization projects.
  • Not Verified: The project has been manually modified or created in the current MYOB Acumatica instance.
  • Not Certified for Current Version: The project has been imported into the MYOB Acumatica instance and is available in the database with the certified customization projects, but the major version it has been certified for is not the same as the major version of the current MYOB Acumatica instance.
Initials

The project prefixes assigned to the customization project provided by MYOB or ISV partners.

Created By

The name of the user who created the project.

Last Modified On

The date when the project was modified most recently.

Published Customization Page

The Published Customization page of the form shows the merged XML code of the customization projects that are currently published. You open this page by clicking View Published on the More menu.

On the Published Customization page, you can do the following:

  • View the code
  • Download the deployment package that contains the code
  • Upload the deployment package as a ZIP file

The Published Customization page includes a toolbar and a text area for viewing XML code. The text area displays the XML content of a merged customization project. This area is not used for editing the XML code.

The toolbar buttons are listed below.

Button Description
Save to Database

Is not used in the current version.

Download Package

Downloads the Customization.zip file, which has the full content of the merged customization project. You can use this file as a joint deployment package to work with the customization project or to publish the final customization on the target website.

Upload Package

Initiates the upload of a deployment package to MYOB Acumatica and makes XML code available in the text area for viewing.

Choose File

Opens the Open dialog box, in which you select the deployment package file to be uploaded.