### Redisson Configuration File Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/application/config.adoc

An example YAML file for configuring Redisson client settings.

```yaml
singleServerConfig:
  address: "redis://127.0.0.1:6379"
  idleConnectionTimeout: 10000
  connectTimeout: 10000
  timeout: 3000
  retryAttempts: 3
  retryInterval: 1500
threads: 16
nettyThreads: 32
codec: !<org.redisson.codec.SerializationCodec> {}
```

--------------------------------

### Install Project Dependencies

Source: https://github.com/axelor/axelor-open-platform/blob/main/axelor-front/README.md

Installs all necessary project dependencies using pnpm. This command should be run from the project's root directory.

```bash
pnpm install
```

--------------------------------

### Complete Grid View Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/views/grid.adoc

An example demonstrating a complete grid configuration, including toolbar buttons, menubar items, field definitions with conditional highlighting, and inline actions.

```xml
<grid name="contact-grid" title="Contacts" model="com.axelor.contact.db.Contact" editable="true">
  <toolbar>
    <button name="btnGreetAll" title="Greet" onClick="action.contact.greet.all"/>
  </toolbar>
  <menubar>
    <menu title="Actions">
      <item title="Action 1" action="action.some" />
      <item title="Action 2" action="action.thing" />
    </menu>
  </menubar>
  <hilite background="warning" if="$contains(email, 'gmeil.com')"/>
  <field name="fullName"/>
  <field name="firstName"/>
  <field name="lastName" onChange="com.axelor.contact.web.HelloController:guessEmail"/>
  <field name="email">
    <hilite strong="true" if="$contains(email, 'gmeil.com')"/>
  </field>
  <field name="phone"/>
  <field name="company"/>
  <field name="dateOfBirth">
    <hilite color="danger" strong="true" if="$moment().diff(dateOfBirth, 'years') &lt; 18"/>
  </field>
  <button name="btnGreet" title="Greet" onClick="action.contact.greet" />
</grid>
```

--------------------------------

### Install Node Version Manager and Node.js

Source: https://github.com/axelor/axelor-open-platform/blob/main/axelor-front/README.md

Installs Node Version Manager (nvm) and then uses it to install and use the Node.js version specified in the project's .nvmrc file.

```bash
#Nodejs

# Install Node Version Manager
$ curl -o- https://raw.githubusercontent.com/nvm/nvm/v0.39.7/install.sh | bash
$ source "$HOME/.nvm/nvm.sh"
# Install and use node version found in .nvmrc of the project
$ nvm install && nvm use
```

--------------------------------

### Start Development Server

Source: https://github.com/axelor/axelor-open-platform/blob/main/axelor-front/README.md

Starts the development server for the Axelor Front application. The application will typically be available at http://localhost:5173/.

```bash
pnpm dev
```

--------------------------------

### Example Axelor Configuration Properties

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/application/config.adoc

This snippet shows a complete example of the axelor-config.properties file, including default values for various settings.

```properties
include::{examplesdir}/axelor-config.properties[]
```

--------------------------------

### Global Context Configuration Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/application/config.adoc

Sets dynamic global context configuration values.

```properties
context.some.property = some_value
```

--------------------------------

### Axelor Application Startup Log

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/application/develop.adoc

This is an example log output indicating the application is ready and the URL where it is running.

```text
... 
Ready to serve... 

Running at http://localhost:8080/axelor-demo

```

--------------------------------

### Create Permission Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/modules/security.adoc

Grants create permission for all objects within the com.axelor.sale.db package.

```pseudocode
name: perm.sale.create.all
object: com.axelor.sale.db.*
canCreate: true
```

--------------------------------

### Example Job Implementation in Java

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/modules/scheduler.adoc

An example of a custom job class that implements the `org.quartz.Job` interface. It demonstrates how to access job details and data map parameters during execution.

```java
package com.axelor.contact.jobs;

import org.quartz.Job;
import org.quartz.JobDataMap;
import org.quartz.JobDetail;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

public class HelloJob implements Job {

  @Override
  public void execute(JobExecutionContext context) throws JobExecutionException {
    JobDetail detail = context.getJobDetail();
    JobDataMap data = context.getJobDetail().getJobDataMap();

    String name = detail.getKey().getName();
    String desc = detail.getDescription();

    System.err.println("Job fired: " + name + " (" + desc + ")");
    if (data != null && data.size() > 0) {
      for (String key : data.keySet()) {
        System.err.println("    " + key + " = " + data.getString(key));
      }
    }
  }
}
```

