# $convert
- convert field
Converts the content of a field into an attachment with a specific format with the help of an external service provider ConvertAPI (opens new window). It currently converts plain text, markdown, excel files to PDF.
# Installation:
In order to use this customization, it must be installed in the server as:
cob-cli customize convert
WARNING
- Requires IntegrationM restart
- After the installation it is required that you add your API Token to the file
common/config/ConvertToConfig.groovy
# Usage:
$convert(<sourceField>).<format>
WARNING
The source field must be one of:
- $text
- $markdown
- $file.
The list of supported format files are:
- XLSX
- XLS
- PPTX
- PPT
- ODT
- DOCX
- DOC
- RTF
- PUB
- CSV
- NUMBERS
- KEY
- PAGES
- PNG
- JPG
WARNING
Please note that the conversion will only occur upon saving.
# Examples:
# 1. Convert an XLSX file to PDF
$file $convert(Report File).pdf