You are here: Document Designer > Document Designer Overview

Document Designer Overview

OVERVIEW

The Document Designer is a new tool for creating document templates. The Document Designer makes it easy to populate documents with current transaction data, and show or hide content based on product, transaction or user information. The Document Designer is a simple, powerful tool for creating proposals, contracts, statements of work, and other business documents.

The Document Designer editor’s intuitive user interface and drag-and-drop functionality makes document design and maintenance fluid and efficient. Editing and formatting individual elements is straightforward. Support for multiple languages can be tailored to allow many admins to work simultaneously.

ClosedFeatures

Features include:


ClosedUsability

The Document Designer editor offers usability at two levels:


ClosedPDF Drivers

For environments that are using the default PDF driver instead of Antenna House, the following constraints exist:

PDF Merge capability is not available. Embed Document Elements will not result in a change to the output when the PDF or File Attachment options are selected. Although these options will be available, they will not have any effect. If the Embed Document Element uses an RTE Template, the functionality works as expected.

Image Elements may get clipped in output, even though no warning appeared in the Document Designer editor that the Image’s dimensions exceeded the container size.

The boundaries of a Section Element may not be respected when a Text Element is a very long string without spaces. Text without whitespaces will not overflow to the next line; it will be clipped based on the container size.

The height of an Image Element is ignored when a % value is provided. Height is instead calculated using either the custom width or the original width, in that order of preference. The aspect ratio is preserved.

Using the Keep Together property will cause clipping if the combined content of the bound Elements is longer than a page length—in this case, the excess content gets clipped. Keep Together can be used on Text and Table Elements.


ADMINISTRATION

Like the Document Engine, the Document Designer uses Printer Friendly XSL Views and Commerce Print or Email actions to complete the template-to-output process.

In a complete Document Designer workflow, when a Print or Email action is invoked on the user side, the Printer Friendly XSL View will convert the XSL that makes up the Document Designer template into the appropriate output type. Printer Friendly XSL Views can convert Document Designer templates into PDF, DOCX, and RTF files.

The Document Designer Setup Process

The process of creating a Document Designer template and linking it to a Commerce Print or Email action requires three steps:

  1. ClosedCreate a Document Designer template and deploy the template.
  2. ClosedCreate a Printer Friendly XSL View and link it to the Document Designer template.
  3. ClosedCreate a Commerce Print or Email action and link it to the Printer Friendly XSL View. Add the action to a Commerce layout and deploy the Commerce Process.

ClosedCreating a Document Designer Template

  1. Click Admin to go to the Admin Home Page.
  2. Click Document Designer under Commerce and Documents.

    The Document Templates page appears.

  3. Click Create.
  4. Enter a Name for the template.
  5. Select a Language for the template or select Multiple if the template will contain translations.

    If you select Multiple, also select a Default Language.

    For more information on handling multiple languages with Document Designer, see the topic Document Designer: Languages and Translations.

  6. Click OK.

    The Document Designer editor appears.

  7. Optional: Begin adding content to the template. (This can be done later as well).
  8. Click Save.
  9. Click Deploy.

ClosedCreating a Printer Friendly XSL View and Linking It to the Template

  1. Click Admin to go to the Admin Home Page.
  2. Click Process Definition under Commerce and Documents.
  3. From the Navigation drop-down, select Printer Friendly/History XSL Views and click List.
  4. Click Add to add a Printer Friendly XSL View.
  5. Enter a Name and Variable Name.
  6. Select an Output Type.
  7. From the Select Document drop-down, select the Document Designer template you created (only deployed Document Designer templates appear in this list).
  8. Click Add.

ClosedCreating a Print or Email Action and Linking It to the Printer Friendly XSL View

  1. Navigate to the Quote-level Action List page.
    1. Click Admin to go to the Admin Home Page.
    2. Click Process Definition under Commerce and Document.
    3. With Documents selected in the Navigation drop-down, click List for the Commerce Process where the Print or Email action will be created.
    4. Select Actions from the Navigation drop-down for Quote/Transaction.
    5. Click List.
  2. Click Add to create a new Quote/Transaction-level action.
  3. Enter a Label for the action.
  4. Select Print or Email as the Action Type.
  5. Click Add to add the action.
  6. Click the XSL Views tab of the action.
  7. Select the Printer Friendly XSL View you created from the XSL Views drop-down.
  8. Select a Language attribute if the template is or will be translated (via multiple templates or one multi-language template).

    For more information on handling multiple languages with Document Designer, see the topic Document Designer: Languages and Translations.

  9. Click Apply to save the action.
  10. Add the action to the Quote/Transaction-level layout. See the topic Layout Editor Overview for step-by step instructions on adding actions to the Commerce layout.
  11. Deploy the Commerce Process.

ClosedTransitioning from the Document Engine

It is not possible to migrate document templates created in the Document Engine to the new Document Designer. When transitioning to the Document Designer, existing document templates must be manually recreated.

You can continue to edit Document Engine templates. Additionally, you can use both Document Engine and Document Designer templates in the same Commerce Process.

When to Transition

You should consider transitioning to the Document Designer when:

By switching to the Document Designer, admins will enjoy reduced template maintenance, and will not have to use HTML debugging tools.


NOTES

The Document Engine will continue to be supported for existing customers. New customers starting on 2015 R1 or later will only have access to the Document Designer. Enhancement requests and bugs in the Document Engine will not be prioritized.

RELATED TOPICS

Related Topics Link IconSee Also