Configuring the Mobile Site Map

You develop the code that creates or changes the mobile site map in the memory of the MYOB Acumatica server by using Mobile Site Map Definition Language (MSDL).

Note: Before MYOB Acumatica Framework 2021 R2, XML was used to configure the mobile site map.

MSDL Overview

MSDL provides the capability to configure the user interface of the MYOB mobile app. It transcends XML in terms of its flexibility of usage for the mobile site map, because you can apply MSDL code multiple times for any MYOB Acumatica form, whether it is a custom, customized, or original form. In contrast with XML, MYOB Acumatica Mobile Framework can successively apply MSDL code for a form from multiple customizations without problems or restrictions.

If you already have an XML site map in MSDL format, you should convert the XML mobile site map to MSDL format, as described in To Convert an XML Mobile Site Map to MSDL Format.

See the MSDL section of Mobile Site Map Reference for details about MSDL syntax, object types, and instructions.

User Interface Structure

You can modify the elements of the MYOB mobile app user interface by using MSDL. The user interface of the MYOB mobile app has the following structure:

  • Main Menu: You can customize the main menu by using instructions that work with the Folder and Screen objects.
  • Screens: You can customize the mobile app screens by using instructions that work with Container, Field, Action, and other objects.
Important: In previous versions of MYOB Acumatica, you could customize the sidebar menu by populating it with links ti favorite records and screens. As of MYOB Acumatica 2024.1, the sidebar menu has been deprecated. Customization projects that contain sidebar modification will no longer work. We recommend that you use the workspace functionality and add the required records and screens to Favorites. (For details, see Main Menu.)

How to Use the MSDL Examples of This Section

In this section, each example contains a list of MSDL instructions that modify the mobile site map for your instance of MYOB Acumatica.

To use the examples from this section, you should first add a new page (or modify an existing one) in the Customization Project Editor, and then insert the code in the Commands area. You can see your changes after you publish the customization project. For details, see the topics of the Mobile Site Map chapter.