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


The document data source that can be configured within the project allows the upload, storage and management of the files required to submit a successful ESEF filing and makes converted PDF reports available for iXBRL tagging in the Tagging tool.

Document configuration

Management of all documents associated with the project is performed in the Documents tab, located between the Forms and Permissions tabs in the Project configuration.
The Documents tab contains the Documents grid that lists all of the documents (i.e. data sources) added to the project and their properties:

  • The title of the document can be configured in the Name column

Note: The title of the document (i.e. the document Name) has to be unique within the project

  • The document type is shown in the Type column by selecting one of the following options:
    • iXBRL
    • Other
    • XHTML
  • The fact collection used by the document is shown in the Fact collection column
  • The default client the document is created for can be configured in the Client column by selecting one of the already configured clients from the drop down.
  • The default period of the document can be configured in the Period column by selecting one of the already configured periods from the drop down
  • The default precision in which the values are expected to be reported in the document can be configured in the Precision column  by selecting one of the following options:
    • exact number
    • thousands
    • millions
    • billions
  • The default currency used in the document can be configured in the Unit column by selecting the 3-letter ISO code of the currency from the drop-down.

The entries in the Documents grid are sortable; by default, the entries are sorted by the Name column in a lexicographically descending order. All changes made to the document's configuration are applied on saving the entire project configuration.

Default property configuration

By default:

  • The oldest (i.e. first created) fact collection is configured in the Fact collection column
  • The oldest (i.e. first created) top-level client is configured in the Client column
  • The main period is configured in the Period column
  • The project default precision is configured in the Precision column
  • The project default currency is configured in the Unit column

Document management

By default (i.e. when creating a new project), a document titled Document 1 will be automatically created for the user, once at least one fact collection, client and period are configured for the project.
Additional documents can be created:

  • by clicking the Add button, to create a new document with the default property configuration
  • by clicking the Copy button, to create a new document that copies the property configuration of an existing document
Copying a document does not copy its contents, only its configuration. In other words, references (i.e. links or paths) to the external data sources (i.e. HTML\XHTML files) configured for the source document will not be copied over to the newly created document


An existing document can be removed by selecting its entry in the grid and clicking Remove. Removing a document results in:

  • The document no longer being accessible via the Documents menu\ribbon
  • Deletion of all entries related to the document from the Documents history

Document access

All documents configured in the project are accessible:

  • In the ribbon view, via the Documents ribbon section
  • In the menu view, via the Documents menu located in the Main toolbar 

In order to access a document, the project where the document resides needs to be open first; otherwise, the ribbon section will not be visible\the menu items will be disabled.

Document import

In order for the document to be accessible and usable in the Tagging tool, the physical PDF report as well as any accompanying attachments needs to be imported into the document. This can be done by clicking the Import button in the Documents ribbon section\Documents menu

PDF into iXBRL

In order to ensure the successful import and tagging of PDF reports:

  • The PDF file should not be encrypted, password protected or otherwise secured
  • The PDF file should not contain:
    • hidden text
    • text obtained by OCR
    • non-Unicode fonts (i.e. fonts containing glyphs that don't map to Unicode code points)
    • Annotations (non-embedded images, stamps, etc.) - at the very least, these will be ignored
      Please note that while you might be able to import and successfully tag PDF reports that fail one or more of the above-listed requirements, in some cases not fulfilling those conditions might result in the inability to import the report or to tag it either fully or partially.

This option allows to import a PDF report into the document selected in the Target document dropdown menu while converting the PDF into an ESEF compliant XHTML file that can be tagged using iXBRL in the Tagging tool editor in the process.

Selecting Unicode mapping will force the tool to map the PDFs internal encoding to Unicode thus possibly affecting the documents layout and look and feel.

Providing a supported external tag properties file in the Tag definition input will automatically tag the imported report based on the external file's contents as discussed in more details here.  

Reporting package import

This option allows to quickly import an entire reporting package generated by the Tagging tool. Importing the package will automatically create a new project, configured with the reporting taxonomy and the taxonomy extension and a pre-configured document containing the tagged HTML\XHTML report (and any referenced image, stylesheet or script files)

Other 

This option allows to import all of the ESEF supported file types to be used as an attachment to the generated filing package. Supported file types are:

  •  .jpeg (1.1), *.jpg (1.1), *.jpe (1.1),
  • *.gif (1.1),
  • *.png (1.1),
  • *.xml (1.1),
  • *.xsd (1.1), *.xbrl (1.1), *.xml (1.1),
  • *.woff (1.4), *.woff2 (1.4),
  • *.svg (1.4),
  • *.pdf (1.1),
  • *.css(1.1),
  • *.htm (1.1), *.html (1.1), *.xhtml (1.1).

PDF to XHTML 

This option allows to convert a PDF file into a ESEF compliant XHTML file that can be added to the ESEF filing package 

Any XHTML file (i.e. XHTML file created as the result of the PDF conversion and is used to create an iXBRL instance via tagging as well as any other non-tagged XHTML file submitted in the filing) has to pass the XHTML 1.1 schema validation to be ESEF compliant; submitting XHTML files that do not pass the XHTML 1.1 schema validation may result in a submission rejection

Document editing

Once the external data sources have been imported into a document, that document can be opened for editing in the Tagging tool by clicking the Edit button in the Documents ribbon section\Documents menu and selecting its name, and clicking Open in the Edit documents dialog that will appear.
Concurrent document access is supported – a document that's currently open for editing can be opened by another user independently and they will be notified that the document is currently being edited.
In case the edits result in conflicting changes, the changes made by the user that saves the document last will be the ones that will be persisted.

Document permissions

Access to documents is controlled via the following permissions located in the project configuration Permissions tab:

  • Users with the Manage documents permission can configure (i.e. create, remove and copy documents) in the project's configuration
  • Users with the Modify documents permission can access the Documents menu\ribbon and all of its functionalities including:
    • Upload the external data sources into the document 
    • Edit the document with the Tagging tool
    • View Document history


Document history

All actions that affect the currently configured documents in the project are tracked in the Document history that can be accessed by clicking View history in the Documents ribbon section\Documents menu. The Document history dialog lists the following details on the tracked actions:

  • The Document name column contains the title of the affected document
  • The Version column contains the version of the document that was automatically created by the tracked action. The document creation automatically sets the document to version 0; each subsequent action performed on the document automatically increments its version number by 1
  • The User column contains the user name of the person that performed the action
  • The Action column contains the type of action that was performed. The following types of actions are being tracked:
    • Creation – the document has been added or copied
    • Update – the document configuration has been changed
    • Upload – HTML\XHTML file or a zip archive has been imported into the document
    • Tagging – the imported HTML\XHTRML file has been tagged and those tags have been saved
  • The Timestamp column contains the date and time the action took place
  • The entries in the Documents history grid are sortable; by default, the entries are sorted by the Timestamp column in a descending order

Document impact

Project import/export

In addition to the existing functionalities, exporting/importing the project also exports/imports:

  • the document configuration for all documents
  • the latest version of the imported HTML\XHTML report (and any referenced image, stylesheet or script files) with all saved tags, if any
  • the extension taxonomy
  • the Document history
  • No labels
Write a comment…