Overview

When you upload a new version of an already tagged Word or PDF document via Import new file version, the XBRL Tagger automatically carries the existing tags over to the new document version (roll-forward). Before these changes are permanently applied to the document, the Tag Update Preview opens automatically. There you can review all the tags that were carried over and decide whether to apply the changes, edit them individually, or discard them.

If not a single tag could be carried over during the roll-forward of a PDF document, the Tag Update Preview does not open. Instead, a corresponding message appears. In this case, the document remains unchanged in its previous version.

Only one Tag Update Preview can be open for a document at a time. As long as a preview has not yet been completed, opening the document takes you back to the Tag Update Preview automatically, and no further new file version can be imported for this document.

The following sections describe the structure and functions of the Tag Update Preview in XBRL Tagger.

The header of the Tag Update Preview contains the following areas:

  • The status bar, which shows which document the tags come from and which document they are being migrated to: "Tags from [source document] will be migrated to [target document]".
  • The toolbar with buttons for discarding, closing, and applying the preview.
  • The progress display with the number of tags still pending, already approved, and removed, plus a progress bar showing the overall review progress as a percentage.
Shows the header of the 'Tag update preview' in Lucanet XBRL Tagger with the breadcrumb 'Dashboard / Settings-Test-DE / Tag update preview', the status bar 'Tags from Settings-Test-DE will be migrated to Showcase-file-ESEF1-1-.docx', the 'Discard changes', 'Close', and 'Apply to the document' buttons, the counters '1 pending', '0 approved', and '1 removed', and the 'Review progress' bar at '50%'.
Header of the Tag Update Preview

Use the following functions to adjust the Tag Update Preview to your needs:

  • The Text tagging and Table tagging tabs determine whether the change list and the document view show changes to text content or to tables.

  • In the Old file/New file/Mixed view group, you choose which version of the document is shown in the document view:

    • Old file: shows the previous document version.
    • New file: shows the new document version with the changes that were carried over.
    • Mixed view: shows the previous and the new version of a changed section directly one below the other for comparison.
Shows the 'Old file', 'New file', and 'Mixed view' buttons of the Tag Update Preview in Lucanet XBRL Tagger. The 'New file' button is selected.
Functions for displaying the desired version of the document
  • The checkboxes under Show let you show or hide the Document view and Fact Properties areas individually.

The Tags checkbox is enabled by default and is available in addition to these; the change list itself remains visible regardless of it.

The change list on the left shows the tags carried over during roll-forward and tags that could not be transferred to the new document version. Each entry in the change list shows:

  • The affected text passage or table element.
  • The assigned taxonomy concept and the technical element.
  • An indicator of the type of change (e.g. Modification for a content change, or Removal if an element is no longer present in the new document version).
Change list in the Tag Update Preview
Change list in the Tag Update Preview

Use the checkboxes to the left of the entries to select one or more entries, or Select all to mark the entire list.

Use the drop-down list to the right of an entry to set whether that tag should be approved, rejected, or set to pending.

The following actions are available:

ActionDescription
ApproveSets the selected entries to approved. Applying the preview accepts the proposed change. For a Removal, you accept that the tag is not included in the new document version.
RejectSets the selected entries to removed. A carried-over change is not transferred to the document when you apply the preview. If you instead reject the removal of a text tag, XBRL Tagger adds the tag's mapping to the clipboard for manual reuse when you apply the preview.
PendingResets the selected entries to pending. You must approve or reject these entries before you can apply the Tag Update Preview.

Use the search field above the list to search specifically for a tag name or an element ID.

To reuse a text tag marked as a Removal during roll-forward in XBRL Tagger, select Reject for that entry. Complete the remaining review decisions, then select Apply to the document. Only then does XBRL Tagger add the text tag's mapping to the clipboard. Close alone does not transfer any mappings.