--------------------------------

### Start Embedded Server

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/application/cli.adoc

Starts the embedded Tomcat server using the 'run' command. Various options can be specified to configure the server.

```sh
  $ axelor run [OPTIONS]

```

--------------------------------

### Custom Mail Service Implementation Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/modules/messaging.adoc

Example of how to extend the default MailServiceImpl to customize email resolution and email finding logic.

```APIDOC
## Custom Mail Service Implementation

### Description
Provides an example of extending `MailServiceImpl` to customize email resolution and email finding.

### Example
```java
public class MyMailService extends MailServiceImpl {

  @Override
  public Model resolve(String email) {
    // Custom logic to find contact by email
    // If not found, find another contact (e.g., object)
    // If still not found, fall back to default implementation
    return super.resolve(email);
  }

  @Override
  public List<InternetAddress> findEmails(String matching, List<String> selected, int maxResults) {
    // Custom logic to search contacts matching the email pattern
    // Prepare and return the list of InternetAddress
    return super.findEmails(matching, selected, maxResults);
  }
}
```
```

--------------------------------

### Global Cache Configuration Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/application/config.adoc

Sets the global cache provider and configuration file path.

```properties
application.cache.provider = redisson
application.cache.config.path = redisson.yaml
```

--------------------------------

### Implement MetaFile Return for Logo/Icon

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/application/config.adoc

Example implementation of a service method returning a MetaFile for custom logos/icons, handling user and mode.

```java
public class AppService {

  public MetaFile getLogo(String mode) {
    return Optional.ofNullable(AuthUtils.getUser())
            .map(User::getActiveCompany)
            .map(company -> "dark".equals(mode) ? company.getDarkLogo() : company.getLogo())
            .orElse(null); // Returning null will show default application logo.
  }
}
```

--------------------------------

### Verify JDK Installation

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/getting-started/pages/install.adoc

Check if the Java Development Kit (JDK) is installed correctly by verifying its version from the console.

```sh
$ javac -version
```

--------------------------------

### Example Custom View with Template

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/views/custom.adoc

An example of a custom view used as a dashboard box, displaying total sales with a custom template that includes dynamic data and styling.

```xml
<!-- Dashboard box with custom template -->
<custom name="report.total.sale" title="Total sale" css="report-box">
  <dataset type="jpql">
  <![CDATA[
  select sum(self.totalAmount) as total from Order self
  ]]>
  </dataset>
  <template>
  <![CDATA[
  <>
    <Box d="flex" flexDirection="column" flex={1}>
        <h1>{first.total}</h1>
        <Box d="flex" flexDirection="row" justifyContent="space-between">
            <small>Total sale</small>
            <Box d="flex" alignItems="center" style={{fontWeight: "bold", color: "red"}}>
                20% <Icon icon="trending_down"/>
            </Box>
        </Box>
    </Box>
  </>
  ]]>
  </template>
</custom>
```

--------------------------------

### Example PostgreSQL pg_hba.conf Configuration

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/getting-started/pages/install.adoc

Illustrates a sample configuration for the pg_hba.conf file in PostgreSQL, showing different authentication methods for local and network connections.

```apache
# TYPE  DATABASE        USER            ADDRESS                 METHOD

# "local" is for Unix domain socket connections only
local   all             all                                     trust
# IPv4 local connections:
host    all             all             127.0.0.1/32            md5
# IPv6 local connections:
host    all             all             ::1/128                 md5
```

--------------------------------

### Workaround for Java Installation Path Warning

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/ROOT/pages/migrations/migration-7.1.adoc

If Gradle displays a warning about the Java installation path, create a symbolic link to the directory containing the 'java' executable as a workaround.

```sh
cd /usr/lib/jvm/openjdk-11
sudo ln -s ../java-11-openjdk-amd64/bin .
```

--------------------------------

### Configure Google Authentication Client

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/ROOT/pages/migrations/migration-6.0.adoc

Example of configuring the Google authentication client in axelor-config.properties using the new reflection-based syntax.

```properties
auth.provider.google.key = 127736102816-tc5mmsfaasa399jhqkfbv48nftoc55ft.apps.googleusercontent.com
auth.provider.google.secret = qySuozNl72zzM5SKW-0kczwV
```

--------------------------------

