Quick Start to Install EDGAR® Renderer

Several alternative installation strategies can be followed:

Install a pre-built application. These are available with embedded Python and require no developer skills.
Install from sources on GitHub. (See Technical Operation)

Once installed there are two strategies for using the EDGAR renderer:

Interactively from its GUI. (This now includes a local viewer using the same components as the sec.gov website.)
Technical Operation: from command line, as a web service, or polled operation as a daemon service. (See Technical Operation)

Installing

Pre-built application

Pre-built applications for Windows, macOS and Linux are on the Arelle download page, which offers each build from the US, EU and CN mirrors.

Download and install.
- It isn’t necessary to remove old versions first.
- If you don’t have administrator rights on your computer, install to a directory that you do have rights to (such as under Documents).

User Operation

Interactively from its GUI

Start Arelle with the installed app, from the Windows start menu or by clicking on arelleGUI.exe, or with the Mac Application Arelle.app.

start Edgar Renderer Windows — Starting Arelle from the Windows Start menu.

start Edgar Renderer Mac — Starting Arelle on macOS.

Check that the EDGAR renderer plugin is installed and enabled: help→manage plugins.

If EDGAR Renderer is not shown, press Select→EDGAR Renderer→ok→close.

Click yes when asked to restart.

allow to restart — Confirming the Arelle restart.

If behind a firewall with Microsoft NTLM proxy service (common in large enterprises), also install the internet proxy plugin for NTLM (help→manage plugins→select→Internet NTLM proxy handler→ok→close).

select NTLM proxy plugin — Selecting the Internet NTLM proxy handler.

It may be necessary to start your browser and open a public website (such as Google) to “prime” NTLM for your user account, before Arelle can access the outside internet.

For validation using EDGAR Filer Manual, Tools→Validation→Select Disclosure System.

Select an EDGAR Filing Manual validation mode, such as Pragmatic, and press ok.

select EDGAR Filer Manual validation mode — Choosing an EDGAR Filer Manual validation mode.

Enable Disclosure system checks. This menu entry is a checkmark toggle; click so it is enabled.

check menu selection for disclosure system validation — Enabling disclosure system checks.

Open an SEC filing with the Open File toolbar button, then select the instance document or inline html document. After successful loading the local viewer should display the SEC rendering engine results. If it’s an inline html document, click the (Source) top menu entry to see the html form with fact information highlighted by ixviewer.

The Open File toolbar button.

inline ix viewer — The inline XBRL viewer.

Redline markups in the inline document set are now shown with the View menu selection “Workstation Redline Mode”. (These markups are a private communication from filer to SEC personnel, for SEC workstations upon request. They are not disseminated to the public.)

For filer manual validation, use the Validate toolbar button.

The Validate toolbar button.