Page tree

This documentation relates to an older version 5.2 of the Structure for Jira. Visit the current documentation home.

Skip to end of metadata
Go to start of metadata

Export renderer provider module lets you register the components responsible for exporting Structure columns to printable HTML and Microsoft Excel formats.

Export renderer provider example

<structure-export-renderer-provider 
     key="erp-sbcolumn-excel" 
     name="export-renderer:Status Bar Column Excel Provider"
     class="com.almworks.jira.structure.sbcolumn.StatusBarExcelProvider">
 
  <column-key>com.almworks.jira.structure.sbcolumn</column-key>
  <export-format>ms-excel</export-format>
</structure-export-renderer-provider>

Element

Required?

Description

structure-export-renderer-provider

Yes

The module descriptor.

@key

Yes

The unique identifier of the plugin module.

@name

No

The human-readable name of the plugin module.

@class

Yes

The class that implements the renderer provider. Must implement ExportRendererProvider.

column-key

No

The column key that this provider is associated with. You can have multiple column-key elements in a single descriptor. If no column key is specified, the renderer provider is considered generic – such a provider will be consulted for every column not served by a type-specific provider.

export-format

No

The export format that this provider is associated with. The values are printable for the printable HTML format and ms-excel for the Microsoft Excel XLS format. You can have multiple export-format elements in a single descriptor. If no export format is specified, the renderer provider is considered generic – such a provider will be consulted for every column not served by a format-specific provider.

  • No labels