Skip to content

File Structure

Explained below is the recommended methods for structuring the projection, client, PLSVC, and fragment files for easy readability and code maintenance.

Projection File

The recommended method that you can structure the Projection file is by the grouping them according to different types of elements:


------------------------------ MAIN ENTRY POINTS ---------------------------------------  

- Entityset  

------------------------------ ENTITY DETAILS -----------------------------------  

- Entity  

------------------------------ ENUMERATIONS ----------------------------------  

- Enumeration  

------------------------------ QUERIES --------------------------------------------  

- Query  

------------------------------ ACTIONS --------------------------------------------  

- Action  

------------------------------ FUNCTIONS ----------------------------------------  

- Function  

------------------------------ STRUCTURES --------------------------------------  

- Structure  

------------------------------ VIRTUALS -------------------------------------------  

- Virtual  

------------------------------ SUMMARIES ---------------------------------------  

- Summary  

------------------------------ SINGLETONS ---------------------------------------  

- Singleton  




The order of these elements can be different according to the preference as well as the available elements.

## Client File

Similar to the projection file, client files should also be structured according to the different types of available controls:



``

----------------------------- NAVIGATOR ENTRIES --------------------------------

- Navigator
- Entry

----------------------------- MAIN PAGES -----------------------------------------

- Page

----------------------------- ASSISTANTS ------------------------------------------

- Assistant

----------------------------- COMMANDS -----------------------------------------

- Command

----------------------------- SELECTORS -------------------------------------------

- Selector
- Singleton

----------------------------- GROUPS -----------------------------------------------

- Group

----------------------------- LISTS ---------------------------------------------------

- List

----------------------------- CARDS -------------------------------------------------

- Card

----------------------------- DIALOGS ----------------------------------------------

- Dialog

----------------------------- CHARTS -----------------------------------------------

- Bar chart
- Box matrix
- Diagram
- Line chart
- Pie Chart
- Radar Chart
- Stacked Chart

----------------------------- CALENDARS ------------------------------------------

- Calendar
- Stacked Calendar
- Timeline
- Yearview

----------------------------- SHEETS ------------------------------------------------

- Sheet

----------------------------- STATE INDICATORS -----------------------------------

- State Indicator

----------------------------- TREES --------------------------------------------------

- Tree

----------------------------- PLUGINS -----------------------------------------------

- Plugin

----------------------------- IMAGE VIEWERS ---------------------------------------

- Imageviewer



## PLSVC File

The PLSVC file structure is similar to the one used in a normal [plsql](../../../../027_base_server_dev/007_concepts/090_source_code_file/plsql_files.md) file.

## Fragment File

Since fragment files can contain both projection elements and client controls, it is recommended to use the same structure as above after dividing the entire file into two different sections for projection and client controls:


----------------------------- CLIENT FRAGMENTS ---------------------------------

----------------------------- PROJECTION FRAGMENTS ---------------------------

```