### Read Permission Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/modules/security.adoc

Grants read-only access to all objects within the com.axelor.sale.db package.

```pseudocode
name: perm.sale.read.all
object: com.axelor.sale.db.*
canRead: true
```

--------------------------------

### Action Service Response Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-services/advanced.adoc

This is an example of a typical response from the action service. The 'data' array contains the results of the executed actions.

```json
{
  "status": 0,
  "data": [
    { ... },
    { ... }
  ]
}
```

--------------------------------

### CSV Data Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/data-import/csv-import.adoc

This is an example of CSV data that can be imported. The columns are not automatically mapped to underlying objects and require manual configuration.

```csv
confirmed,date,firstName,lastName,email,p1,q1,r1,t11,t12,p2,q2,r2,t2
T,2011-12-11,John,Smith,j.smith@gmail.com,PC1,1,200.12,vat0.4,stx,PC2,4,230.23,vat0.4|stx
1,2011-12-12,John,Smith,j.smith@gmail.com,PC1,1,200.12,vat0.4,stx,PC2,4,230.23,vat0.6|stx
F,2011-12-13,John,Smith,j.smith@gmail.com,PC1,10,200.12,vat0.4,stx,PC2,3,230.23,vat0.4|stx
F,2011-12-14,John,Smith,,L1,5,20.12,vat0.4,stx,L2,3,20.23,vat0.4|vat0.6
```

--------------------------------

### String pattern validation examples

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/ROOT/pages/migrations/migration-7.2.adoc

Examples demonstrating case-sensitive string pattern validation using regex. Use '^' and '$' to match the entire value.

```regex
^Foo
```

```regex
^(F|f)oo
```

--------------------------------

### Set JAVA_HOME and PATH on Windows

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/getting-started/pages/install.adoc

Manually set environment variables for OpenJDK on Windows. The installer usually handles this, but manual configuration is possible.

```batch
$ set JAVA_HOME=\path\to\jdk
$ set PATH=%JAVA_HOME%\bin;%PATH%
```

--------------------------------

### Nginx Proxy Configuration Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/ROOT/pages/migrations/migration-6.1.adoc

Illustrates Nginx configuration for proxying requests, including handling redirects and setting up proxy pass for Axelor Open Platform.

```nginx
location = /my-app {
    return 302 /my-app/;
}

location /my-app/ {

    # Proxy support
    proxy_redirect          off;

```

--------------------------------

### Run Axelor Application

Source: https://github.com/axelor/axelor-open-platform/blob/main/axelor-gradle/src/main/resources/com/axelor/app/README.md

Starts the Axelor application. This is the default command for running the platform.

```shell
axelor run
```

--------------------------------

### Java Method for Preparing Context

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/data-import/csv-import.adoc

Example of a Java method used with the `prepare-context` attribute to set up global context before CSV row transformation.

```java
public class DemoImport {

    /**
     * This method is called with `prepare-context` attribute.
     * It prepares the global context before transforming the csv row.
     */
    public void prepareData(Map context) {

        Order order = new Order();
        order.setCreateDate(new LocalDate());
        order.setOrderDate(new LocalDate());

```

--------------------------------

### RefSelect Widget Setup

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/widgets.adoc

Defines the necessary fields and selection for the RefSelect widget to reference records of different types.

```xml
<entity ...>
  ...
  <string name="reference" /> <1>
  <integer name="referenceId" /> <2>
</entity>

<selection name="my.reference.select">
  <option value="com.axelor.sale.db.Order">SaleOrder</option> <1>
  <option value="com.axelor.contact.db.Contact"
    data-domain="self.email LIKE '%gmail%'"
    data-grid="my-custom-grid-view">Contact</option> <2>
</selection>

<form ...>
  ...
  <field name="reference" selection="my.reference.select" widget="RefSelect" />
</form>
```

--------------------------------

### Password Widget Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/widgets.adoc

Secures string fields for password input, masking characters and allowing visibility toggle.

```xml
<field name="password" widget="password" />
```

--------------------------------

### QrCode Widget Configuration

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/widgets.adoc

Display string data as a QR Code using the QrCode widget. This example sets a specific height for the QR code.

```xml
<field name="url" widget="QrCode" height="200" />
```

--------------------------------

### URL Widget Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/widgets.adoc

Validates string fields for URL values and provides an icon to open the URL in a new tab.

```xml
<field name="url" widget="url" />
```

