Define Export Functions

Explanation

This activity is used to define export functions, which will alter the document before an export is performed.

Once a document is loaded and a user decides to perform an export, an export function will run in the background. It will alter the entire export that can consist of multiple documents (e.g., a document generated for every employee). The range of changes depends on function export definition. It is possible to, for example, replace certain words or phrases with different text, or to enumerate the documents generated.

Prerequisites

In order to perform this activity, a document template has to be registered in the system.

System Effects

As a result of this activity, an export function will be defined.

Window

Document Basic Data

Related Window Descriptions

Document Basic Data, Document Basic Data/Document Templates/Export Functions

Procedure

1. Open the Document Templates window and navigate to the Document Templates tab.
2. Navigate to the Export Functions tab and add a new record in the table.
3. In the Line ID field, enter a number of the record, it has to be different from other numbers in the table.
4. In the Line Order field, enter in what order the line is loaded.
5. In the Func ID field, enter the ID of a function. This ID will determine what type of action will be performed on the document when it's exported. You can use the list of values.
6. In the Parameters field, enter parameters of the function. Every parameter should be separated by a semicolon. You can see what every parameter means in the Parameter Description field. You will also see a small text box appear as you start typing with an information which parameter are you supposed to enter (e.g., text to replace, new text).
7. Save the information.

Note: You can define multiple export functions for a single template ID. To define more functions, go to step 2.