User Interface

Overview

Sugar's user interface is dependent on the client (i.e. base, mobile, or portal) being used to access the system. Clients are the various platforms that use Sugar's APIs to render the user interface. Each platform type will have a specific path for its components. While the Developer Guide mainly covers the base client type, the following sections will outline the various metadata locations.

Clients

Clients are the various platforms that access and use Sidecar to render content. Depending on the platform you are using, the layout, view, and metadata will be driven based on its client type. The following sections describe the client types.

base

The base client is the Sugar application that you use to access your data from a web browser. The framework's specific views, layouts, and fields are rendered using Sidecar.  Files specific to this client type can be found in the following directories:

• ./clients/base/
• ./custom/clients/base/
• ./modules/<module>/clients/base/
• ./custom/modules/<module>/clients/base/

mobile

The mobile client is the SugarCRM mobile application that you use to access data from your mobile device. The framework-specific views, layouts, and fields for this application are found in the following directories:

• ./clients/mobile/
• ./custom/clients/mobile/
• ./modules/<module>/clients/mobile/
• ./custom/modules/<module>/clients/mobile/

portal

The portal client is the customer self-service portal application that comes with Sugar Enterprise and Sugar Ultimate. The framework-specific views, layouts, and fields for this application are found in the following directories:

• ./clients/portal/
• ./custom/clients/portal/
• ./modules/<module>/clients/portal/
• ./custom/modules/<module>/clients/portal/