APIs and Customizations

APIs for Extending XTRF Functionality

Home Portal API

Who can use:

  • everyone who has bought Home Portal API feature (available in Premium plan)

How to use:

  • see technical documentation
  • communication with Home Portal API uses HTTP and follows REST principle

Technical documentation: https://your.xtrf.address.com/api/doc/

Client Portal API

Who can use:

  • everyone who has bought Client Portal feature (available in Professional and Premium plan)

How to use:

  • see technical documentation
  • communication with Client Portal API uses HTTP and follows REST principle

Technical documentation: https://your.xtrf.address.com/api/doc/

A demo on how to integrating CMS with XTRF can be done is available at http://xtrf.github.io/cp-api/

Scripted Jobs API

Who can edit:

  • everyone who has permissions to System Configuration
  • Automatic Actions can be then used in Processes and Process Templates

How to edit:

  • 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 bought XTRF Macros feature (available in Professional plan) and has permissions to System Configuration > XTRF Macros
  • Macros can be then used in browses (table views)

How to edit:

  • 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 (see technical documentation for details)

Technical documentation: Ask your Account Manager.

Smart Connectors

Who can edit:

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

How to edit:

  • open selected Scripted Step 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)

Technical documentation: Ask your Account Manager.

Templates, Expressions and Schemes Customization

E-mail Notification Templates

Who can edit:

  • everyone who has bought Notification Templates feature (available in Professional and Premium plan) and has permissions to System Configuration > Templates

How to edit:

  • 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 (click XTRF logo icon on the toolbar to open the tree)

Technical documentation: built into the editor (click XTRF logo icon on the toolbar to open the tree of available tags).

Document Templates

Who can edit:

  • everyone who has bought Document Templates feature (available in Professional and Premium plan) and has permissions to System Configuration > Templates

How to edit:

  • 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 (see technical documentation for details)

Technical documentation: Ask your Account Manager.

Custom Columns (old name: Virtual Columns)

Who can edit:

  • everyone who has bought Virtual Columns feature (available in Professional and Premium plan) and has permissions to System Configuration
  • Virtual Columns can be then used in browses (table views)

How to edit:

  • open selected Template in System Configuration > Custom Fields and Columns > Virtual Columns and use the built-in editor
  • virtual columns are written in Apache Velocity language
  • virtual columns can refer to data available in XTRF model (see technical documentation for details)

Technical documentation: Ask your Account Manager.

Expressions

Who can edit:

  • everyone who has bought Expression Templates feature (available in Professional and Premium plan) and has permissions to System Configuration > Templates

How to edit:

  • 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 (see technical documentation for details)

Technical documentation: Ask your Account Manager.

Numbering Schemes

Who can edit:

  • everyone who has bought Numbering Schemas feature (available in Professional and Premium plan) and has permissions to System Configuration > Templates

How to edit:

  • 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 (see technical documentation for details)

Technical documentation: Ask your Account Manager.

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: Ask your Account Manager.

Deprecated Customizations

Automatic Actions (Classic Projects)

Who can edit:

  • everyone who has permissions to 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 (see technical documentation for details)
  • a list of available tags (variables or special expressions) is displayed near the editor (only Automatic Actions that run External Process)

Technical documentation: Ask your Account Manager.

File Naming Schemes (Classic Projects)

Who can edit:

  • everyone who has permissions to 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 (see technical documentation for details)
  • a list of available tags (variables or special expressions) is displayed near the editor

Technical documentation: Ask your Account Manager.

Directory Naming Schemes (Classic Projects)

Who can edit:

  • everyone who has permissions to 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 (see technical documentation for details)
  • a list of available tags (variables or special expressions) is displayed near the editor

Technical documentation: Ask your Account Manager.

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