Document Designer

You must have designer-role rights to use this tool.

You can use the Document Designer to present data-source content in the formats of MS Word, Excel, HTML, PowerPoint, or PDF. You can incorporate any number of components of any type into a document, because you don't have the onscreen space restrictions of a dashboard.

You can customize the document with a Word template that uses an Xtraction-generated framework with placeholders indicating where the content is to go. You have the freedom to tailor the template, but for a successful export, ensure that the placeholders remain intact within the final document.

The key design steps for using this tool are to:

Include any number of components of any type (no onscreen space restrictions).

Use a Word template to enable custom formatting.

Export the content for review outside of Xtraction.

Interacting with the Document Designer

When using the Document Designer, the details pane shows two distinct sub-panes:

The central pane graphically displays one component at a time that's included in the document.

The right pane lists all components included in the document composition. You can click any one of the listed components to display it individually in the central pane.

To create a document, use the same methods as you do for the Dashboard Designer:

Open the Document Designer tool by clicking the icon in the toolbox left of the navigation pane. Before setting up a document design, you need to define some preliminary settings, such as defining design defaults, selecting the data source, and applying any optional filters to the content.

Use the navigation pane to find components to include in the document.

Drag components onto the central pane; it doesn't matter if a component is already shown, dragging another one to that area adds it to the composition. Continue adding components to the central pane until you have a complete document.

Use the document components list at right to bring a component into focus.

In the central pane, use the action icons to interact with a component and tailor its design settings.

Right-click any component in the document components list to edit, copy, or remove it. Or you can clear all listed components by selecting Clear Components.

Click on details within a displayed component to work with filters applied to it, or to view its underlying record list.

Use the Tools menu to incorporate any dashboards.

When your design is complete, use the File menu to save as you would for a dashboard. If you choose to export the document, it's saved to the Downloads folder defined for your browser.

Using parameters

You can associate parameters with a document that prompt a user to enter certain values in order to view the document. These values are passed to variable condition filters that replace the variables with the associated parameter values that were entered. For example, if a document shows all open incidents, you can set up a parameter to prompt for the priority of those incidents.

Exporting documents

You can export documents to these formats: Word, PDF, HTML, Excel, or PowerPoint. To schedule periodic exports, see Scheduling content exports.

Exporting documents to a template

You can export a document to an Xtraction-generated Word template to customize its format. To do so, complete a three-procedure process—create and edit the template to your liking, upload the template into Xtraction, and finally export the document content to the template.

Before exporting, make sure that your document composition is complete, contains all components to be included in the result, and has been saved.

Once the template is uploaded and saved, you can export the document content to the template following the "Exporting documents" procedure above.

To schedule periodic exports, see Scheduling content exports.