Tagging and Report Generation Issues

Owned by Sebastiano Mussi
Last updated: Apr 17, 2024 by Nomsa Chirwa
12 min read

#

Tagging and Report Generation Issues

Answer

#

Tagging and Report Generation Issues

Answer

301

When generating an XBRL report, the error "Your report is not valid..." is displayed.

This message is displayed if the report is missing some mandatory mappings or has mapping inconsistencies (to be seen Status button in the left bottom corner). Please correct all errors (those having a red X before the message) and then generate iXBRL. However, it is possible to generate an XBRL file - but generation may fail with errors.

302

It is not possible to create Taxonomy extensions, the icon is deactivated.

You need to enable taxonomy extensions in the Document Settings, as shown below:

303

After converting a Word Document to iXBRL some pages are missing and there are no page breaks. 

MS Word does not always save all page breaks to the DOCX file, so the Tagger does not know where a page ends and another starts. To fix this, a Macro in Word developer tools can be run, which will make sure that all page breaks are properly included. To run a Macro, open the Word Document and open the Macro Editor (either click ALT+F11 or go to the developers tab end click on "Visual Basic").

In the Visual Basic editor window, copy&paste the macro from below and click "Run" (for more information see MS Word Macro Documentation).

Sub tryUnlinkFields() On Error GoTo fehler: ActiveDocument.Fields.Unlink Exit Sub fehler: 'Einzeln versuchen Dim i As Integer For i = ActiveDocument.Fields.Count To 1 Step -1 ActiveDocument.Fields(i).Unlink Next End Sub Sub edgarizingPreProcessing() Debug.Print "Start: " & Now 'Wichtig, weil sonst Seitenumbrüche innerhalb von Feldern schief sein können. tryUnlinkFields Dim lastPage As Range Selection.GoTo wdGoToPage, wdGoToLast Set lastPage = Selection.Range Dim r As Range Selection.GoTo what:=WdGoToItem.wdGoToPage, which:=WdGoToDirection.wdGoToFirst Set r = Selection.Range 'r.Comments.Add r, "Das ist Seite 1!" 'Debugging-Code ActiveDocument.Bookmarks.Add "SN_PAGEBREAK_1", r Dim counter As Integer counter = 2 While r.Start < lastPage.Start Selection.GoTo what:=WdGoToItem.wdGoToPage, which:=wdGoToNext Set r = Selection.Range 'r.Comments.Add r, "Das ist Seite " & counter & "!" ActiveDocument.Bookmarks.Add "SN_PAGEBREAK_" & counter, r counter = counter + 1 Wend Debug.Print "End: " & Now End Sub

304

When loading a Word file, the error "... there need to be at least one paragraph formatted as headline" is displayed.

 

Please go to the Word file and add at least one headline (work with Styles):

Please make sure that the headline style is defined correctly:

Go to Styles → Modify

Select Format → Paragraph:

Make sure you work with levels: the outline level is not Body Text:

After that save and load the document again.

305

The Tagger does not display the headlines defined in the Word file.

 Instead of defined in Word:

Please make sure that the headline style is defined correctly:

Go to Styles → Modify

Select Format → Paragraph:

Make sure you work with levels: the outline level is not Body Text:

Save the changes and load the document again. The correct headlines are displayed:

 

306

Why can’t I tag a table in a PDF document (table selection is grey)?

Before tables from PDF documents can be tagged, please perform the steps documented here.

307

