Discover XTRF Platform APIs and customizations
- Oksana Vishchuk
APIs for extending XTRF functionality
Home Portal API
Who can use: Everyone who has bought the Home Portal API feature (available in selected plans).
How to use: Check the technical documentation for your XTRF instance. For details, see the How to access API documentation? guide.
Communication with the Home Portal API uses HTTP and follows the REST principle.
Client Portal API
Who can use: Everyone who has bought the Client Portal feature (available in selected plans).
How to use: Check the technical documentation for your XTRF instance. For details, see the How to access API documentation? guide.
Communication with the Client Portal API uses HTTP and follows the REST principle.
A demo on how to integrate CMS with XTRF is available at Integrating CMS with XTRF Language Business Platform.
Scripted Steps API
Who can edit: Everyone who uses Smart projects, has bought the Scripted Steps API feature (available in selected plans) and has permission to access the Configuration menu.
Automatic actions can then be used in Processes and Process Templates.
How to edit:
Request a new Scripted Step via XTRF Support.
Open the selected Scripted Step in the Configuration menu → Projects and Quotes → Process Steps (Smart) and use the built-in editor. For details, see the Add a Smart process step guide.
Scripts are written in JavaScript language.
Script can refer to data available in Scripted Jobs API.
Macros
Who can edit: Everyone who has activated the XTRF Macros feature (available in selected plans) and has permission to access the Configuration menu → Integration → XTRF Macros.
Macros can then be used in XTRF's Smart views.
How to edit:
Request a new macro via XTRF Support.
Open the selected macro in the Configuration menu → Integration → XTRF Macros and use the built-in editor. For details, see the XTRF guide to macros.
Macros are written in Apache Groovy language.
Macros can refer to data available in the XTRF model. You can request technical documentation via XTRF Support.
Smart Connectors
Who can edit: Everyone who bought the Smart Connectors feature (available in selected plans) has permission to access the Configuration menu → Integration → Smart Connectors.
How to edit:
Request a new Smart Connector via the XTRF Support.
Open the selected Smart Connector in the Configuration menu → Integration → Smart Connectors and use the built-in editor. For details, see the Smart Connectors - Technical Guide.
Scripts are written in JavaScript language.
Script can refer to data available in Smart Connectors API (for details, see the Smart Connectors - Technical Guide).
Templates, Expressions, and Schemes customization
E-mail Notification Templates
Who can edit: Everyone who has permission to access the Configuration menu →Templates.
How to edit:
Request a modification done by our specialist via XTRF Support.
Alternatively, open the selected Template or Theme in the Configuration menu →Templates → Notifications and use the built-in editor. For details, see the Create a custom e-mail notification template guide.
Templates are written in Apache Velocity language.
In templates, you can use special tags (variables or special expressions). To do so, click on the XTRF logo icon in the toolbar and select them from the built-in tag tree.
Document Templates
Who can edit: Everyone who has activated the Document Templates feature (available in selected plans) and has permission to access the Configuration menu →Templates.
How to edit:
Request a modification done by our specialist via XTRF Support.
Alternatively, open the selected Template in the Configuration menu →Templates → Document Templates and:
For Open PDF templates, use the built-in editor. For details, see the Add an HTML document template guide.
For BIRT4 templates, upload a modified template. For details, see the Add a BIRT-4 document template and Customize a BIRT-4 document template guide.
Templates that use the BIRT 4 format must be named
DocumentTemplateFilename.rptdesign.Templates can refer to data available in the XTRF model. You can request technical documentation via XTRF Support.
Custom Columns (old name: Virtual Columns)
Who can edit: Everyone who has activated the Custom Columns feature (available in selected plans) and has permission to access the Configuration menu → General Configuration → Custom Fields and Columns.
Custom Columns can then be used in XTRF's Smart views.
How to edit:
Request a new custom column done by our specialists via XTRF Support.
Alternatively, open the required Template in the Configuration menu → General Configuration → Custom Fields and Columns → Custom Columns tab and use the built-in editor. For details, see the Add a custom column guide.
Custom columns are written in Apache Velocity language or Apache Groovy language.
Custom columns can refer to data available in the XTRF model. You can request technical documentation via XTRF Support.
Expressions
Who can edit: Everyone who has permission to access the Configuration menu →Templates.
How to edit:
Request a modification done by our specialists via XTRF Support.
Alternatively, open the required Expression in the Configuration menu →Templates → Expressions and use the built-in editor. For details, see the Add an expression guide. System Configuration > Templates > Expressions and use the built-in editor.
Expressions are written in Apache Velocity language.
Expressions can refer to data available in the XTRF model. You can request technical documentation via XTRF Support.
Numbering Schemes
Who can edit: Everyone who has permission to access the Configuration menu →Templates.
How to edit:
Request a modification done by our specialists via XTRF Support.
Alternatively, open the required Numbering Schema in the Configuration menu →Templates → Numbering Schemes and use the built-in editor. For details, see the Add a numbering scheme guide.
Numbering schemes are written in Apache Velocity language.
Numbering schemes can refer to data available in the XTRF model. You can request technical documentation via XTRF Support.
Other expressions
Here is the list of customized expressions that can refer to data available in an XTRF model:
Sender Name for E-mail Messages Sent by XTRF ( Configuration menu → General Configuration → Settings → E-mail tab → E-mail Sender Name).
Global Client and Vendor Payment Terms Description (in the Configuration menu → Clients and Vendors → Client/Vendor settings → Payment Terms tab, click the ‘Edit’ icon next to the required payment terms, then edit or add the required Localized Description Expression).
Calculation Unit Quantity Conversion Expression (in Configuration menu → System Values: Advanced → Calculation Units, select the required calculation unit and edit the Conversion Expression field where applicable).
CAT Tool Settings ( Configuration menu → Integration → CAT Tools).
QuickBooks and QuickBooks Online Settings ( Configuration menu → Integration → QuickBooks / QuickBooks Online).
Periodic Jobs ( Configuration menu → Integration → Periodic Jobs).
All expressions are written in Apache Velocity language.
Technical documentation can be requested via XTRF Support.
Deprecated customization items
Settings from this section are not supported anymore and are to be removed.
Automatic Actions (Classic Projects)
Who can edit: Everyone who uses Classic projects, has their own hosting and permission to access the Configuration menu.
Automatic Actions can then be used in Classic workflows.
How to edit:
Open the required Automatic Action in the Configuration menu → Projects and Quotes → Automatic Actions (Classic) and use the built-in editor. For details, see the Add a Classic automatic action guide.
Some Automatic Actions settings are written in Apache Velocity language.
Expressions can refer to data available in the XTRF model. You can request technical documentation via XTRF Support.
File Naming Expressions (Classic Projects)
Who can edit: Everyone who uses Classic projects and who has permission to access the Configuration menu →Templates.
How to edit:
Open the required Naming Schema in the the Configuration menu →Templates → Files → Filenames tab and use the built-in editor.
File naming schemes are written in Apache Velocity language.
File naming schemes can refer to data available in the XTRF model. You can request technical documentation via XTRF Support.
A list of available tags (variables or special expressions) is displayed on the editor page.
Directory Naming Expressions (Classic Projects)
Who can edit: Everyone who has permission to access the Configuration menu →Templates.
How to edit:
Open the required Naming Schema in the the Configuration menu →Templates → Directories tab and use the built-in editor.
Directory naming schemes are written in Apache Velocity language.
Directory naming schemes can refer to data available in the XTRF model. You can request technical documentation via XTRF Support.
A list of available tags (variables or special expressions) is displayed on the editor page.