Designing Document Specifications

Create Document Specification

To create a new Document Specification the designer has to click on the Create button in the Document Specifications Panel. The following popup will appear:

The Name and Description (optionally) of the new Document Specification must be inserted and the document specification category must be selected. Then, the Create button should be clicked.

The newly created specification will appear in the Document Specification Panel, in the chosen category.

Import Document Specifications and Resolve Templates and Stylesheets

To import document specifications, the designer has to click the Import button. When clicking it the following popup will appear:

It contains a Browse button with which the user can search for a document specification on the local disk. After opening a .dsx file, selecting a category and clicking Import, the following popup will appear asking the designer to resolve the possible conflicts generated by the newly imported document specification:

If the corresponding template and stylesheets are found in the Shared Library, the user will find the conflicts to be automatically resolved and will only have to click OK. If there are more suitable files with the same name the user will be asked to select which template or stylesheets are needed to be used from the Action field where a Select button will appear. In order to successfully import a document specification, only the template needs to be resolved.After clicking OK, the specification will be added.

Edit Document Specifications

A document specification can be edited to have a different name, description or to be displayed under a different category. In order to edit a document specification, select the specification and click the Edit button.

By editing a doc spec, you can move it from one category to another.

Load Document Specifications

To load a document specification, the designer has two options:

1. Double click the desired specification in the Document Specifications Panel

2. Select the specification and click on the Load button.

When using the first option the document specification will be directly loaded to Workbench.

When using the second option, the dialog with information corresponding to the selected document specification will be displayed and the designer can click the Load button in order to load the selected document specification.

Share Document Specification

A document specification can be shared if the Share button is available in the popup dialog (which means it was not previously shared).

If the user will click ‘Share’ the following popup appears:

Clicking Ok will share the selected document specification:

We can now notice that the Share button in the dialog description is no longer displayed for shared document specifications.

Delete Document Specification

In order to delete a document specification, the designer has to click the desired document specification and to press the Delete button.

There are 2 possible cases:

1. The specification is not shared

If the documentation is unshared, by clicking delete the user will receive the following popup:

Clicking ok will delete the document specification from designer’s library.

2. The specification is shared

If the specification is shared after clicking delete the following popup will appear signaling the status of the documentation to the user:

Clicking OK will remove the document specification from everywhere (shared and local library).

Unshare a Document Specification

To unshare a document specification, the designer has to select the Shared Specifications tab and then click on the desired specification.

If the user is the owner of the file he will see the button Unshare. Clicking Unshare the following popup will appear:

Clicking OK will unshare the selected document.

NOTE: The current logged on specification designer can only unshare the document specifications where he appears as OWNER.

Add Templates to DSX

To add a template to a DSX, the designer has two options:

1. Double click the desired template in the template panel

2. Click on the desired template in the Templates Panel.

When using the first option the template will automatically be loaded to the DSX.

When using the second option, the information dialog corresponding to the selected template will appear where the button Add To DSX is available. Clicking the button will result in the addition of the template to the loaded document specification:

Remove template from DSX

To remove a document template from DSX, the designer has to right click on the desired template in the Workbench Panel and the Remove template… option will appear. The template will be removed, after the user will click OK on the safety remove popup.

Add Outputs to DSX

To add an output to DSX, the designer must right-click the Outputs folder in the loaded document specification from the Workbench Panel. A menu with the outputs that can be added will appear. If the user wants to add an output that already exists the following popup will appear and no change will occur:

When adding an output that was not already added the change will occur:

Remove Output from DSX

To remove an output from DSX, the designer has to right-click the desired output from the Workbench and a Remove Output… menu will appear. If the designer clicks remove, the following safety popup will appear:

Clicking OK will result in the removal of the selected output.

NOTE: The XslFo driver should always be loaded when an Excel output is desired in order to have a good formatting. That is why and Excel output cannot be added if the XslFo driver was not previously added:

And a XslFo output cannot be removed before the Excel output is removed: