Skip to content

customization.md

Latest commit

 

History

History
189 lines (151 loc) · 3.65 KB

customization.md

File metadata and controls

189 lines (151 loc) · 3.65 KB

Customization

Some additional features can be configured in the metadata defs. The path is custom/Espo/Custom/Resources/metadata/exportImportDefs.

Export additional fields

If need to export additional fields that out of the standard functionality.

exportAdditionalFieldList

Example for Quotes: custom/Espo/Custom/Resources/metadata/exportImportDefs/Quote.json

{
    "exportAdditionalFieldList": [
        "itemList"
    ]
}

Skip export list

If need to skip some records like system user or others.

exportSkipLists

Example for User: custom/Espo/Custom/Resources/metadata/exportImportDefs/User.json

{
    "exportSkipLists" : {
        "id": [
            "system"
        ],
        "userName": [
            "tester"
        ]
    }
}

Placeholders

Edit the file: custom/Espo/Custom/Resources/metadata/exportImportDefs/ENTITY.json.

Config

Get

{
    "fields": {
        "amountCurrency": {
            "placeholderAction": "Config\\Get",
            "placeholderData": {
                "key": "defaultCurrency",
                "default": null
            }
        }
    }
}

User

Password

{
    "fields": {
        "password": {
            "placeholderAction": "User\\Password",
            "placeholderData": {
                "value": "1"
            }
        }
    }
}

Active

{
    "fields": {
        "isActive": {
            "placeholderAction": "User\\Active"
        }
    }
}

Datetime

Now

{
    "fields": {
        "dateStart": {
            "placeholderAction": "DateTime\\Now"
        }
    }
}

ExportDifference

The difference between the record date and the export date. E.g. record date = 2025-05-01, export date = 2025-08-01. When import data at 2025-12-01, the record data will be 2025-09-01.

{
    "fields": {
        "dateStart": {
            "placeholderAction": "DateTime\\ExportDifference"
        }
    }
}

ExportDifferenceField

The same logic as ExportDifference, but the initial value gets from another field.

{
    "fields": {
        "createdAt": {
            "placeholderAction": "DateTime\\ExportDifferenceField",
            "placeholderData": {
                "field": "dateStart",
                "defaultAction": "DateTime\\Now"
            }
        }
    }
}

To get the initial value from a couple fields. The value will be obtained from the first defined field.

{
    "fields": {
        "createdAt": {
            "placeholderAction": "DateTime\\ExportDifferenceField",
            "placeholderData": {
                "fieldList": [
                    "dateStart",
                    "dateEnd",
                    "dateCompleted"
                ],
                "default": "2026-01-01 01:00:00"
            }
        }
    }
}

The placeholderData parameter accepts the following options:

  • field – Specifies the field name from which to retrieve the value. Note: field and fieldList are mutually exclusive.
  • fieldList – An array of field names to check for a value. The first non-empty field will be used.
  • default – A fallback value to use when the specified field(s) contain no data. Note: default and defaultAction are mutually exclusive.
  • defaultAction – A fallback placeholder action to execute when the specified field(s) contain no data.

CurrentMonth

{
    "fields": {
        "dateStart": {
            "placeholderAction": "DateTime\\CurrentMonth"
        }
    }
}

CurrentYear

{
    "fields": {
        "dateStart": {
            "placeholderAction": "DateTime\\CurrentYear"
        }
    }
}