APIs and Customization

APIs for Extending XTRF Functionality

Home Portal API

Who can use:

  • everyone who has bought Home Portal API feature (available in selected plans)

How to use:

Client Portal API

Who can use:

  • everyone who has bought Client Portal feature (available in selected plans)

How to use:

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 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 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 > XTRF Macros
  • Macros can be then used in XTRF's Smart Views

How to edit:

Smart Connectors

Who can edit:

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

How to edit:

  • request new Smart Connector by contacting your Customer Success Manager or via XTRF Help Center
  • open 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 selected Template or Theme in System Configuration > 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 a tag in the tags tree that are 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 Columns can be then used in XTRF'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 > Custom Fields and Columns > Custom Columns 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 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 Conversion Expression field)
  • 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.

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 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
Client Portal API Automation Templates

This article was helpful for 2 people. Is this article helpful for you?