Skip to main content
Version: 20 R5 BETA

Architecture of a project

A 4D project is made of several folders and files, stored within a project root folder (package folder). For example:

  • MyPackage (project root folder)
    • Components
    • Data
      • Logs
      • Settings
    • Documentation
    • Plugins
    • Project
      • DerivedData
      • Sources
      • Trash
    • Resources
    • Settings
    • userPreferences.jSmith
    • WebFolder

If your project has been converted from a binary database, additional folders may be present. See "Converting databases to projects" on doc.4d.com.

Project folder

The Project folder typically contains the following hierarchy:

  • <applicationName>.4DProject file
  • Sources
    • Classes
    • DatabaseMethods
    • Methods
    • Forms
    • TableForms
    • Triggers
  • DerivedData
  • Trash (if any)

<applicationName>.4DProject file

Project development file, used to designate and launch the project. This file can be opened by:

In 4D projects, development is done with 4D and multi-user development is managed through source control tools. 4D Server can open .4DProject files for testing purposes.

This text file can also contain configuration keys, in particular "tokenizedText": false.

Sources

ContentsDescriptionFormat
catalog.4DCatalogTable and field definitionsXML
catalog_editor.jsonCustom positions and colors of tables, fields, and links in the Structure editor. Depends on a Compatibility setting in converted projectsJSON
folders.jsonExplorer folder definitionsJSON
menus.jsonMenu definitionsJSON
settings.4DSettingsStructure database settings. They are not taken into account if user settings or user settings for data are defined (see also Priority of settings. Warning: In compiled applications, structure settings are stored in the .4dz file (read-only). For deployment needs, it is necessary to enable and use user settings or user settings for data to define custom settings.XML
tips.jsonDefined tipsJSON
lists.jsonDefined listsJSON
filters.jsonDefined filtersJSON
dependencies.jsonNames of components to load in the projectJSON
styleSheets.cssCSS style sheetsCSS
styleSheets_mac.cssMac css style sheets (from converted binary database)CSS
styleSheets_windows.cssWindows css style sheets (from converted binary database)CSS

DatabaseMethods

ContentsDescriptionFormat
databaseMethodName.4dmDatabase methods defined in the project. One file per database methodtext

Methods

ContentsDescriptionFormat
methodName.4dmProject methods defined in the project. One file per methodtext

Classes

ContentsDescriptionFormat
className.4dmUser class definition method, allowing to instantiate specific objects. One file per class, the name of the file is the class nametext

Forms

ContentsDescriptionFormat
formName/form.4DFormProject form descriptionjson
formName/method.4dmProject form methodtext
formName/Images/pictureNameProject form static picturepicture
formName/ObjectMethods/objectName.4dmObject methods. One file per object methodtext

TableForms

ContentsDescriptionFormat
n/Input/formName/form.4DFormInput table form description (n is the table number)json
n/Input/formName/Images/pictureNameInput table form static picturespicture
n/Input/formName/method.4dmInput table form methodtext
n/Input/formName/ObjectMethods/objectName.4dmInput form object methods. One file per object methodtext
n/Output/formName/form.4DFormOutput table form description (n is the table number)json
n/Output/formName/Images/pictureNameOutput table form static picturespicture
n/Output/formName/method.4dmOutput table form methodtext
n/Output/formName/ObjectMethods/objectName.4dmOutput form object methods. One file per object methodtext

Triggers

ContentsDescriptionFormat
table_n.4dmTrigger methods defined in the project. One trigger file per table (n is the table number)text

Note: The .4dm file extension is a text-based file format, containing the code of a 4D method. It is compliant with source control tools.

Trash

The Trash folder contains methods and forms that were deleted from the project (if any). It can contain the following folders:

  • Methods
  • Forms
  • TableForms

Within these folders, deleted element names are in parentheses, e.g. "(myMethod).4dm". The folder organization is identical to the Sources folder.

DerivedData

The DerivedData folder contains cached data used internally by 4D to optimize processing. It is automatically created or recreated when necessary. You can ignore this folder.

Libraries

This folder is used on macOS only.

The Librairies folder contains the file resulting from a compilation with the Silicon compiler on macOS.

Resources

The Resources folder contains any custom project resource files and folders. In this folder, you can place all the files needed for the translation or customization of the application interface (picture files, text files, XLIFF files, etc.). 4D uses automatic mechanisms to work with the contents of this folder, in particular for the handling of XLIFF files and static pictures. For using in remote mode, the Resources folder lets you share files between the server machine and all the client machines. See the 4D Server Reference Manual.

ContentsDescriptionFormat
itemProject resource files and foldersvarious
Images/Library/itemPictures from the Picture Library as separate files(*). Names of these items become file names. If a duplicate exists, a number is added to the name.picture

(*) only if the project was exported from a .4db binary database.

Data

The data folder contains the data file and all files and folders relating to the data.

ContentsDescriptionFormat
data.4dd(*)Data file containing data entered in the records and all the data belonging to the records. When you open a 4D project, the application opens the current data file by default. If you change the name or location of this file, the Open data file dialog box will then appear so that you can select the data file to use or create a new onebinary
data.journalCreated only when the database uses a log file. The log file is used to ensure the security of the data between backups. All operations carried out on the data are recorded sequentially in this file. Therefore, each operation on the data causes two simultaneous actions: the first on the data (the statement is executed normally) and the second in the log file (a description of the operation is recorded). The log file is constructed independently, without disturbing or slowing down the user’s work. A database can only work with a single log file at a time. The log file records operations such as additions, modifications or deletions of records, transactions, etc. It is generated by default when a database is created.binary
data.match(internal) UUID matching table numberXML

(*) When the project is created from a .4db binary database, the data file is left untouched. Thus, it can be named differently and placed in another location.

Settings (user data)

This folder contains user settings for data used for application administration.

These settings take priority over user settings and structure settings. See also Priority of settings.

ContentsDescriptionFormat
directory.jsonDescription of 4D groups, users, and their access rights when the application is run with this data file.JSON
Backup.4DSettingsDatabase backup settings, used to set the backup options when the database is run with this data file. Keys concerning backup configuration are described in the 4D XML Keys Backup manual.XML
settings.4DSettingsCustom database settings for this data file.XML

Logs

The Logs folder contains all log files used by the project. Log files include, in particular:

  • database conversion,
  • web server requests,
  • backup/restore activities journal (Backup Journal[xxx].txt, see Backup journal)
  • command debugging,
  • 4D Server requests (generated on client machines and on the server).

An additional Logs folder is available in the system user preferences folder (active 4D folder, see Get 4D folder command) for maintenance log files and in cases where data folder is read-only.

Settings (user)

This folder contains user settings used for application administration.

These settings take priority over structure settings file. However, if user settings for data exist, they take priority over the user settings. See also Priority of settings.

ContentsDescriptionFormat
directory.jsonDescription of 4D groups and users for the application, as well as their access rightsJSON
Backup.4DSettingsDatabase backup settings, used to set the backup options) when each backup is launched. This file can also be used to read or set additional options, such as the amount of information stored in the backup journal. Keys concerning backup configuration are described in the 4D XML Keys Backup manual.XML
BuildApp.4DSettingsBuild settings file, created automatically when using the application builder dialog box or the BUILD APPLICATION commandXML
settings.4DSettingsCustom settings for this project (all data files)XML
logConfig.jsonCustom log configuration filejson