--------------------------------

### Fetching Products with CSRF Token (JavaScript)

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-services/index.adoc

Example of how to fetch product data from a web service using jQuery, including handling the CSRF token for browser clients.

```javascript
  function getCookies() {
    return decodeURIComponent(document.cookie)
      .split('; ') 
      .reduce((acc, cur) => { const [k, v] = cur.split('='); return {...acc, [k]: v}; }, {});
  }

  const cookies = getCookies();

  $.ajax({
    url: 'ws/rest/com.axelor.sale.db.Product/search',
    type: 'POST',
    headers: { 'X-CSRF-Token': cookies['CSRF-TOKEN'] },
    data: JSON.stringify({
      fields: ['name'],
      sortBy: ['name'],
      limit: 20
    }),
    contentType: 'application/json'
  }).done(response => {
    const productNames = response.data.map(e => e.name);
    const productList = $('#product-list');
    productNames.forEach(name => {
      $(`<li>${name}</li>`).appendTo(productList);
    });
  });
```

--------------------------------

### Email Widget Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/widgets.adoc

Validates string fields for email addresses and provides an icon to open the default email client.

```xml
<field name="email" widget="email" />
```

--------------------------------

### Integer Widget Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/widgets.adoc

Represents integer data fields. Supports min, max, and step attributes for value constraints and increments.

```xml
<field name="quantity" widget="Integer"/>
```

--------------------------------

### Drawing Widget Basic Configuration

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/widgets.adoc

Use the drawing widget for binary or MetaFile fields to enable freehand drawing on a canvas. This is a basic setup.

```xml
<field name="signature" widget="drawing" />
```

--------------------------------

### Initialize Database

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/application/cli.adoc

Initializes the database by creating the schema and importing demo data.

```sh
  $ axelor database init

```

--------------------------------

### Run Axelor Application with Gradle

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/application/develop.adoc

Execute this command in the terminal to start the embedded server for development. Always use `--no-daemon` to prevent application cleanup issues.

```sh
./gradlew --no-daemon run
```

--------------------------------

### Run Axelor with Custom Configuration

Source: https://github.com/axelor/axelor-open-platform/blob/main/axelor-gradle/src/main/resources/com/axelor/app/README.md

Starts the Axelor application using a specified configuration file. Useful for managing different environments or settings.

```shell
axelor -c /path/to/config.properties run
```

--------------------------------

### Specify Client via Query Parameter

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/modules/security.adoc

Demonstrates how to specify a client using the 'client_name' query parameter in the login URL.

```text
http://localhost:8080/open-platform-demo/?client_name=form
```

--------------------------------

### Scripting Policy Migration Examples (Groovy)

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/ROOT/pages/migrations/migration-8.0.adoc

Demonstrates the transition from older, unrestricted scripting methods to the new, policy-enforced methods using `__repo__` and `__bean__` helpers. Use `__repo__` for repository access and `__bean__` for service instantiation to comply with the scripting policy.

```groovy
// ❌ Old code
doInJPA({ em -> em.find(Contact, id) }) // unrestricted database access
com.axelor.inject.Beans.get(SaleOrderService).validate(order) // unrestricted instanciation of all services
com.axelor.app.AppSettings.get().get('application.mode') != 'prod' // unrestricted access to all app settings

// ✅ New code
__repo__(Contact).find(id) // repositories are allowed by default
__bean__(SaleOrderService).validate(order) // checks scripting policy
__bean__(com.axelor.app.script.ScriptAppSettings).getApplicationMode() != 'prod' // you need to write your own script-allowed app settings helper
```

--------------------------------

### Create Production Build

Source: https://github.com/axelor/axelor-open-platform/blob/main/axelor-front/README.md

Generates a production-ready build of the application. The output will be placed in the `dist` directory.

```bash
pnpm build
```

--------------------------------

### Conditional Binding Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/data-import/csv-import.adoc

This example demonstrates conditional binding in XML configuration, where columns are mapped based on specific conditions evaluated using Groovy expressions.

```xml
<bind to="customer" search="self.email = :email" if="!email.empty">
   <bind column="firstName" to="firstName"/>
   <bind column="lastName" to="lastName"/>
   <bind column="email" to="email"/>
  </bind>

  <bind to="customer" if="email.empty">
   <bind column="firstName" to="firstName"/>
   <bind column="lastName" to="lastName"/>
   <bind to="email" eval='"${firstName}.${lastName}@gmail.com".toLowerCase()'/>
  </bind>
```

