Class PageCustomNames
java.lang.Object
com.polarion.alm.tracker.exporter.configuration.PageCustomNames
Enables the possibility to set up a custom filename for the result of a PDF export.
Different names can be specified for different object types.
The custom filename must be placed within a tag that represents its object type (
Example of how to define custom names for Documents and Rich Pages together with variables:
PageCustomNames.ExportObjectType
), otherwise it will not be used.
The filename can make use of certain supported variables.
Example of how to define custom names for Documents and Rich Pages together with variables:
<filename>
<document>my_requirements_$[revision].pdf</document>
<richpage>widgetset_$[space]$[createdBy]</richpage>
</filename>
There is also an option to define a custom space replacement for spaces in case they are not wanted in filenames,
since some variables may return values containing them. You can use the attribute "spaceReplacement" in the "filename" tag and add
one or more characters that will replace each of the spaces encountered in the processed filenames. You can also override
the "spaceReplacement" value in "filename" by a "spaceReplacement" value defined in a specific object tag:
<filename spaceReplacement="_">
<document spaceReplacement="-">my_requirements_$[updatedBy]</document>
<richpage>widgetset_$[space]$[createdBy]</richpage>
</filename>
- Since:
- 3.22.2
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static enum
Names of these object types are used as tags in the XML configuration for PDF export. -
Method Summary
Modifier and TypeMethodDescriptionstatic PageCustomNames.Builder
create()
Creates an empty builder.Creates a builder with the prefilled values from the current instance.name
(PageCustomNames.ExportObjectType objectType) names()
spaceReplacement
(PageCustomNames.ExportObjectType objectType)
-
Method Details
-
names
-
name
-
defaultSpaceReplacement
- Since:
- 3.23.4
-
spaceReplacement
- Since:
- 3.23.4
-
create
Creates an empty builder. -
createCopy
Creates a builder with the prefilled values from the current instance.
-