Then open the document and the Clipboard panel to assign the mapping manually to a suitable passage. Rejecting a removal does not automatically restore the original text in the new document version. A notification shows the number of tags added to the clipboard. For more information, see Reusing Mappings with the Clipboard.

This reuse applies to removed text tags, not to removed tables or table rows. For a text tag with multiple continuation parts, XBRL Tagger creates a single clipboard entry if you rejected the removal of every part. If a part remains in the document, XBRL Tagger creates no additional entry for the lost part.

Click the Legend button in the top-right corner to open a window that explains the colour coding of the highlights in the document view.

Legend button of the Tag Update Preview
Legend button of the Tag Update Preview

The colours have the following meaning:

ColourMeaning
GreenThe change has been approved.
YellowThe content was shortened or extended and still needs to be reviewed.
RedThe element is no longer present in the new document version.

The document view in the middle shows the document as read-only, in the version you selected in the Old file/New file/Mixed view group (see Adjusting the View).

Changed text passages and tables are highlighted in colour and marked with the Changed label as well as the tag's current review status (e.g. "Pending"). Use the zoom controls in the top-right corner of the document view to zoom in or out.

Highlighted change with the "Changed" label in the document view
Highlighted change in the document view

The document view is a reduced, read-only variant of the document viewer and is also used in the review window to review AI tagging suggestions (see Reviewing AI Tagging Suggestions).

When you click an entry in the change list or the document view in XBRL Tagger, XBRL Tagger displays the Fact properties panel on the right with detailed information about this tag. The Fact properties panel in XBRL Tagger displays the following properties:

  • XBRL element: the full taxonomy URL of the assigned concept
  • Change type: the type of change, for example "Changed"
  • Review status: the tag's current review status, for example "Pending"
  • Old value and New value: under Changed value, the previous and the new value of the element with the number of characters, if available. Show full value displays the complete values.
  • All unchanged properties: lists the properties of the tag that have not changed
Shows the tag update preview in Lucanet XBRL Tagger with the 'New file' view selected and the 'Fact properties' panel for a changed tag. The panel shows the 'XBRL ELEMENT' 'https://xbrl.ifrs.org/taxonomy/2024-03-27/ifrs-full:NameOfReportingEntityOrOtherMeansOfIdentification', the 'CHANGE TYPE' 'Changed', the 'REVIEW STATUS' 'Pending' and, under 'Changed value', the 'OLD VALUE' and 'NEW VALUE' with '1,028 characters' each, followed by 'Show full value' and 'All unchanged properties (14)'. Highlighted in red is the 'Fact properties' panel.
Fact properties for a change

The following buttons are available in the header to edit and complete the Tag Update Preview in XBRL Tagger:

  • Discard changes: Deletes the entire Tag Update Preview. Since this action cannot be undone, a confirmation dialog appears beforehand, noting that the roll-forward changes will be discarded and the document remains unchanged.
  • Close: Takes you back to the dashboard without completing the Tag Update Preview. A separate save step isn't necessary: every approve, reject, or reset-to-pending decision in the change list is applied automatically as soon as you click it, with no confirmation message. If saving a decision fails, an error message appears, and the affected decision is reset to its previous status. The Tag Update Preview remains open, and the document stays locked until you apply or discard the changes.
  • Apply to the document: Applies the approved changes, including approved removals, and completes the Tag Update Preview. XBRL Tagger adds the mappings of text tags whose removal you rejected to the clipboard for manual reassignment. Other rejected changes are not applied to the document.

The Apply to the document button is disabled while any entries are still pending; a tooltip explains: "Review in progress. All suggestions must be approved or rejected." First set all entries to approved or removed (see Change List) to enable the button.

Shows a section of the toolbar with the 'Discard changes', 'Close', and 'Apply to the document' buttons in the Tag Update Preview in XBRL Tagger. 'Apply to the document' is disabled because entries are still pending.
Buttons of the Tag Update Preview

This content was generated using AI and reviewed by Lucanet subject matter experts before publication.