--------------------------------

### Query Selector Row Shape Change Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/ROOT/pages/migrations/migration-8.2.adoc

Illustrates the change in row shape for many-to-one fields when using `Selector.values()`. The example shows how a fully materialized entity is replaced by three scalar slots for id, version, and the name field.

```text
[ id, version, firstName, title.id, title.version, title.name, title.code ]
```

```text
[ id, version, firstName, <Title entity>, title.id, title.version, title.name, title.code ]
```

--------------------------------

### String Widget Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/widgets.adoc

Represents a simple string data type field.

```xml
<field name="code"/>
```

--------------------------------

### CSV Data Import with Listener and Task Configuration

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/data-import/integration.adoc

This example demonstrates how to create a CSV importer, add a listener for import events, and configure an import task with input files and error handling. The listener provides statistics on imported records, while the task configuration specifies input sources and exception handling strategies.

```java
package com.axelor.data;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import jakarta.inject.Inject;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.axelor.data.csv.CSVImporter;
import com.axelor.db.Model;
import com.axelor.test.GuiceModules;
import com.axelor.test.GuiceExtension;
import com.google.inject.Injector;

@ExtendWith(GuiceExtension.class)
@GuiceModules(DataModule.class)
public class CSVTest {

  @Inject private Logger log;

  private Logger log = LoggerFactory.getLogger(getClass());

  @Test
  public void testCsv() throws ClassNotFoundException {

    final Importer importer = new CSVImporter("/path/to/csv-config.xml"); 

    final List<Model> records = new ArrayList<>();
    final Map<String, Object> context = new HashMap<>();

    context.put("CUSTOMER_PHONE", "+3326253225");

    importer.addListener(new Listener() {
      @Override
      public void imported(Model bean) {
        log.info("Bean saved : {}(id={})",
            bean.getClass().getSimpleName(),
            bean.getId());
        records.add(bean);
      }

      @Override
      public void imported(Integer total, Integer success) {
        log.info("Record (total): " + total);
        log.info("Record (success): " + success);
      }

      @Override
      public void handle(Model bean, Exception e) {

      }
    });

    importer.runTask(new ImportTask() {

      @Override
      public void configure() throws IOException {
        // provide input data
        input("customers", new File("customers.csv")); 
        input("sales", new File("sales.csv"));
      }

      @Override
      public boolean handle(ImportException exception) {
        log.error("Import error : " + exception);
        return false;
      }

      @Override
      public boolean handle(IOException e) {
        log.error("IOException error : " + e);
        return true;
      }
    });
  }
}
```

--------------------------------

### Get model properties

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-services/meta.adoc

Retrieves the properties (fields) of a specific domain model.

```APIDOC
## GET /ws/meta/fields/{modelName}

### Description
This service can be used to get properties of a domain model.

### Method
GET

### Endpoint
/ws/meta/fields/com.axelor.contact.db.Contact

### Parameters
#### Path Parameters
- **modelName** (string) - Required - The name of the domain model for which to retrieve properties.

### Response
#### Success Response (200)
- **status** (integer) - Indicates the status of the request.
- **data** (object) - Contains the model name and its fields.
  - **model** (string) - The name of the domain model.
  - **fields** (array of objects) - A list of fields for the model.
    - **name** (string) - The name of the field.
    - **type** (string) - The data type of the field.
    - **required** (boolean) - Indicates if the field is required.
```

--------------------------------

### Logout Request

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-services/auth.adoc

Initiate logout by sending a GET request to the /logout endpoint.

```http
GET /logout HTTP/1.1
```

--------------------------------

### Configure Database Settings

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/tutorial/pages/step6.adoc

Set up database connection properties in `axelor-config.properties`. This includes the database URL, username, and password.

```properties
# Database settings
# ~~~~~ 
db.default.ddl = update
db.default.url = jdbc:postgresql://localhost:5432/axelor-demo  <1>
db.default.user = user <2>
db.default.password = secret <3>
```

--------------------------------

### Display Help for Axelor Subcommands

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/application/cli.adoc

Shows detailed help for specific subcommands like 'run' or 'database'.

```sh
  $ axelor run --help

```

```sh
  $ axelor database --help

```

--------------------------------

### Embedded Redisson Configuration Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/application/config.adoc

