Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel2
outlinefalse
typelist
printablefalse

Info

This section is a part of the Configuration menu. Access to this section may be restricted by Home Portal administrators.

Note

The changes in the configuration menu settings will affect all XTRF users and, therefore, should be well considered.

Some settings depend on the selected XTRF plan and thus might be unavailable for some clients.

In the Template section, you can create and manage standard forms, schemes, and paths to accelerate your business processes.

Document templates

In this subsection, you can manage the templates that allow you to generate standardized documents, so you have to put less or no effort into creating new documents for clients and vendors.

Templates tab

In this tab, you can browse, add, open, and manage document templates. By default, you see the list of all templates with several filters on top of the table and information about template type, localization, built-in and active status, and rendering engine.

Info

To learn how to edit the default view or create a new one, see the Smart views article.

Manage the document templates

  • To open a template, click on its line in the list. To open a template in edit mode, click the (blue star) icon in the last column. The editing options are described in the Add a document template section below.

  • To download a template, click the (blue star) icon in the last column.

  • If you select one or several checkboxes in the left column, additional buttons appear on top of the list of templates.

    • Click the Edit Selected button to Activate or Deactivate document templates.

    • Click the Delete button to delete the selected template (available only when one template is selected).

Panel
panelIconId1f4a1
panelIcon:bulb:
panelIconText💡
bgColor#E3FCEF

Right-click on the template to open a drop-down menu of the applicable actions.

Add a document template

In XTRF, there are two types of document templates with different customizing tools:

  • Open PDF or HTML-based templates that you can edit and preview the outcome directly in XTRF.

  • BIRT-4 or file-based templates that require using external tools and importing the final results to XTRF.


Add an HTML-based template

  1. Click the Add HTML-based Template button. You will be directed to the Templates page.
    Note: To create a new template based on the existing one, open it in edit mode and click the Copy button in the top right-hand corner.

  2. Provide the Template Name.

  3. Select the Template Type from the drop-down list.

  4. Click the Add Template button.

  5. In the Template details card, decide whether the new template should be:

    1. Active and thus selectable

    2. a Default one.

  6. In the Template designer card:

    1. Select the language versions for this template:

      1. Click the (blue star) icon to open the language menu and add the desired languages. To close the language menu, click the (blue star) icon again.

      2. Click the (blue star) icon next to the language to open a menu of applicable actions.

    2. (Optional) Edit the standard template in the Editor section:

      1. Select a different Theme from the drop-down list. To learn more about themes, see the Themes tab section of this article.

      2. Change the formatting using the editor tools.
        Note: Please keep in mind that pasting the copied text in the ‘Simple’ editor will also paste the text styling, which may cause problems for some values (e.g. when checking if the text is equal to other text or when entering Custom Fields "Key" names).

      3. (Optional) Switch to the HTML editor to edit the HTML code directly.

      4. Add or change the template’s XTRF tags. Put the cursor in the desired place of the template and click the (blue star) icon to open the list of applicable tags. Locate the desired tag and click on it to add it to the template.

    3. (Optional) Preview the document.

      1. On top of the right-hand pane, select the desired Theme from the drop-down list.

      2. Select a corresponding item in the search-as-you-type field.The preview will appear below.
        Note: The item depends on the selected Template Type, e.g., for a Client Project Confirmation, you can select a project; for Vendor Purchase Order - a job, etc.

  7. Click the Save button in the top right-hand corner.

Panel
panelIconId1f4a1
panelIcon:bulb:
panelIconText💡
bgColor#E3FCEF

Click the (blue star) icon to check the details of the template. Click the (blue star) icon to expand the Template designer card.

Each language version can be enabled or disabled, but at least one will always remain enabled. One of the enabled languages can also be set as a default one for a given template. Each template always has a default language version.

When generating or sending documents for your clients and vendors, the system will automatically use the language version that matches the preferred language for the e-mails of the recipient. If the required language version of the document is not enabled, the default localization will be used instead. 

