How to add or edit documents to OpenSolar

Summary:

This article provides detailed instructions on how to create, edit, and generate document templates within OpenSolar. Document templates streamline the creation of standardized documents such as owner manuals, contracts, and handover documents, enabling greater customization and professionalism in your project documentation.

Table of contents:

Accessing the Document Template

• Initial Setup for a Document
• Prefill Template Options

Editing Existing OpenSolar Templates

• Formatting and Customization Options

Creating a New Template from Scratch

• If Using the Text Editor
• If Uploading a PDF

Generating the Document

Accessing the Document Template:

To create a new document template:

1. Navigate to Control > Other > Document Template.

2. From the Document Template window, you can:

   • Edit an existing document by clicking the edit pencil next to the desired template.

   • Create a new document by selecting + Add Document Template.

Initial Setup for a Document:

In the creation window, fill out the following fields:

• Title: Name of the document template.

• Language: Set the document’s default language.

• Prefill Template: Select a pre-created template or start from scratch.

• Editor: Choose whether to use the text editor or upload a PDF.

Note: To modify OpenSolar's pre-created templates, you must use the Text Editor option.

Prefill Template Options:

The Prefill Template dropdown provides ready-made templates created by OpenSolar, including:

• Generic Document

• Energy Yield Report – US

• Installation Instructions – US

• Change Order Contract

• LightReach Sales Design Details – US

Selecting a prefill template will load the standard version, allowing you to make any necessary modifications. To start a completely new document, select Generic Document.

Editing Existing OpenSolar Templates:

OpenSolar offers a variety of standardized templates for common professional use cases. However, these templates can be customized to better fit your specific business requirements.

To edit an existing template:

1. Expand the Prefill Template dropdown and select the template you wish to modify.

2. Save the window to load the template content.

3. Edit the template using the available formatting tools.

Formatting and Customization Options:

The editor supports standard formatting tools, such as:

•  

  • Text Formatting: Bold, Italic, Underline, Font Size, Text Color

  • Layout: Paragraph Alignment, Line Breaks, Page Breaks, Tables, Lists

  • Placeholders: Use placeholders to dynamically pull project data into the contract. Note that placeholder availability is more limited than in PDF templates.

  • DocuSign Fields: Available only when DocuSign is selected as the integration.

Always remember to save your template once all changes are complete.

Creating a New Template from Scratch:

If creating a completely new template:

1. In the Prefill Template dropdown, select Generic Document.

2. Choose whether the template will be created using Text or PDF.

If Using the Text Editor:

An empty editor will appear where you can manually write or paste content. Standard formatting options and limited placeholders will be available.

If Uploading a PDF:

Follow these steps:

Step 1: Upload the PDF File

• Click Import File and upload your PDF document into OpenSolar.

Step 2: Load Sample Project Data

• Select a sample project, system design, and payment option aligned with the information you want in the document.

• Click Load Sample Data to populate the template with project data.

The left-hand panel will then display a list of available placeholders categorized by:

To add a placeholder, drag it into the template. For better placement visibility:

• Avoid placing placeholders directly in their final spot—drop them elsewhere first, then reposition them.

• Use Ctrl + / Ctrl - on your keyboard to zoom, instead of the on-screen zoom controls.

Customizing Placeholders:

Click the arrow beside a placeholder to customize its properties:

• Width, Font Size, Number of Lines

• Decimal Rounding

• Number Formatting (e.g., number of currency)

• Formulas: Check this on you add calculated values (e.g., project completion date = contract date + 180 days)

Click Save when finished.

Generating the Document:

After creating or modifying templates:

1. Navigate to the Manage tab of your project.

2. Scroll to the Documents section.

3. Click the + icon to open the Generate File option.

4. Expand the dropdown list to view available templates:

   • Custom-created and modified templates appear at the top.

   • Default generic templates are listed at the bottom.

5. Select your desired template and click Generate.