Skip to main content

Generate an Inline XBRL Document

As you work in CDM XBRL, you can generate an inline XBRL document at any time, where you can review the inline XBRL code output.

After you complete all your report objects and tagged all necessary data, you generate the final XBRL output that is required for filing with your regulatory body.

The project must be enabled by the administrator for the generation of inline XBRL. Inline XBRL generation embeds XBRL instance data and metadata (using XML elements) into an HTML or XHTML document. This allows you to see a visual representation of the XBRL instance document while also allowing for the necessary information in it to be extracted upon submission. When a project is specified as an inline XBRL project, you are presented with different views and options than when you generate just an instance document from a non-inline XBRL project:

  • The Generate Instance Document command on the project's Home tab is replaced with the Generate Inline XBRL command.
  • You can no longer generate just an instance document by itself. To do this, inline XBRL tagging must be disabled for the project.

Each time you generate an inline XBRL project, it is compiled and output to a .zip archive file. The inline XBRL document (XHTML) is contained in the .zip archive file along with any associated image files. If you select the option to generate an instance document, the .zip archive file will also contain the instance document and possibly the schema that it references, depending on the type of reference files that the project uses.

Note: When generating an ESMA project, label linkbases, for languages selected when the project was created, are referenced. The taxonomy and report package has a reports subfolder structure generated according to the primary language of the project at the moment of the generation.

To generate an inline XBRL document:

  1. Open the project that you want to work with.
  2. Click Home > Generate Inline XBRL. The Generate Inline XBRL High Definition window opens.
  3. The Jurisdiction section displays the jurisdiction you have selected for the project. Jurisdiction affects how the output is validated and generated.
  4. In the Options section, select the options for generation. Different options are available depending on the jurisdiction.
    • Highlight Tags
      Shows all tags. You can choose the tags to be highlighted in yellow in the output, along with a tool tip when the tags are in the print area of the report, and the tag is not in a hidden section of the inline XBRL. This option is only for non-SEC jurisdictions. Highlighting for the SEC jurisdiction is done in the SEC Inline XBRL Viewer.
    • Generate Instance Document
      Generates an instance document as well as the inline XBRL. This option is not available for the European Securities and Markets Authority (ESMA) jurisdiction.
    • Alternating Row Coloring
      Generates alternate row coloring in tables. This option is not available for the European Securities and Markets Authority (ESMA) jurisdiction.
    • Show Hidden Element Comments
      Shows hidden comments. Comments can be inserted next to hidden elements to describe why the elements are hidden. These comments are embedded into the HTML as an XML comment. The comment is inert and does not affect the viewing or processing of the inline XBRL. This option is not available for the European Securities and Markets Authority (ESMA) and SEC jurisdictions.
    • Allow Document Splitting
      Splits the document at an arbitrary boundary. The boundary is by size, (MB = size) and comes from the Split Boundary field. This option is only available for the HMRC jurisdiction.
    • Fixed Page Width
      Sets output content to be 8.5 inches wide and center-aligned in a browser. This default can be changed by modifying the ReportGeneration attribute in the CDM.config file. If this option is not selected, content is displayed the entire width of the browser. This option is only available for the SEC jurisdiction.
  5. In the Refresh section, select an option to refresh the data in the report that is associated with the project.
  6. Select one or more of the available validation options.
  7. Click OK to start the generation.

    Tip: You can view the progress in the All processes completed window in the status bar. While processes are running, the title bar shows the number of running processes. When the processes are finished, the title is All processes completed.

  8. To open the file, open the All processes completed window, and click the Open icon. A check mark indicates that a process generated properly. An exclamation point indicates an error that stopped the process.
  9. Click the Open icon. A previewer opens to display the output using a corresponding viewer according to the jurisdiction (for example, a project with SEC jurisdiction uses the SEC Edgar Renderer).
  10. Close the previewer to view the contents of the .zip file.
  11. To save the generated report, click the Save icon in the All processes completed window and browse to a new location.

Was this article helpful?

We're sorry to hear that.