Custom field types

This topic provides a reference for the field types supported in the Polarion Custom Fields configuration. You can assign any of these types to a custom field.

Basic types

  • String (single line)

  • Text (multiple lines)

  • Rich Text (multi-line rich text)

  • Integer

  • Float

  • Currency

  • Time

  • Date

  • Date time

  • Duration

  • Boolean

  • Enum: (An existing Enumeration must be selected. See: Configure Enumerations.)

  • Test Steps (Renders a table of Test Steps in Work Items of the selected type.)

Tip:

Check out the custom field and enumeration configurations in the demo projects included in product distributions.

Enumeration types

The following enumeration types encapsulate data from the Polarion portal into lists, which can be specified as the value for Enum type custom fields.

  • ID - The type ID which can be referenced in scripts and API calls.

  • UI Name - The type Name that appears in the pick list for Enum type custom fields in the Custom Fields editor in Administration.

  • Data - Data encapsulated by the type. Parameters are referenced in parentheses in scripts or API calls, as shown, and in labeled text box widgets in the Custom Fields configuration user interface.

ID

UI Name

Data

@build

Build

When no query is specified, all builds visible in the current project.

@build[QUERY]

Build

All builds found by the query (using Lucene syntax) specified in the Query text box (or the QUERY parameter).

@category

Category

All Categories configured for the current project.

@document

Document

When no query is specified, all LiveDoc Documents visible in the current project.

@document[QUERY]

Document

All LiveDoc Documents found by the query (using Lucene syntax) specified in the Query text box (or the QUERY parameter).

@plan

Plan

All Plans in the project. Not user-sortable.

@plan[QUERY]

Plan

All Plans found by the query (using Lucene syntax) specified in the Query text box (or the QUERY parameter)

@project

Project

When Project Group is not specified, all active projects in the system.

TotalPages

$[total]

Total number of pages in the PDF document.

PolarionProductName

$[productName]

Name of the Polarion product used to export the PDF document.

PolarionVersion

$[productVersion]

Version of the Polarion product used to export the PDF document.

ProjectId

$[projectId]

ID of the project from which the content was exported to PDF.

ProjectName

$[projectName]

Name of the project from which the content was exported to PDF.

Space

$[space]

System ID of the space from which the content was exported to PDF.

SpaceTitle

$[spaceTitle]

Title of the space from which the content was exported to PDF.

Created

$[created]

Date when content was created in Polarion.

CreatedBy

$[createdBy]

User name of the user who created the content in Polarion.

Updated

$[updated]

Date when the content was past updated in Polarion .

UpdatedBy

$[updatedBy]

User name of the user who last updated the content in Polarion.

Generated

$[generated]

Date when the PDF document was exported.

GeneratedBy

$[generatedBy]

User name of the user who exported the content to PDF.

revision1

$[revision1]

For use when exporting revision comparison of a Document to PDF. This renders the revision number of the older of 2 compared revisions.

revision2

$[revision2]

For use when exporting revision comparison of a Document to PDF. This renders the revision number of the newer of 2 compared revisions.