Configures Redisson client settings directly in axelor-config.properties.

```properties
application.cache.config.single-server-config.address = redis://127.0.0.1:6379
application.cache.config.single-server-config.idle-connection-timeout = 10000
application.cache.config.single-server-config.connect-timeout = 10000
application.cache.config.single-server-config.timeout = 3000
application.cache.config.single-server-config.retry-attempts = 3
application.cache.config.single-server-config.retry-interval = 1500
application.cache.config.threads = 16
application.cache.config.netty-threads = 32
application.cache.config.codec = org.redisson.codec.SerializationCodec
```

--------------------------------

### Configure User Provisioning Strategy

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/modules/security.adoc

Define how users provided by central authentication are handled. Options are 'create', 'link', or 'none'. Specify the default group for new users.

```properties
# user provisioning: create / link / none
auth.user.provisioning = create
# default group for created users
auth.user.default-group = users
```

--------------------------------

### Generate Antora Docs Site Locally

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/README.md

Run this command to generate the Antora Docs site locally. The site will be generated into the 'build/preview/' directory.

```bash
$ antora antora-playbook-local.yml
```

--------------------------------

### Get all domain models

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-services/meta.adoc

Retrieves a list of all available domain models within the system.

```APIDOC
## GET /ws/meta/models

### Description
This service returns a list of all domain models.

### Method
GET

### Endpoint
/ws/meta/models

### Response
#### Success Response (200)
- **status** (integer) - Indicates the status of the request.
- **total** (integer) - The total number of domain models found.
- **data** (array of strings) - A list of domain model names.
```

--------------------------------

### Define Quick Menu and Items

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/quick-menu.adoc

Implement the QuickMenuCreator interface to define the QuickMenu's title, order, and items. Items can be actions or RPC methods with associated contexts.

```java
public class MyQuickMenu implements QuickMenuCreator {

  @Override
  public QuickMenu create() {
    return new QuickMenu(
            "My projects",  <1>
            0,              <2>
            true,           <3>
            getItems());    <4>
  }

  public List<QuickMenuItem> getItems() {
    String action = ProjectController.class.getName() + ":updateDefaultProject";
    List<QuickMenuItem> items = new ArrayList<>();
    for (Project project :
        Query.of(Project.class).filter("?1 MEMBER OF self.members", user).fetch(10)) {
      boolean isDefaultProject = project.equals(user.getDefaultProject());
      QuickMenuItem item =
          new QuickMenuItem(
              project.getName(),                            <5>
              action,                                       <6>
              new Context(project.getId(), Project.class),  <7>
              isDefaultProject);                            <8>
      items.add(item);
    }
    return items;
  }
}
```

--------------------------------

### Temporary File Creation

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/ROOT/pages/migrations/migration-8.0.adoc

Demonstrates the change in temporary file creation from MetaFiles to TempFiles.

```java
// Was: Path tempFile = MetaFiles.createTempFile(prefix, suffix);
Path tempFile = TempFiles.createTempFile(prefix, suffix)
```

--------------------------------

### Displaying a Chart and a Grid

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/views/form.adoc

Examples of using the panel-dashlet tag to display a chart or a grid view.

```xml
<panel-dashlet action="chart:chart.sales.per.month"/>
<panel-dashlet action="sale.category.link.products" />
```

--------------------------------

### UUID Widget Example

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/widgets.adoc

Represents UUID data fields, providing a masked input for correct formatting.

```xml
<field name="productUid" widget="Uuid"/>
```

--------------------------------

### Configure Custom Authentication Client with Google Details

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/ROOT/pages/migrations/migration-6.0.adoc

This example shows how to configure a custom authentication provider ('myprovider') that uses Google's OAuth2 client and configuration, including its title, icon, and credentials.

```properties
auth.provider.myprovider.client = org.pac4j.oauth.client.Google2Client
auth.provider.myprovider.configuration = org.pac4j.oauth.config.OAuth20Configuration
auth.provider.myprovider.title = Google
auth.provider.myprovider.icon = img/signin/google.svg
auth.provider.myprovider.exclusive = false

auth.provider.myprovider.key = 127736102816-tc5mmsfaasa399jhqkfbv48nftoc55ft.apps.googleusercontent.com
auth.provider.myprovider.secret = qySuozNl72zzM5SKW-0kczwV
```

--------------------------------

### Show Axelor Version

