Keywords
search

Document keyword

Keyword Value
EXTENSION - DOCUMENT - GENERATE Filepointer name. It triggers the extension generating a filepointer with the given name.
EXTENSION - DOCUMENT - USE - IGNORE_MISSING_VALUES Set this variable to ‘Yes’ to not display a warning for placeholders for variables that have no value assigned yet. Instead the placeholder will just be removed. There will still be a warning displayed for placeholders for variables that do not exist at all. Optional, default value is ‘No’.
EXTENSION - DOCUMENT - TEMPLATE The name of the template to use for the document. The template must exist, i.e. the provided name must have an exact (case sensitive) match in the list of Document Templates.
EXTENSION - DOCUMENT - PDF_FORM Set this variable to 'Yes' to produce a PDF form where the clients can introduce information in the input, checkbox, ... fields after the document is opened. Optional, default value is ‘No’.
EXTENSION - DOCUMENT - TRIGGER Deprecated. It's the obsolete alternative to EXTENSION - DOCUMENT - GENERATE. Set this variable to ‘Create’ to trigger the Match Document Extension to actually create the document. This will also make MWP show the MESSAGE_TEXT like it shows a DISPLAYVAR. Set this variable to ‘Generate only’ to trigger the Match Document Extension to only create the document and NOT display MESSAGE_TEXT as a DISPLAYVAR. The URL for downloading the created document is stored in EXTENSION - DOCUMENT - URL
EXTENSION - DOCUMENT - FILENAME Deprecated. It can be used only in combination with EXTENSION - DOCUMENT - TRIGGER. This is the name of the file that the user will download. Don’t include the file extension, it will be added automatically!
EXTENSION - DOCUMENT - USE - DIRECT_DOWNLOAD Deprecated. It can be used only in combination with EXTENSION - DOCUMENT - TRIGGER. Set this variable to ‘Yes’ to enable directly opening the generated document in the browser of the user. Depending on the browser settings this might trigger a direct download, a popup question of what to do with the document, or even a popup blocker. This is outside the control of the Match Web Player. Optional, default value is ‘No’.
EXTENSION - DOCUMENT - MESSAGE_TEXT Deprecated. It can be used only in combination with EXTENSION - DOCUMENT - TRIGGER. This text will be displayed (in the same way as the display vars) to notify the user that a document was created. The text should include a placeholder for the part of the message that should be used as the download link. The placeholder has the same markup as the Document Template placeholders. Example value: Click {{here}} to download your document.
EXTENSION - DOCUMENT - DOWNLOAD_TEXT Deprecated. It can be used only in combination with EXTENSION - DOCUMENT - TRIGGER. This text will be displayed in the button to download the document.
EXTENSION - DOCUMENT - URL Deprecated. It can be used only in combination with EXTENSION - DOCUMENT - TRIGGER. This variable holds the URL to the generated document. The value of this variable will be updated only if the Match Document Extension is triggered with Generate only
The EXTENSION - DOCUMENT - TEMPLATE should always be before the EXTENSION - DOCUMENT - GENERATE keyword. Else the filepointer cannot be found.

Example

Keyword Value
EXTENSION - DOCUMENT - TEMPLATE mytemplate
EXTENSION - DOCUMENT - USE - IGNORE_MISSING_VALUES Yes
EXTENSION - DOCUMENT - GENERATE mydocument.pdf

The above example shows how to generate a filepointer called "mydocument.pdf" that can be downloaded, uploaded via ftp or emailed. To see how to download the file, look at the download keywords.

Example with the "old" deprecated keywords:

Keyword Value
EXTENSION - DOCUMENT - TEMPLATE mytemplate
EXTENSION - DOCUMENT - FILENAME mydocument
EXTENSION - DOCUMENT - USE - DIRECT_DOWNLOAD Yes
EXTENSION - DOCUMENT - USE - IGNORE_MISSING_VALUES Yes
EXTENSION - DOCUMENT - TRIGGER Create

The above example shows how to generate a file called "mydocument.pdf" (the extension is attached automatically) that can be downloaded.