Test build a document type

You can test build a document type to quickly preview the end result at any time during the document type creation process. In a test build, the Build button is available, allowing you to bypass the requirements for building a Project. It is recommended that you test build your document type as you add components to verify how the document type displays to users and that it builds as you intend.

Running a Test Build

  1. Go to Architecture > Document Types.
  2. Initiate a test build using one of the following methods: 
    • From the grid:
      • Hover over the document type you want to test build, click the More Options More Options menu menu, and select Run Test Build.
      • Select the checkbox of the document type you want to test build, click the More Options More Options menu menu at the top of the page, and select Run Test Build.
    • From the workspace: 
      • Double-click the document type and click Test Build at the top of the workspace.
      • Hover over the desired document type, click the More Options More Options menu menu, select Open Document Type, and click Test Build at the top of the workspace.
      • Hover over the desired document type, click the Edit Edit icon icon, and click Test Build at the top of the workspace.

    3. Note: The Project workspace displays by default (the Project title will be appended by " - test build"). To test build in Created Docs, turn the "TestBuildAsProject" Global settings "Off". Once this setting is updated, click Reset Test Build to apply the changes.

  3. Click the Build Package button in the upper right corner of the project workspace. The Build Package dialog box displays with the Customization tab open.

    4. Note: You may also build a package by clicking Finish and Build. When all actions are completed, the "Next" button changes to "Save and Build," promoting you to build the project. For more information on project navigation, see Projects .

  4. Select one of the following options:
    • Show All Custom Fields: Includes all unpopulated merge codes, those whose corresponding fields are left blank, in the package upon build. The unpopulated merge codes will display highlighted in yellow. We recommend that you use this option the first time you build the package, so that you can view all the merge codes in context in your package.
    • Hide Empty Custom Fields: Removes all unpopulated merge codes from the package upon build.

    5. Note: Any required fields that must be completed in order to build will be identified with an asterisk*.

  5. Click the Settings tab.
  6. Under Style Template, select the style template with which you want the document content formatted. By default, the template that is currently applied displays.
  7. Under Build Format, select the radio button next to one of the following options:
    • Microsoft Word: The package will be built as a Word document (.docx). Any files with extensions other than .doc or .docx will build separately.
    • Adobe PDF: The package will be built as a PDF (.pdf). Any files with extensions other than .doc or .docx will build separately.
  8. (Optional) Select the Perform in the background and email when my file is ready check box. You will receive an email with a link to the package when it is built.
  9. (Optional) Select any of the following Test Build options:
    • Show fields in the built document: Select to display all the merge code fields that have been inserted into the document. If you select this option, merge codes will not be populated, regardless of whether you entered information in the data entry fields.
    • Show formatting codes in the built document: Select to display all the formatting codes that have been applied to the document. Formatting codes assist in formatting the results of the merge codes. For example: {{DateLong}}<<CallDate>>{{DateLong}}.
    • Print all content from selection screens: Select to include all of the content applied to items for all Selection Driven Content components in the document regardless of the selections made.
  10. Click Build to build the package. The package progress displays on the Packages tab. You will receive an email from Upland Qvidian when the test package is built. The email will include links to download the built document and to open the built documents page in Upland Qvidian.

Returning to the Document Type

  • From within Projects and Created Documents, click the Architecture Architecture button icon at the top of the workspace.

Resetting Test Builds

You can reset test builds of document types in Architecture using the Reset Test Build button. Clicking this button deletes any existing test build associated with the document type so you can start again with a fresh test document.

  1. Go to Architecture > Document Types.
  2. Use one of the following methods: 
    • From the grid:
      • Hover over the document type you want to test build, click the More Options More Options menu menu, and select Reset Test Build.
      • Select the checkbox of the document type you want to test build, click the More Options More Options menu menu at the top of the page, and select Reset Test Build.
    • From the workspace: 
      • Double-click the document type and click Test Build at the top of the workspace.
      • Hover over the desire document type, click the More Options More Options menu menu, select Open Document Type, and click Reset Test Build at the top of the workspace.
      • Hover over the desire document type, click the Edit Edit icon icon, and click Reset Test Build at the top of the workspace.