Source: https://github.com/axelor/axelor-open-platform/blob/main/axelor-gradle/src/main/resources/com/axelor/app/README.md

Displays the installed version of the Axelor platform. Use this to check compatibility or report issues.

```shell
axelor --version
```

--------------------------------

### Build Project with New Module

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/tutorial/pages/step2.adoc

Execute the Gradle build command to compile the project with the newly added module.

```sh
$ ./gradlew build
```

--------------------------------

### Enable and Install pnpm

Source: https://github.com/axelor/axelor-open-platform/blob/main/axelor-front/README.md

Enables the corepack package manager to use pnpm, which is used for managing project dependencies.

```bash
# pnpm
$ corepack enable pnpm
```

--------------------------------

### Scripting Expression for Enum

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/models/models.adoc

In scripting expressions, enum values should be referenced using their type name, for example, `OrderStatus.OPEN`.

```xml
<check
  field="confirmDate"
  if="status == OrderStatus.OPEN &amp;&amp; confirmDate == null"
  error="Invalid value..." />
```

--------------------------------

### Configure Custom Store Provider

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/application/file-storage.adoc

Set the fully qualified name (FQN) of a custom `Store` implementation to integrate non-S3-compatible storage systems. The class must implement `com.axelor.file.store.Store` and have a no-arg constructor.

```properties
data.store.provider = com.axelor.file.store.MyCustomStore
```

--------------------------------

### Set JAVA_HOME and PATH on Linux/MacOS

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/getting-started/pages/install.adoc

Configure environment variables for OpenJDK on Linux or MacOS. Ensure JDK command-line tools are accessible.

```sh
$ export JAVA_HOME=/path/to/jdk
$ export PATH=$JAVA_HOME/bin:$PATH
```

--------------------------------

### Advanced Delete Service Response

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-services/advanced.adoc

Example response for the Advanced Delete service, confirming the deletion of specified records.

```json
{
  "status": 0,
  "data": [{
    "id": 1,
    "version": 1
  }, {
    "id": 2,
    "version": 0
  }]
}
```

--------------------------------

### Perform Mass Indexing via CLI

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/modules/global-search.adoc

Initiate the mass indexing process using the command-line interface to build the search index for all entities. Use the `--drop` option to re-index from scratch or `--tenant` to specify a tenant.

```sh
$ ./bin/axelor search index
```

```sh
# Re-index everything from scratch
$ ./bin/axelor search index --drop
```

--------------------------------

### Button Widget as a Link

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/widgets.adoc

Render a button as a hyperlink to a specified URL. This example creates a button that links to the Axelor website.

```xml
<button name="customBtn" title="Button" link="https://axelor.com" />
```

--------------------------------

### Keystore and Truststore Configuration

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/modules/security.adoc

Configure paths and passwords for keystore and trust certificates used for secure connections.

```properties
auth.ldap.server.ssl.key-store.path =
auth.ldap.server.ssl.key-store.password =
auth.ldap.server.ssl.key-store.type =
auth.ldap.server.ssl.key-store.aliases =

# trust certificates
auth.ldap.server.ssl.cert.trust-path =
# authentication certificate
auth.ldap.server.ssl.cert.auth-path =
# authentication key
auth.ldap.server.ssl.cert.key-path =
```

--------------------------------

### Basic SAML Configuration Properties

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/modules/security.adoc

Configure essential SAML settings such as keystore details, metadata paths, and the service provider entity ID. Ensure the keystore and private key passwords are set correctly.

```properties
# path to keystore
auth.provider.saml.keystore-path = path/to/samlKeystore.jks
# value of the -storepass option for the keystore
auth.provider.saml.keystore-password = open-platform-demo-passwd
# value of the -keypass option
auth.provider.saml.private-key-password = open-platform-demo-passwd
# path to IdP metadata
auth.provider.saml.identity-provider-metadata-path = http://localhost:9012/simplesaml/saml2/idp/metadata.php
# path to SP metadata
auth.provider.saml.service-provider-metadata-path = path/to/sp-metadata.xml
# SP entity ID
auth.provider.saml.service-provider-entity-id = sp.test.pac4j
```

--------------------------------

### Generate Run Launcher with Gradle

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/getting-started/pages/vscode.adoc

Run this task to generate the `.vscode/launch.json` file for debugging. This is necessary for setting up the debugger in VSCode.

```shell
./gradlew generateLauncher
```