The language of the Client Portal’s interface and the preferred language for the client’s e-mails and documents are two separate settings. The template’s language should not differ from the preferred language for the e-mails set in the client’s profile; otherwise, the template won’t be displayed correctly. Please bear in mind that certain languages have different locale codes, for example, EN-GB and EN-US. The system defines them as different languages, so make sure those settings are aligned as needed.


Add a file-based document template

Info

The following steps instruct you on how to upload document templates prepared within the BIRT-4 version. Before proceeding with the following steps, you need to have ready-to-use document template files stored on your local machine.

  1. Click the Add File-based Template button. You will be directed to the Add Document Templates page.

  2. Provide the name of the template you are going to upload. 
    Note: If you plan to use a certain type of template for more than one language, it might be helpful to add information about the used language to a document template name. For example, Client Invoice FR  or Project Confirmation French.  Bear in mind that you need to add a new Document Template entity for each required language to have the template localized.

  3. From the Template Type drop-down list, select the correct type or the Autodetect option.
    Note: We recommend setting the template type to Autodetect. The XTRF Platform will then automatically recognize the files that will be attached to a given document template. If you select another option, please mind that you might experience issues while managing document template files. For example, the preview of the document might be unavailable.

  4. Select the language of the document template.

  5. Decide whether the new template should be a Default one.
    Note: There can be only one default document template for each template type. Therefore, if you select the Default checkbox for a document template in a certain language, it will be used by default regardless of other language settings. 

    To make sure that the default language of the e-mails and documents sent to clients and vendors are the same, go to the (blue star) Configuration menu > Clients and Vendors and check the Default Communication Language setting for clients and vendors.

  6. Decide whether the new template should be Active and thus selectable.

  7. Click the Add files… button and select the correct .rtpdesign file on your local machine.

  8. Click the Save button. You will be directed to this template’s page.

  9. From the Output Format drop-down list, select PDF.
    Note: The generation of documents in the DOCX format is deprecated. 

  10. (Optional) Preview the document.

    1. Select a corresponding item in the search-as-you-type field.The preview will appear below.
      Note: The item depends on the selected Template Type, e.g., for a Client Project Confirmation, you can select a project; for Vendor Purchase Order - a job, etc.

  11. (Optional) Check if the template is working correctly.

    1. Select a corresponding item in the search-as-you-type field above the file preview.

    2. In the Test cases section, click the Add Test Case button.

    3. Name the test in the Add new Test Case pop-up window and click the Save button.

    4. Click the (blue star) icon to run the test.

  12. Click the Save or Save and Exit button.


Themes tab

In this tab, you can add or edit the themes used in HTML-based document templates. Themes define the styling of the main body, the header, and the document’s footer. You can predefine multiple themes and their language variants as needed.

Info

To learn how to edit the default view or create a new one, see the Smart views article.

  • To open a theme, click on its line in the list. To open it in edit mode, click the (blue star) icon in the last column. The editing options are described in the Add a theme section below.

  • If you select one or several checkboxes in the left column, additional buttons appear on top of the list of themes.

    • Click the Edit Selected button to Activate or Deactivate themes.

    • Click the Delete button to delete the selected theme (available only when one theme is selected).

Panel
panelIconId1f4a1
panelIcon:bulb:
panelIconText💡
bgColor#E3FCEF

Right-click on the template to open a drop-down menu of the applicable actions.

