APIs and Customization

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:

• See technical documentation: https://your.xtrf.address.com/api-doc.
• 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:

• See technical documentation: https://your.xtrf.address.com/api-doc.
• Communication with Client Portal API uses HTTP and follows the REST principle.

A demo on how to integrate CMS with XTRF is available at https://xtrf.github.io/cp-api/.

Scripted Steps API

Who can edit:

• Everyone who uses Smart Projects, has bought this feature (available in selected plans) and has permissions to access  System Configuration.
• Automatic Actions can be then used in Processes and Process Templates.

How to edit:

• Request a new Scripted Step by contacting your Customer Success Manager or via XTRF Help Center.
• Open selected Scripted Step in  System Configuration > Projects and Quotes > Process Steps (Smart) and use the built-in editor.
• 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 permissions to access  System Configuration > Integration > XTRF Macros.
• Macros can be then used in XTRF's Smart Views.

How to edit:

• Request new macro by contacting your Customer Success Manager or via XTRF Help Center.
• Open selected Macro in  System Configuration > Integration > XTRF Macros and use the built-in editor.
• Macros are written in Apache Velocity language or Apache Groovy language.
• Macros can refer to data available in XTRF model (request technical documentation via XTRF Help Center).

Smart Connectors

Who can edit:

• Everyone who has bought Smart Connectors feature (extra paid in any plan) and has permissions to access  System Configuration > Integration > Smart Connectors.

How to edit:

• Request a new Smart Connector by contacting your Customer Success Manager or via XTRF Help Center
• Open the selected Smart Connector in  System Configuration > Integration > Smart Connectors and use the built-in editor.
• Scripts are written in JavaScript language.
• Script can refer to data available in Smart Connectors API (see technical documentation for details).

Templates, Expressions and Schemes Customization

E-mail Notification Templates

Who can edit:

• Everyone who has permissions to access  System Configuration > Templates.

How to edit:

• Request a modification done by our specialist by contacting your Customer Success Manager or via XTRF Help Center.
  
• Open the selected Template or Theme in  System Configuration > Templates > Notifications and use the built-in editor.
• Templates are written in Apache Velocity language.
• Special tags (variables or special expressions) can be used in the template by selecting them from a the tags tree that is built into the editor (click on the XTRF logo icon in the toolbar to open a tree of available tags).

Document Templates

Who can edit:

• Everyone who has activated the Document Templates feature (available in selected plans) and has permissions to access  System Configuration > Templates.

How to edit:

• Request a modification done by our specialist by contacting your Customer Success Manager or via XTRF Help Center.
• Open selected Template in System Configuration > Document Templates and upload a modified template.
• Templates use BIRT 4 format and have to be named DocumentTemplateFilename.rptdesign
• Templates can refer to data available in XTRF model (request technical documentation via XTRF Help Center).

Custom Columns (old name: Virtual Columns)

Who can edit:

• Everyone who has activated the Custom Columns feature (available in selected plans) and has permissions to access  System Configuration > Custom Fields and Columns.
• Custom Columns can be then used in XGeneral Configuration >TRF's Smart Views.

How to edit:

• Request new custom column done by our specialist by contacting your Customer Success Manager or via XTRF Help Center.
• Open selected Template in  System Configuration > General Configuration > Custom Fields and Columns > Custom Columns tab, and use the built-in editor.
• Custom columns are written in Apache Velocity language.
• Custom columns can refer to data available in XTRF model (request technical documentation via XTRF Help Center).

Expressions

Who can edit:

• Everyone who has permissions to access  System Configuration > Templates.

How to edit:

• Request a modification done by our specialist by contacting your Customer Success Manager or via XTRF Help Center.
• Open selected Expression in  System Configuration > Templates > Expressions and use the built-in editor.
• Expressions are written in Apache Velocity language.
• Expressions can refer to data available in XTRF model (request technical documentation via XTRF Help Center).

Numbering Schemes

Who can edit:

• Everyone who has permissions to System Configuration > Templates.

How to edit:

• Request a modification done by our specialist by contacting your Customer Success Manager or via XTRF Help Center.
• Open selected Numbering Schema in  System Configuration > Templates > Numbering Schemes and use the built-in editor.
• Numbering schemes are written in Apache Velocity language.
• Numbering schemes can refer to data available in XTRF model (request technical documentation via XTRF Help Center).

Other

Expressions that can refer to data available in an XTRF model can be also used to customize:

• Sender Name for E-mail Messages Sent by XTRF ( System Configuration > General Configuration > Settings > E-mail > E-mail Sender Name).
• Global Client and Vendor Payment Terms Description ( System Configuration > Clients and Vendors > Client/Vendor Settings > Payment Terms, click  Edit at the selected Client Payment Term, click  Edit or Add at the selected Localized Description Expression).
• Calculation Unit Quantity Conversion Expression ( System Configuration > System Values: Advanced > Calculation Units and edit the Conversion Expression field where applicable).
• CAT Tool Settings ( System Configuration > Integration > CAT Tools).
• QuickBooks and QuickBooks Online Settings ( System Configuration > Integration > Quick Books (Online)).
• Access Control Lists ( System Configuration > General Configuration > Settings > Security).
• Periodic Jobs ( System Configuration > Integration > Periodic Jobs).

All expressions are written in Apache Velocity language.

Note

Technical documentation can be requested via XTRF Help Center.

Deprecated Customization Items

Automatic Actions (Classic Projects)

Who can edit:

• Everyone who uses Classic Projects, has their own hosting and has permissions to access  System Configuration.
• Automatic Actions can be then used in Workflows.

How to edit:

• Open selected Automatic Action in  System Configuration > Projects and Quotes > Automatic Actions (Classic) and use the built-in editor.
• Some settings of Automatic Actions are written in Apache Velocity language (esp. Automatic Actions that run External Process).
• Expressions can refer to data available in XTRF model (request technical documentation via XTRF Help Center).
• A list of available tags (variables or special expressions) is displayed near the editor (only Automatic Actions that run External Process).

File Naming Expressions (Classic Projects)

Who can edit:

• Everyone who uses Classic Projects and who has permissions to access System Configuration > Templates.

How to edit:

• Open selected Naming Schema in  System Configuration > Templates > Files and use the built-in editor.
• File naming schemes are written in Apache Velocity language.
• File naming schemes can refer to data available in XTRF model (request technical documentation via XTRF Help Center).
• A list of available tags (variables or special expressions) is displayed next to the editor.

Directory Naming Expressions (Classic Projects)

Who can edit:

• Everyone who has permissions to access  System Configuration > Templates.

How to edit:

• Open selected Naming Schema in System Configuration > Templates > Directories and use the built-in editor.
• Directory naming schemes are written in Apache Velocity language.
• Directory naming schemes can refer to data available in XTRF model (request technical documentation via XTRF Help Center).
• A list of available tags (variables or special expressions) is displayed next to the editor.