View template information

note

Document Builder can support quote and invoice templates. However, even if Document Builder is enabled and accessible through the user interface, additional one-time configuration might be required.
Go to Manage > Marketplace > Settings.
- If DOCUMENT BUILDER appears in the left menu, see Document Builder prerequisites to confirm whether it is configured for invoice templates, quote templates, both, or neither.
- If DOCUMENT BUILDER does not appear in the left menu, either Contact your AppDirect technical representative to request it, or see Invoice templates and Quote templates to create and manage templates instead.

Marketplace Managers can view template information as follows:

• The document templates listing page displays all PDF templates.
• The document template details page displays the details for one template.

To view the document templates listing page

Go to Manage > Marketplace > Settings > DOCUMENT BUILDER | Manage Templates. The Manage templates listing page opens. Following is a description of the information and options displayed on the page:

• Template list—Lists all PDF templates. The list includes at minimum one default AppDirect template for each language that the marketplace supports.
  • Search—Enter the template file name (or a portion of the name) to find a specific template.
  • Filters—Use one or a combination of the following filters:
    • Language— The language associated with each template. For each language that the marketplace supports, there is one default template. There can be an unlimited number of user-defined templates, and there is at least one template in Active status.
    • Template type
      • Default template—AppDirect -provided default templates.
      • User-defined template—Templates that users create.
    • Status
      • Active—Templates that the AppDirect platform uses to generate PDF invoices when users download them.
      • Not Active—Templates that the AppDirect platform does not use to generate PDF invoices when users download them. This includes templates that were active and have been deactivated.
  • Name column—Toggle the column heading to reverse how the list is displayed (in alphabetical order). Each template has a unique name.
  • Last modified column—Toggle the column to reverse the order in which templates are displayed, based on when they were last update (user-modified templates only).
  • Gear icon drop-down list
    • Copy Template—Create a new template that you can edit, or to save the template as backup of the current state of the original template. For more information, see Copy templates.
    • Download JSON—Download the JSON file for the template. The JSON for default templates is also the template JSON structure. For more information, see Download template JSON files.
    • Edit JSON—For user-defined templates only. Opens the Edit JSON page. Ffor more information, see Edit JSON templates.
• Add custom templates pane
  • JSON Structure—Download the generic JSON template structure (this is the same as the JSON you can download from the default invoice for the primary language of your marketplace at {defaultTemplateInvoiceName} | gear icon > Download JSON). For more information, see Download template JSON files.
  • Add Template—Opens the New Template page to create a new template. For more information, see Add new templates.

To view the template details page

1. Go to Manage > Marketplace > Settings > DOCUMENT BUILDER | Manage Templates. The Manage Templates listing page opens.
2. From the Select template type drop-down list, select the type of template. The listing page for that type of template appears.
3. Click the template. The document template details page opens. The upper pane displays the following:
   • Template name
   • Status
     • Active—The AppDirect platform uses this template to generate PDF invoices when users download them.
     • Not active—The AppDirect platform does not use this template to generate PDF invoices when users download them. On this page, only templates that have never been active appear with the Not active status.
     • Deactivated—Templates that were in Active status and are Not active now, appear as Deactivated with the date of deactivation and the name of the user who published the alternative invoice for the same language.
   • Created—(User-defined templates only) The date the user created the template. Replaced with Last updated after you have edited it.
   • Last updated—(User-defined templates only) The date the last edits were saved, and the name of the user who made the edits.
   • Language—The language associated with the template.
   • Publish—Available for templates in Not Active and deactivated status, and templates in Active status that you have edited since they were last published. The Publish button is active when there are unpublished changes. It is inactive when there are no changes to publish. For mor einformation, see Publish templates.
   • Gear icon drop-down list (user-defined templates only):
     • Rename—Option to rename the template. The name must be unique among templates associated with the same language.
     • Copy template—Option to copy the template, name the copy, and publish the template. For more infofrmation, see Copy templates.
   • Copy template—(Default templates only.) Option to copy the template, name the copy, and publish the template. For more infofrmation, see Copy templates.
   • Template preview—By default, displays the template view (no data populated) of the most current version .
     • Template ID—Unique identifier for the template version.
     • Rotate icon—Turn the preview page 90 degrees clockwise.
     • Download icon—Download a PDF of the template preview (displays no data).
     • Print icon—Print a PDF of the template preview (displays no data).
   • View PDF—The preview pane displays the template populated with mock data.