Add a theme

  1. Click the Add New Theme button. You will be directed to the Themes page.
    Note: To create a new theme based on the existing one, open it in edit mode and click the Copy button in the top right-hand corner.

  2. Give the new theme a name.

  3. Click the Add Theme button.

  4. In the Theme details card, decide whether the new template should be:

    1. Active and thus selectable

    2. a Default one.

  5. In the Theme designer card:

    1. Select the language versions for this theme:

      1. Click the (blue star) to open the language menu and add the desired languages. To close the language menu, click the (blue star) icon again.

      2. Click the (blue star) on next to the language to open a menu of applicable actions.
        Note: If you want to use one theme for all language versions of a certain template, add only one default language. You can add other languages on the template level. 

    2. Create the theme in the Editor section:

      1. In the Theme tab, create the desired elements. To add XTRF tags, click the (blue star) icon. To edit the HTML code directly, switch to the HTML editor.
        Note: Please keep in mind that pasting the copied text in the ‘Simple’ editor will also paste the text styling, which may cause problems for some values (e.g., when checking if the text is equal to other text or when entering Custom Fields "Key" names).

      2. (Optional) In the Styles tab, you can edit the CSS settings for this theme.

        1. (Optional) In the Options tab, you can select custom fonts and background images for this theme.
          Note: Fonts and images for themes can be added in Fonts and Background tabs.

        2. Select a font from the Custom Font drop-down list and decide whether you want to set it for the whole page.

        3. Click on a background image and select whether it should be resized or repeated.

    3. Check the results in the Preview section. Click the (blue star) icon to display the theme or applied changes.
      💡 This section is equipped with several options like pagination, scaling, page-turning, rotating, etc., available in the (blue star) menu.

  6. Click the Save button in the top right-hand corner.

Panel
panelIconId1f4a1
panelIcon:bulb:
panelIconText💡
bgColor#E3FCEF

Click the (blue star) icon to check the details of the theme. Click the (blue star) icon to expand the Theme designer card.


Fonts tab

In this tab, you can add the fonts for templates and themes.

  • To add a new font, click the Select File button and select the desired file on your local machine. You can also drop the font file into the framed area.

  • To delete a font, click the Delete button.


Background tab

In this tab, you can add images that can be used as theme backgrounds.

  • To add a new image, click the Select File button and select the desired file on your local machine. You can also drop the image file into the framed area.

  • To delete an image, click the Delete button.


Notifications

In this subsection, you can manage the e-mail notifications the system sends on different occasions.

Events tab

In the Events tab, you can check which actions or events trigger the notifications and enable or disable the e-mail sending for selected events.

Image RemovedImage Added

By default, all the listed events will trigger the e-mail sending. To disable e-mail sending for the selected event, uncheck the box in the Send E-mail column.


Templates tab

In this tab, you can add and edit e-mail notification templates.

Info

The SMS notifications are deprecated.

  • Edit the default view or create a new one. To learn how to do that, see the Classic views article.

  • Use the filters on the left to narrow down your search.
    💡To use the Type filter, hover over the (blue star) icons between the filters and the table, and drag to the left until the filter field becomes large enough to see the content.

  • Click on the selected notification template to open it in edit mode. Editing options are described in the Add & localize a notification templatesection below.

  • Click the (blue star) icon to delete a notification template. Only the non-default notification templates can be deleted.

  • Check one or several boxes in the left column and click the (blue star) icon in the header to open a drop-down menu of applicable actions:

    • Select or deselect all notification templates.

    • Activate or deactivate the notification templates.

    • Mark or unmark the selected notification templates as preferred.

    • Duplicate a selected notification template. Only the non-default notification templates can be deleted.

    • Provide multiple changes to the selected notification templates.

Panel
panelIconId1f4a1
panelIcon:bulb:
panelIconText💡
bgColor#E3FCEF

Use the Multiple Change option to simultaneously activate or restore the notification templates for several language versions.

Multiple Change - notifications

Expand
titleMultiple change
  1. Select several notification templates and click the (blue star) icon in the column header. You will be directed to the E-mail/Text Message Template - Multiple Change page.

  2. In the Templates to be changed section, check if the correct templates are selected.

  3. In the Properties to be changes section, decide whether you want to:

    • Change the theme

    • Activate or deactivate languages

    • Restore content.

  4. Select the desired values from the drop-down lists.

  5. Click the Confirm button.


Add & localize a notification template

Only four types of notification templates can be added:

  • To a client: When deliverables from one task are sent to the Client

  • To a user:

    • When nobody has approved an availability request

  • To a vendor:

    • When job is started

    • When job is started with previous job partially finished

Info

Only those notification templates can be set as default or non-default. All other notification templates are always the default ones.

