Return to main navigation Page
The Document Panel is the first panel that appears when the
Document Editor is launched. This panel controls the structure of the
current document, which may contain pages, loops, and XSL snippets.
This section also allows the user to preview output, set default units, and specify document settings.
Major components of the Document Panel:
Document menu drop-down options:
- Replace Document: Replace the entire contents of your current document tree structure with new documents.
- Output Type: Change the Output Type. The output type that the end user sees is determined by the Process Output selected on the Add/Update XSL View page. However, this menu item allows the user to preview the output as either RTF, PDF or Advanced PDF.
Changing from one output type to another in an existing document is discouraged, as this might introduce compatability issues.
- Refresh Data Sources: Refreshes the
external data used to generate the document. For example, this makes
new transaction data available to the Proposal Editor, which might
impact the dynamic text embedded in the pages. Select this action after
every test that uses production data.
- Edit Global XSL Snippet: Edit XSL code that can be maintained outside the global scope of the document; that is, outside the main
<xsl:template-math="/">. Use this snippet to maintain global variables and templates.
By default, this template is empty.
- View Document XSL: View the complete generated XSL of the document created with the Document Editor.
You can save the Document XSL to your
local machine in order to make changes with an XSL editor. The edited
XSL can then be uploaded as a Custom XSL.
Changes made within the Document XSL Code window are not saved.
To view the XSL for an individual page, navigate to the page and click Page Code on the Home toolbar.
- Change Theme: Change the skin for the entire Document Editor window.
Use the Flow
tab to add, delete, and rename document elements. The elements of a
document are organized in a hierarchical tree to visually represent how
the document is laid out. Double-click the name of an element to open
Does not represent a literal page,
as your body content may end up flowing over to a new page, depending
on the data on the user-side when the document is printed.
Think of a Document Engine page as
a place where you can define a constant header and/or footer with fixed
dimensions. If your body content overflows to more pages, those pages
will share the header/footer that you defined on the Document Engine
You can insert hard page breaks into your page body content.
In technical terms, a page outputs a complete xsl
Document Flow Loops are useful
for creating repeating pages. Loops in the Document Flow Tree repeat
over all the line items and can display individual Products Information
pages for each line item in the loop.
You can edit the loop to control how the pages within a loop are generated.
In technical terms, a loop is an
<xsl:for-each> tag inserted outside the
<fo:page-sequence> tags that are generated for each Document Flow Page.
The code that you write in a Document Flow XSL Snippet is inserted between the
<fo:pagesequence> nodes that are generated by Page objects.
To avoid XSL errors, only write XSL that will either be or will generate
tab allows the user to preview the output in the PDF or RTF format.
The output type is determined by the Process Output that is selected on
the Add/Update XSL View page. However, the user can change the output
type for preview by choosing a different output type in the Document
Adding a New Page
Click Admin to go to the Admin Home Page.
Click Documents under Commerce and Documents.
The Document Engine Management Center appears.
- Open or create a document.
- Click the name of an existing document, or click the pencil icon for a document and then click Open Document Engine.
- Click Add Document, complete the fields, and click Add.
The Document Engine appears.
Choose Add Page from the Add drop-down on the Flow Tab.
The Select Page Layout - From Library dialog box appears.
- Enter a name and a valid Description for your new page.
Select from a list of page layout templates to start from. In most cases, the first option, Default Page, is a good starting point.
By default, your new page is added to the end of
the Document Flow Tree. You can drag and drop a Page to another location
in the flow.
Rename a Page by right-clicking on it and clicking Rename.
Adding a Loop
Add a loop when you want content to print out for each line item in your transaction.
- Open a document in the Document Engine.
- Click Add Loop on the Document Panel's Flow Tab.
- Define properties in the Expression Editor (Loop) dialog box.
- Click Save.
A new Loop object appears in the flow tree.
Add XSL to get system or transaction information that is
not available using Dynamic Data. Dynamic Data is discussed in the
topic Using Dynamic Data.
- Open a document in the Document Engine.
- Click Add XSL on the Document Panel's Flow Tab.
- Enter a name and description in the (I18n)Flow XSL Snippet dialog box.
- Enter code in the Editing window.
- Click Save.
A new XSL object appears in the flow tree.
You can save the Document XSL to your local
machine in order to make changes with an XSL editor. The edited XSL
can then be uploaded as a Custom XSL. Changes made within the Document
XSL Code window is not saved. To view the XSL for an individual page,
navigate to the page and click on the Page Code action on the Home Tab.
If content that is stored in a secure File Manager folder is referenced, the path must be updated.
Changing from one output type to another is discouraged as this might introduce compatibility issues.