Customers
User information
 Loading ...
Show article in Knowledge Base

 How to create Export templates Export knowledge base Export     SubscribeSubscribe      Show article info

In VisionProject you can export issue data into pre-created template documents.
Read more on how to use this functionality when it already is in place: Export issue data into an Export template

 

 

In this article below you can learn how to create an Excel or MS Word document, for exporting data into a template.

Create the base of the Export Template

Excel

Create the document with the look and feel you want it to have. Where you want to populate fields you need to use the same velocity variables as we use in the notification templates.

For example:
$!projectIssue.name
$!reporter.name
$!currentOwner.name

 

Read more about the variables you can use further down in this article.

 

Simply cut and paste variables into place in the document.

Save as  .xls or .xlsx.

 

Word

Create the document with the look and feel you want it to have. Where you want to populate fields you need to use the same velocity variables as we use in the notification templates.

For example:
$!projectIssue.name
$!reporter.name
$!currentOwner.name

 

Read more about the variables you can use further down in this article.

 

Add the variables to the document:

  1. Put the cursor where you want to add a variable.
  2. Press Ctrl+F9.
  3. Right click and > Edit Field
  4. In the drop down Field names scroll down and choose the option MergeField
  5. Add the Velocity variable in the field Field name
  6. Press OK

Include Velocity variable in Word

 

In the Word document it will now look like this and this is where the name/title of the issue will show up after the export:

Inserted Velocity variable in word

 

Save as  .doc or .docx.

 

 

Activate the functionality in your system

  1. Go to the project > Settings > General > General issue settings
  2. Make sure the box "Enable issue export using templates" is selected.
  3. Save. 

Name and upload the Export template to VisionProject

If you only have one template document for each project:

  1. Name the document exporttemplate (.doc/.docx/.xls/.xlsx)
  2. Upload the document in the root folder under the project > Documents

 

If you have more than one template document for one single project:

  1. Name the documents with a describing name
  2. Upload the documents into a folder named Export templates which is in the root under the project > Documents

 

Velocity variables in Export templates

VisionFlow uses a templating language called Velocity for generating dynamic text content. These variables are used both in the notification templates and in the export template documents.

 

Standard field variables

Below is a list of some standard Issue field variables:

$!projectIssue.issueKey 
$!projectIssue.ticketId 
$!projectIssue.name 

$!projectIssue.issueType.name 
$!projectIssue.issueStatus.name 
$!projectIssue.issueSeverity.name 

$!projectIssue.issuePriority.name

$!projectIssue.dueDate

$!projectIssue.modifiedDate

$!projectIssue.createdDate

 

 

Below is a list of some standard Project field variables:

$!projectIssue.project.name

 

 

Below is a list of some standard Reporter field variables:

$!reporter.name

$!reporter.email

$!reporter.phone

$!reporter.cellPhone

$!reporter.gender

$!reporter.title

 

 

Below is a list of some standard Owner field variables:

$!currentOwner.name

$!currentOwner.email

$!currentOwner.phone

$!currentOwner.cellPhone

$!currentOwner.gender

$!currentOwner.title

 

 

Below is a list of some standard ReporterCompany field variables:

$!reporterCompany.customerName 
$!reporterCompany.customerNumber 
$!reporterCompany.entityStatus.name 
$!reporterCompany.type 
$!reporterCompany.address1 
$!reporterCompany.address2 
$!reporterCompany.state 
$!reporterCompany.zipCode 
$!reporterCompany.city 
$!reporterCompany.country 
$!reporterCompany.phone 
$!reporterCompany.faxNumber 
$!reporterCompany.webAddress 
$!reporterCompany.contactPerson 
$!reporterCompany.emailAddress 

 

Custom field variables

How do I include Issue custom fields in my template:

 

Use the format $!projectIssue.companyCustomFieldXX

Go into the issue configuration and click on the blue "?" by the field in question and replace the XX in the above format with the Index number.

 

How do I include Reporter custom fields in my template:

 

 

Use the format $!reporter.systemUserGenericCustomFieldVO.textField1

Use the format $!reporter.systemUserGenericCustomFieldVO.textField2 

Use the format $!reporter.systemUserGenericCustomFieldVO.textField3 

 

And so on...

 

 

How do I include Owner custom fields in my template:

 

Use the format $!currentOwner.systemUserGenericCustomFieldVO.textField1

Use the format $!currentOwner.systemUserGenericCustomFieldVO.textField2 

Use the format $!currentOwner.systemUserGenericCustomFieldVO.textField3 

 

And so on...

 

 

How do I include ReporterCompany custom fields in my template:

Use the format $!reporterCompany.customerGenericCustomFieldVO.textField1

Use the format $!reporterCompany.customerGenericCustomFieldVO.textField2 

Use the format $!reporterCompany.customerGenericCustomFieldVO.textField3 

 

And so on...

 

Other variables 

$!today

This is used to access today's date

 

$ViewHelper

The ViewHelper is an object that can be called to format dates in different formats. For example the following can be used to get today's date in the format "yyyy-MM-dd":

 $ViewHelper.getDateWithStringFormat($today, "yyyy-MM-dd")

 

If you would like to print the dueDate of an issue in the same format you would use:

$ViewHelper.getDateWithStringFormat($!projectIssue.dueDate, "yyyy-MM-dd")

 

 

Need more help?

Read more about Velocity here: http://velocity.apache.org/engine/devel/user-guide.html.

VisionFlow also has all its text in resource files, and can retrieve these texts by referring to key values.

 

If you need any further variables that you can not find please contact support@visionera.se.

 

If you want our design team to create a template for you please contact support@visionera.se for more information and a quote.

 


User comments
 Loading ...