The listed templates can be assigned to clients, users, and vendors in the following areas:

  • User, client, and vendor-related - in (blue star) Configuration menu > Projects and Quotes > Workflow Definitions (Classic) > Notifications tab.

  • Client-related - in Client’s profile > Main Data tab > Templates subtab.

  • Vendor-related - in Vendor’s profile > Main Data tab > Templates subtab.

  1. Click the Add button on top of the Templates table. You will be directed to the Add E-mail/Text Message Template page.

  2. Select the desired template’s Type.
    Note: The When external process action is completed template is deprecated.

  3. Select the template’s Theme. To learn more about notification template themes, see theThemes tabsection below.

  4. Decide whether this template should be Active and thus selectable.

  5. Decide whether this template should be a Default one.
    Note: The default templates cannot be deleted.

  6. Provide the template’s Name.

  7. Edit the standard template in the E-mail section using the available formatting options.

    • To add XTRF tags, click the (blue star) icons.

    • Images can be added to the templates through links only. To get a link for an image from your local machine, please upload it in the E-mail Images tab described below.

    • To add a footer, use the ${FOOTER} tag. The footer can be configured in the Footertab, described below.

    • (Optional) Click the Source button to edit the HTML code directly.


      Note: Please keep in mind that pasting the copied text in the default editor will also paste the text styling, which may cause problems for some values (e.g., when checking if the text is equal to other text or when entering Custom Fields "Key" names).

  8. Click the Save button.

  9. (Optional) In the E-mail Preview section on the right, you can check how the notifications will be displayed when the new template is applied. To do so, locate and select any job or task number in the search-as-you-type Job / Task field.

  10. (Optional) Add localized notification templates.

    1. From the Add Localization drop-down list, select the desired language and click the (blue star) icon.

    2. Provide the necessary changes to the template.

    3. Click the Save button.

Info

To restore the content of the notification template, click the Restore E-mail and text message button at the bottom of the page. To restore the content of several templates, use the Multiple Change option described above.

XTRF has several templates already localized for several languages. To check and activate those notifications, open a template and uncheck the Show active only box on the language pane on the left. Then select the desired language and check the Active Language Version box. To activate several languages at once, use the Multiple Change option described above. To delete a language version, click the Delete Language Version at the bottom of the template page.

Note

The Default language of the templates and themes is the language of your Home Portal. You don’t need to activate the localized version of this language, and we recommend against such activating, as it may result in confusing templates.


Themes tab

In this tab, you can add and edit the themes applied to notification templates.

  • Edit the default view or create a new one. To learn how to do that, see the Classic views article.

  • Click on the (blue star) icon to open the selected theme in edit mode. The editing options are described in the Add a themesection below.

  • Click the (blue star) icon to delete a theme.

  • Check one or several boxes in the left column and click the (blue star) icon in the header to open a drop-down menu of applicable actions:

    • Select or deselect all notification templates.

    • Activate or deactivate the notification templates.


Add a theme

  1. Click the Add button on top of the Themes table. You will be directed to the Add E-mail Theme page.

  2. Decide whether this theme should be a Default one.

  3. Provide a Name for the new theme.

  4. In the E-mail Content section, add the necessary elements using the available formatting options.

    • Click the (blue star) icon to add XTRF tags.

    • Images can be added to the themes through links only. To get a link for an image from your local machine, please upload it in the E-mail Images tab described below.

  5. In the Theme style section, define the styles of the elements using the CSS language.

  6. Click the Save button.

  7. (Optional) To delete a theme, restore its original content, or restore the theme style, click the corresponding buttons at the bottom of the page.

Info

Notification themes can be localized in the same way as the notification templates (see the Add & localize a notification template section above).


E-mail Images tab

In this tab, you can upload images for notification templates and themes.

  • To add an image, click the Add files… button and select the file from your local machine.

  • To get a link to an uploaded image file, right-click on the Link and select the Copy link address option.

  • To delete an image, click the (blue star) icon.

You can’t edit an already uploaded image. To change the image in your e-mails, upload a new image file and update the link.