--------------------------------

### Image Rendering with $image Helper

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/views/cards.adoc

Demonstrates how to use the `$image` helper function within a template to display images from binary fields or m2o relationships.

```xml
<!-- if image is binary field -->
<img src={$image(null, 'image')}>
```

```xml
<!-- if image is m2o to MetaFile -->
<img src={$image('image', 'content')}>
```

```xml
<!-- show binary field image of custom in sale order card -->
<img src={$image('customer', 'image')}>
```

--------------------------------

### Advanced Read Service Response

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-services/advanced.adoc

Example response for the Advanced Read service, showing fetched fields and nested related data.

```json
{
  "status": 0,
  "data": [{
    "id": 1,
    "version": 1,
    "fullName": "John Smith",
    "user": {
      "name": "j.smith",
      "email": "j.smith@example.com",
      "id": 123,
      "version": 0
    },
    "parent": {
      "fullName": "Thomas Smith",
      "id": 12,
      "version": 0
    }
  }]
}
```

--------------------------------

### Implement Business Service (Java)

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/modules/coding.adoc

Provide a default implementation for the service interface. This class contains the actual business logic and is managed by the Guice framework.

```java
package com.axelor.contact.service;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.axelor.contact.db.Contact;

public class HelloServiceImpl implements HelloService {

  protected Logger log = LoggerFactory.getLogger(getClass());

  @Override
  public String say(Contact contact) {
    return String.format("Welcome, '%s!'", contact.getFullName());
  }

  @Override
  public String hello() {
    return "Hello, World!";
  }
}
```

--------------------------------

### Button with ui-action-click Directive

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/views/cards.adoc

Example of adding a button within a card template that triggers an action when clicked using the `ui-action-click` directive.

```xml
<template><![CDATA[
<button type="button" class="btn" ui-action-click="some.action" />
]]>
</template>
```

--------------------------------

### Controller Method Java

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/actions/action-method.adoc

Example Java controller method annotated with @CallMethod. It accepts a string argument and returns a formatted string.

```java
import com.axelor.meta.CallMethod;

public class Hello {

  @CallMethod
  public String say(String what) {
    return "About: " + what;
  }
}
```

--------------------------------

### Implement Kotlin Service

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/modules/kotlin.adoc

Provides an implementation for the 'HelloService' interface in Kotlin. This implementation prints the provided message to the console.

```kotlin
package com.axelor.hello.service

open class HelloServiceImpl : HelloService {

    override fun say(what: String) {
        println("Say: ${what}")
    }
}
```

--------------------------------

### Configure CAS Client

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/modules/security.adoc

Set up the CAS client for authentication, including login and prefix URLs, and the CAS protocol version.

```properties
# CAS
# Client: org.pac4j.cas.client.CasClient
```

--------------------------------

### Barcode Widget Basic Configuration

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/widgets.adoc

Display string data as a barcode using the Barcode widget. This is a basic setup for the 'name' field.

```xml
<field name="name" widget="Barcode" />
```

--------------------------------

### Barcode Widget with Specific Format

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/web-client/widgets.adoc

Configure the Barcode widget to use a specific barcode format, such as EAN13. This example applies it to the 'gtin' field.

```xml
<field name="gtin" widget="Barcode" x-barcode-format="EAN13" />
```

--------------------------------

### Create PostgreSQL Database

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/tutorial/pages/step6.adoc

Use the `createdb` utility to create the PostgreSQL database specified in the configuration.

```sh
$ createdb axelor-demo
```

--------------------------------

### Replace `Files.createTempDirectory` with `TempFiles.createTempDir`

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/ROOT/pages/migrations/migration-8.0.adoc

Update file path creation to use the new `TempFiles` utility.

```java
// Was: Path tempFile = Files.createTempDirectory(prefix);
Path tempFile = TempFiles.createTempDir(prefix);
```

--------------------------------

### Define Multiple JSON Fields in a Model

Source: https://github.com/axelor/axelor-open-platform/blob/main/documentation/modules/dev-guide/pages/models/custom-fields.adoc

Example of a domain model with multiple string fields designated for storing custom field values.

```xml
<entity name="Contact">
  <string name="name" required="true" unique="true" min="2" />
  ...
  <string name="customAttrs" title="Custom Attributes" json="true" />
  <string name="extraAttrs" title="Extra Attributes" json="true" />
</entity>
```