Why doesn`t my converted PDF file look good?

The limitations of the PDF converter are the following:

  1. CID (identity H) fonts embedded to the source document.

    1. In this case, the converted document can contain unreadable (weird looking) text. To resolve this it is recommended to save the source document as PDF/X format in the Adobe Acrobat DC "Print Production" tool. 

  2. If the converted document has wrong color palette see step 1.

  3. The converter does not support PDF hidden text layers.

    1. If so, you should remove hidden text layers in the Adobe Acrobat DC "Redact" tool.

  4. The converter has fine tuning options helping to resolve the issues:

  1. Please, change the option "PDF unicode CMaps handling" to "Auto" and "Use autohint on fonts without hint"to "Use AutoHint" if the converted document does not resemble the original.

If the conversion still doesn't meet the expectations or some tables cannot be tagged properly, the source file might need corrections. 

The following cases are known:

  1. The converted PDF looks good, but the imported table is unreadable.

  2. The converted PDF contains unreadable fragments.

  3. The PDF document has not been converted at all in the Tagger.

  4. The converted PDF shows wrong colors, visual artifacts or extra
    text fragments or pages.

For cases 1-3, there are two procedures you can use to repair the document in Adobe:

  1. Export the PDF to postscript and create a new file from it in Adobe Acrobat Distiller DC.

  2. Convert the PDF to the stadard PDF 1/A with Adobe Preflight in the "PDF standards" tool.

For case 4, use "Sanitize Document" in the "Redact" tool and convert the document to PDF/X for correct colors.

If the document, after having performed all the above recommended procedures, still has artifacts, the "fallback mode" option in the Tagger can be used.

308

The Tagger raises InvalidCalculation issues, even if the values are adding up exactly.

The reason is that the XBRL report will have an accuracy setting. In the example on the left, the values are reported in millions, but with one decimal place. It is required to incease the accurracy of the XBRL facts by setting the decimal attribute to -5 (millions with one decimal place) instead of minus -6 (millions). To change the decimals settings, please open "Document" menu and click on "Settings" and then "Advanced settings" tab.

309

I have tagged one language version of my report, how can I transfer my tags to another language version?

When transferring the tags from one language version to the other, a few things have to be considered:

  1. Open the tagged report in the Tagger and open a second Tagger windows with the translation report.

  2. Enter the same basic settings under Document Settings, but adjust the report language drop down.

  3. Copy & paste the tags from the original report to the translation version using the Clipboard Manager.

  4. Make sure, all extensions have at least one standard label in the report language.

  5. Ensure that all number formats are correct.

  6. Apply the Packaging and Publishing of ESEF iXBRL Reports checklist, and review if all numbers are converted properly in the preview.

310

The tagged tables are not displayed in the Table Preview/are displayed under one role.

When you generate the Table Preview, the XBRL Tagger displays every tagged table in the dropdown.

If this is not the case and your tables (Income Statament; Cashflow Statement etc.) are not to be found, please make sure that every tagged table has a corresponding name under Table Properties:

  • Go to Table Tagging tab

  • Click on Table Settings symbol:

  • Add the name of the table:

311

Presentation Linkbase: the order of the individual items within a statement does not match the order in the pdf/Word file.

When you generate the Table Preview, the XBRL Tagger displays every tagged table in the dropdown.

Here you can check if the order of individual items within a statement is correct and matches the order in the pdf/Word file:

If this is not the case, please make sure that:

312

How can I convert an PDF or Word Document to XHTML without tagging?

Start the Tagger and click on "Convert to XHTML" in the "Tools" menu. Select the file and click on "Create XHTML Document".

313

When using the Word converter, some text is jumping between the page breaks. How can I fix this?

This type of position is not supported by the converter and has to changed in the Word file. The text from the free floating box should be added as normal text to the footer, so that it just contains to lines. 

314

When using the Word converter, sometimes text from the footer and the page number are not positioned correctly. How can I fix this?

The issue is the same as #313, with free floating text not being able to be converted correctly. In these cases, try to use tables with invisible borders to position items correctly in the footer:

 

315

Why does my iXBRL report have hidden facts?

When converting and tagging a PDF report with special font face in the XBRL Tagger, some facts (tags) might become hidden. The reason is, that the Inline XBRL Specification does not allow individually formatted numbers to be tagged. E.g. when the font requires a special spacing between single characters by using HTML tags like <span>, the number is no longer taggable. In the screenshot below, the number 24,540 is not taggable. In order to preserve the spacing and formatting of the PDF in the XHTML report, the XBRL Tagger moves the tag to an unformatted hidden section of the document and includes a link to the visual original number.

However, hiding facts is an official mechanism of the Inline XBRL specification, as well as allowed by ESMA in the ESEF Reporting Manual, page 34:

From AMANAs point of view, untaggable items like the numbers in the example above are not eligible for transformation and can be hidden. The XBRL International standard setter working group is aware of the issue and will probably publish and update Inline XBRL specification, which will make those numbers taggable in the future.

Please continue reading about how to reduce the number of hidden facts in FAQ .

316

How can I reduce or avoid hidden facts in my iXBRL reports?

There are multiple ways to avoid or reduce hidden facts in iXBRL reports:

  • Tag Microsoft Word files instead of PDFs

  • Do not use special non-web fonts in PDF reports, that provide a special spacing between characters.

  • Set the XBRL Tagger CMaps option to "Ignore" when opening a PDF file (might lead to uglier reports).

  • Use the latest XBRL Tagger version 1.7, which includes some new options to reduce/avoid hidden facts.

  • All numbers that are tagged needs to have the OpenType setting “Default figure Style” to avoid “Hidden facts”. This setting only effects the digits in the report.
    To apply this setting you can manually choose “Default Figure Style” in the number columns or you can apply the setting in the Paragraph Style under “OpenType features”. Use 0 kerning in the tagged cells for best result.

  • Other problems that can occur when you convert the PDF to XHTML is:

    • Text opacity If you have a text with opacity in the document the opacity will go back to default 100% after the conversion to XHTML. It will work if you create outlines of the text.

    • Text behind If you have text hidden behind something in InDesign the text will be visible when you convert to XHTML.

  • We also reccomend to check out Best Practice Section for InDesign: https://amana.atlassian.net/wiki/spaces/XBRLI/pages/20415427/Requirements+for+Source+Documents#How-to-Prepare-a-PDF-File-using-InDesign-(Best-Practices)

317

How can I change the layout setting for Word?

Document View Type:

It is now possible to define the view type for converted Word documents. The available options are FullScreen, Manuscript and Pages. Just try them out to see what fits your report best.

  • FullScreen: corresponds to the old setting WITHOUT activated "Use A4 layout for Word" (unpaginated layout).

  • Manuscript: this is the new mode. It is also unpaginated, but the text is limited to the page width set in the WORD file.

  • Pages: the same as WITH the checkmark "Use A4 layout for Word" set.

318

Settings of @escaped attribute: True/False.

From Tagger version 1.10, the Escape-Attribute for text blocks in the text block properties is set to "true" by default.

All text block tags can be given an @escaped attribute that controls whether the XHTML tags should be included in the XBRL instance document or not. By default, the escaped attribute is set to False, according to Guidance 2.2.6 of the ESEF Reporting Manual (page 33). Changing it to True is not necessary, but is recommended by some auditors. 

When the escaped attribute is set to True, some iXBRL viewers display the tag contents with more spaces. However, this depends on the iXBRL viewer used and is by no means standardized. For example: 

Should you wish to change all escaped attributes for tagged elements already set to False (or vice versa), you need to do this by editing every individual tag. 

319

How can I add more than 20 layers in the Tagger?

From XBRL Tagger version 1.9.10 you may only create up to 10 layers. If you create more, this can sometimes lead to report generation issues. 

To increase the number of allowed layers "at your own risk", you may follow the steps below:

  1. Open Tagger folder (This PC→ Local Disk→ User Name→ AppData→ Roaming→ AMANAconsulting)

  2. Open tagger.settings

  3. Add <MaximumLayers>22</MaximumLayers> to the script (the number 12 represents the number of layers that can be created, you may increase this to your preference).

  4. Save and re-open the Tagger.

320

Why does the XBRL Tagger ask me to download pdf2htmlEx?

In order to convert a PDF document to XHTML and keep all formats, AMANA recommends to use a third-party XHTML converter, called pdf2htmlEx. This converter is published under GPL v3 and free to use. However, it can't be distributed with the XBRL Tagger, so users are requested to install it themselves. AMANA forked the converter and published a version under the GPL v3 version here:

https://github.com/amanaconsulting/pdf2htmlEX

In order to install the pdf2htmlEx converter, please download pdf2htmlEx ZIP file under "Releases" and extract it to %appdata%\AMANAconsulting folder, like in this sample:

C:\Users\user.name\AppData\Roaming\AmanaConsulting\pdfToHTMLEx\{version}\

With {version} being the current release tag from github, i.e. "0.14.8-win" 

The XBRL Tagger does not link this binary in the source code, but rather calls the converter via command line and returns the resulting XHTML to the XBRL Tagger for tagging purposes.

You can find additional information on the installation process here.

321

How do I tag two currencies in one report?

You have the possibility to tag multiple currencies in one table. The first step is to adjust the Table Settings. (See here for more details)

  1. Set the Disable automatic Related Cell Tagging option to True.

  1. In the table, select a specific tagged cell, then go to Properties and adjust the unit to the desired currency.

 

322

Why the HTML <Table> Tags in the Textblock Section not visible in the preview section when it has been placed in the tagger.

To fix this issue, make sure that the tags defining the text blocks, which includes the table, fully enclose the entire table within the text block selection.

This may be related to How to Tag HTML <Table> Tags in the Textblock Section of PDF Documents.