Info

The e-mail images are uploaded using the CP API. In order to use this functionality you need to enable the CP API feature,


Footer tab

In this tab, you can create footers for notification templates and themes in different languages.

  1. Click the Edit button. You will be directed to the Expression - Common E-mail Footer page.

  2. Select the desired language version on the left and provide the content of the footer on the right.

    • To add XTRF tags, click the (blue star) icon.

    • Images can be added to the footer through links only. To get a link for an image from your local machine, please upload it in the E-mail Images tab described above.

  3. Click the Save button at the bottom of the page.

  4. (Optional) To restore the original footer content, click the Restore button at the bottom of the page.


Directories

In this subsection, you can manage the directories for XTRF files on your local server.

Panel
panelIconId1f4a1
panelIcon:bulb:
panelIconText💡
bgColor#E3FCEF

The path to directories is displayed in the Definition column.

Info

Only the on-premise clients can edit the Directories subsection. For on-cloud clients, this subsection is for informational purposes only.

Project Directories tab

In this tab, you can manage the folders where the project-related files are stored.

  • Edit the default view or create a new one. To learn how to do that, see the Classic views article.

  • Click on the selected directory to open its page. Click the (blue star) icon to open it in edit mode. The editing options are described in the Add a directory section below.

  • Click the (blue star) icon to delete a directory.

Add a directory

  1. Click the Add button on top of the Directories table. You will be directed to the Add Directory page.

  2. Name the new directory.

  3. Select the directory Type from the drop-down list.

  4. With the Relative to Home checkbox, decide whether this new directory should be located in the main XTRF directory on your server. If this box is unchecked, you can provide the custom path in the Creation Rule field.

  5. In the Creation Rule field, create a path to the directory and customize the folder names with the tags available below.

  6. Click the Save button.


Client Directories tab

In this tab, you can manage the folders where the client-related files are stored. For details, see the Project Directories tab section above.


Vendor (Provider) Directories tab

In this tab, you can manage the folders where the vendor-related files are stored. For details, see the Project Directories tab section above.


Quote Directories tab

In this tab, you can manage the folders where the quote-related files are stored. For details, see the Project Directories tab section above.


Workflow Directories tab

In this tab, you can manage the folders where the workflow-related files are stored. For details, see the Project Directories tab section above.


All Directories tab

In this tab, you can manage all the directories available in the system. For details, see the Project Directories tab section above.


Files

In this subsection, you can edit the way documents created by XTRF are named and stored.

File Locations tab

In this tab, you can check or change how the document files are named and where they are stored.

Image RemovedImage Added

  • To make any changes, click the Edit button at the bottom of the page. An Edit button will appear in every section.

    Image RemovedImage Added

  • To store specific document files in a different directory, select another option from the drop-down list. The list of available directories depends on the document type. If you don’t want to store those documents, select the Do not save option.
    To learn more about directories, see the Directoriessection above.

  • To edit the selected directory, click the Edit button in the same section. You will be directed to this directory page (for more details, see the Add a directory section above).

  • To edit the expression used for naming document files, click the Edit button in the same section. You will be directed to this expression page (for more details, see the Add an expressionsection below).

  • To confirm the changes, click the Save button at the bottom of the page.


Filenames tab

In this tab, you can check or change how the documents created in XTRF are named. The creating rule is displayed in the Template column. To edit the naming expression, click the (blue star) icon. To learn how to create and edit expressions, see the Add an expressionsection below.


Numbering Schemes

In this section, you can check and change the way the entities in XTRF are numbered.

  • Edit the default view or create a new one. To learn how to do that, see the Classic views article.

  • Use the filters on the left to narrow down your search.

  • Click on the selected numbering scheme to open it. Click the (blue star) icon to open it in edit mode.

  • Check one or several boxes in the left column and click the (blue star) icon in the header to open a drop-down menu of applicable actions:

    • Select or deselect all numbering schemes

    • Select all invoice-related schemes

    • Select all project-related schemes

    • Restore the default content of the selected schemes.

