Troubleshoot: Manually Installing the SEC Previewer

If you are using GoFiler to manage your SEC previewer software, you will need to have the latest Python installation package provided by the SEC. GoFiler will automatically install this package when the previewer is installed the first time. (See Can I preview my report using GoFiler?) There may be cases where the installation of Python fails via this function due to extenuating circumstances. If you are encountering problems during the installation of Python, you can attempt to manual install Python. If the installation is set up appropriately, the software will be able to access the Python components and the previewer in order to generate your proofs.

To install Python manually:

  1. Download the file https://www.novaworkssoftware.com/files/pythonarelle_manual.zip.
  2. Extract the contents to a local folder on the computer.
  3. Run install-for-rendering-engine.bat. This file is a copy of the SEC's installer for Python that has been modified such that GoFiler can interface with it in order to use the SEC previewer to generate a proof.
  4. A command prompt will appear with some information about the installation process. Press any key to continue.
  5. A wizard will then open. Follow the installation wizard for Python.
  6. Download the latest copy of the SEC's previewer from https://www.novaworkssoftware.com/files/xbrl_previewer.zip.
  7. Go to your AppData directory. This can be accomplished by opening Windows File Explorer and typing "%appdata%" into the address bar.
  8. Create a new folder and name it "re3".
  9. Extract xbrl_previewer.zip to the re3 folder.
  10. Open GoFiler.
  11. Click File > Send > Publish > Edit Previewer Options.
  12. Set the Python Path field to the full path where Python was installed. Unless you changed the path during the Python installation wizard, this will be C:\Python34.
  13. Set the Previewer field to the full path of the "re3" folder that you created in Step 7. For example, C:\Users\john.public\AppData\re3.
  14. Click OK to save the settings.

The SEC Previewer and the supporting script to use it are now installed and set on the computer.


Helpful Hints:

  • When you run the install-for-rendering-engine.bat to start the installation wizard for Python, Windows Defender may attempt to block the file from running because it was downloaded from the Internet. Only install software from trusted sources like Novaworks. Contact our support team if you have any questions or concerns during this installation process.
  • The Python installation wizard may report some warnings or errors during the installation process. The SEC provided the installation package with these errors included, so they can be ignored. Contact your IT department if you encounter an error that prevents the successful installation of Python.
  • The settings in the Previewer Options can be manually set by opening the .ini file for the previewer. You can find these settings in Previewer.ini, located in the Novaworks folder of the AppData directory. The Python Path option corresponds to python_dir in the .ini file. The Previewer option corresponds to arelle_viewer.