userPreferences.<userName>

This folder contains files that memorize user configurations, e.g. break point or window positions. You can just ignore this folder. It contains for example:

ContentsDescriptionFormat
methodPreferences.jsonCurrent user Code Editor preferencesJSON
methodWindowPositions.jsonCurrent user window positions for methodsJSON
formWindowPositions.jsonCurrent user window positions for formsJSON
workspace.jsonList of opened windows; on macOS, order of tab windowsJSON
debuggerCatches.jsonCaught calls to commandsJSON
recentTables.jsonOrdered list of tablesJSON
preferences.4DPreferencesCurrent data path and main window positionsXML
CompilerIntermediateFilesIntermediate files resulting from Apple Silicon compilationFolder

Components

Folder containing components that are embedded in the project (must be stored at the same level as the Project folder). These components have priority over any other locations.

info

You can also use the dependencies.json and (optionnally) environment4d.json files to declare components.

Plugins

This folder contains the plug-ins to be available in the application project. It must be stored at the same level as the Project folder.

Documentation

This folder contains all documentation files (.md) created for the project elements such as classes, methods, or forms. Documentation files are managed and displayed in the 4D Explorer.

For more information, refer to Documenting a project.

WebFolder

Defaut root folder of the 4D Web server for pages, pictures, etc. It is automatically created when the Web server is launched for the first time.

.gitignore file (optional)

File that specifies which files will be ignored by git. You can include a gitignore file in your projects using the Create .gitignore file option on the General page of the preferences. To configure the contents of that file, see Create .gitignore file.