Note

While creating or editing a numbering scheme, make sure that the values you provide exclude the possibility of creating entities with the same numbers or IDs. Otherwise, some XTRF functions may stop working, e.g., the project creation will be blocked if a project with the same ID already exists in XTRF.

Add a numbering scheme

Info

You can add only the invoice-related numbering schemes:

  • Client invoice numbering scheme

  • Client pro forma invoice numbering scheme

  • Credit Note numbering scheme

  1. Click the Add button on top of the Numbering Schemes table. You will be directed to the Add Numbering Schemes page.

  2. Provide a Name for the new numbering scheme.

  3. Select the correct Type from the drop-down list.
    Note: After you select a type, the fields below will be filled with the default values.

  4. (Optional) Provide a custom Counter Name for the counters used in this scheme.

  5. In the Counter Evaluation Rule field, decide when the counter should be reset using the Available Tags for Counter Evaluation Rule below.
    ______________________________________________________________________________________________________________________________________________

  6. In the Identifier Evaluation Rule, provide the actual numbering scheme using the Available Tags for Identifier Evaluation Rule listed below and custom wording. For example, if you enter XTRF-${customerInvoice.year}/${counter.nextValue}, the invoices will be ID'ed as XTRF-2023/1, XTRF-2023/2, etc.

  7. Click the Save button.


Edit a numbering scheme

  1. Open a numbering scheme in edit mode. Most of the settings are described in the Add a numbering scheme section above.

  2. Decide whether this scheme should be a Default one.
    _________________________________________________________________________________________________________________________________

  3. (Optional) Click the Test button to check how the entities will be numbered according to this scheme.

  4. (Optional) Click the Show Values button to check the actual values of the related counters.

    • To change the counter’s value, click the (blue star) icon and provide the desired value.
      💡 You can edit the counter value to fill in the numbering gaps that sometimes occur after an entity is deleted from the system. Please, avoid creating entities with the same numbers, as this will disrupt the system.

  5. (Optional) Click the Restore Defaults button to revert to this numbering scheme's default settings and values.

  6. Click the Save or Save and Exit button.


Expressions

In this section, you can manage the expressions, i.e., rules for naming different entities throughout the system.

  • Edit the default view or create a new one. To learn how to do that, see the Classic views article.

  • Click the (blue star) icon to open the selected expression in edit mode. The editing options are described in theAdd an expressionsection below.

Add an expression

Info

You can add only a File rename rule expression. To change another type of expression, open it in edit mode.

  1. Click the Add button on top of the Expressions table. You will be directed to the Add Expression - File rename rule page, already filled with default values.

  2. (Optional) Add Localized Values to this expression (for details, see the System Values: Basic - Add localized values article).

  3. In the Template field, enter the desired expression template using tags available on the right and/or custom wording.

  4. Click the Save button.

Easy heading
linkText4
linkText3
linkText10
linkText3
linkText6
linkText5
relatedLinksLabels
linkText2
linkText1
headingTagsH1,H2,H3,H4
linkText1
sidebarMaxHeight
650
500
linkType2Page
linkType3Page
linkType1Page
linkType10Page
sidebarTitle
Templates
TEMPLATES
linkUrl3
linkUrl4
linkUrl1
linkUrl2
linkUrl10
linkText8
linkText7
relatedLinksOrderLabels_First
linkText7
sidebarModeOpened
headingNumberingModeNo_Numbers
linkText9
sidebarMarginRight20
relatedContentIds
relatedLinksTargetNew_Window
linkUrl9
relatedLinksTitleRELATED LINKS
linkUrl9
linkUrl7
linkUrl8
linkUrl5
numberedHeadingTagsH1,H2,H3
linkUrl5
linkUrl6
linkType8Page
linkType9Page
linkType6
Page
headingLinkTextModeWrap
linkType7
linkType6Page
linkType4
linkType7Page
linkType5
linkType4Page
sidebarWidth350
linkType5Page
sidebarTop160
headingLinkExpandModeExpand_All_By_Default
headingLinkIndent10