Page tree
Skip to end of metadata
Go to start of metadata

Auto-tagging based on an external tag properties file

PDF reports where all values to be tagged are bookmarked with unique bookmark names during the report creation process can be auto-tagged using an external file that contains the properties of each tag to be applied. The external file (also know as the tag definition file) is a JSON file with the following structure:

  • tag id, that should exactly match the bookmark name of the intended corresponding value
  • the tag properties such as data type, value, precision, unit, scale, sign, position's local part, position's section, position's role URI, position's preferred label and position's reporting period as fields
  • dimensions, if any, as a map of the axis and the correspond dimension members
The combination of the position's preferred label and the role URI uniquely identifies a position and its occurrence in the taxonomy

Any of the above mentioned properties except for the tag id can be omitted, or have null values - in that cases the automatically generated tag will have null values for those properties.,

To auto-tag a report based on an external tag properties file:

  1. Click Upload in the Documents section of the ribbon\Documents menu in the toolbar
  2. Click PDF into iXBRL in the cascading menu
  3. In the Import report dialog that will appear, provide the PDF report and properties file in the that fit the description above in the Import file and Tag definition fields respectively
  4. Click Upload
  5. Upon uploading the files and converting the PDF into XHTML, the tool will parse the provided properties file and will automatically match each tag id with each bookmark name
  6. The tool will compare the bookmarked value in the report to the tag value provided in the properties file and will insert an iXBRL tag into the report at the appropriate location, encapsulating the matching value and applying all of the provided non-null properties in the tag definition file
  7. The tagging will fail in case:
    1. A tag id didn't exactly match any of the bookmark names and\or
    2. The bookmarked value in the report match the value of the tag with the matching id provided in the external file
  8. After processing all the tags provided in the tag definition file in the above described manner, the tool will provide a summary of all failed tags in a grid or in a downloadable CSV file - listing the tag id and the value of each failed tag
In case the value provided in the tag definition file matches the the first n characters of the bookmarked value in the report, the inserted tag will encapsulate only those first n characters, ignoring the rest. 

Auto-tagging based on previously saved version

A report can be auto-tagged based on a previously saved version of the same document, provided that the same tables, tags outside tables and tags within tables are created in the same order prior to initiating the auto-tagging process. 


Tables are considered the same if they have the same number of rows a columns.

For tags outside the tables, the values encapsulated within the tag (i.e. the tagged content) need to be identical as well. 


Once the preparation is complete, the auto-tagging process can be initiated by opening a document for editing and clicking Autotag in the Tagging tool section of the ribbon\toolbar. In the Autotag dialog that will appear, the Document version dropdown displays the available versions for the document, their save date and time as well as the save message (if any). Selecting one of the available versions and clicking OK designates it as the auto-tagging source - i.e. the tool will attempt to match the tables and the tags existing in it to the tables and tags present in the destination document - and initiates the auto-tagging. The auto-tagging process then matches the tables and tags from the source and destination document and sets the tag properties in the destination document version (including position, reporting period, unit, dimensional members, etc.)  to mirror the corresponding tags from the source document version. If discrepancies are detected during the auto-tagging process, it is stopped completely prior to making any changes and details on the detected differences between the source and the target document such as the number of tables, rows, columns, tags and content for tags outside tables in both the source and the destination document are listed for review in the Tagging summary panel located on the right-hand side.  Each reported discrepancy can be either manually addressed or ignored by clicking Report to the right of the reported entry and selecting Ignore from the dropdown. When all reported entries have been addressed (either by changing the document or ignoring them), clicking Rerun in the Tagging summary panel toolbar will attempt to restart the auto-tagging process using the previously designated document version as a source. Clicking Cancel will exit the auto-tagging mode which can then be restarted by clicking Autotag in the Tagging tool section of the ribbon\toolbar and therefore, allowing to change the version of the document to be used as a source.

If a reported discrepancy is ignored, upon clicking Rerun the tool will attempt to continue applying all tags succeeding the discrepancy that can be matched in the destination document


  • No labels
Write a comment…