Manage PDF reader pre-processor templates - SmartPlant Foundation - IM Update 48 - Help - Hexagon

SmartPlant Foundation Help

Language
English
Product
SmartPlant Foundation
Search by Category
Help
SmartPlant Foundation / SDx Version
10
SmartPlant Markup Plus Version
10.0 (2019)
Smart Review Version
2020 (15.0)

Any templates for the selected template group are displayed in the Associate Templates for Template Group pane. Each template consists of a PDF file with annotations.

You can annotate the text that needs to be extracted in a sample or for a template PDF file and provide rule information in the comment. This data is used to create rules.

The application pool user must have access to the template file location in order to manage PDF templates.

  1. In the Template Group pane, select a template group.

  2. Click Create Template in the Associate Templates for Template Group pane.

  3. In the Create Template window, type a name for the template.

  4. Click Browse to select the PDF template file.

  5. Click Create. The rules defined in the template are automatically created and configured in the Associate Rules for Template pane.

    How are the templates chosen to process a PDF file?

    A PDF file is processed by the rules given in the selected template in the Default Template Group. The different template group types are processed differently. The following scenarios explain how the different templates are processed:

    • Default template group (This is provided with the software): The template is automatically selected by the software when no other custom template group is present or chosen. The PDF file is processed by the Match Tag Patterns condition, which is enabled by default in the template group.

    • Single template in the template group: Before processing, the software checks for the validation rule in the template and applies it to the PDF file.

      • If the validation is successful, the PDF file is processed based on the template rules and condition in the Associate Templates for Template Group pane.

      • If the validation fails, the PDF file is not processed as a result the processing job fails.

      • In the absence of the validation rule, the software processes the PDF file with the template.

    • Multiple templates in the template group: The software selects the first template in the list of templates displayed in the Associate Templates for Template Group pane to process the PDF file. Before the processing begins, the software checks for the validation rule in the template and applies it to the PDF file.

      • If the validation is successful, the PDF file is processed based on the template rules.

      • If the validation fails, the software selects the next template from the group and follows the same process.

      • In the absence of the validation rule, the software processes the PDF file with the first template in the group.

  • To extract the tags that match the tag patterns defined in the Tag Discovery Patterns module, select the Match Tag Patterns check box in the Associate Templates for Template Group pane.

  • In the Template Group pane, you can set any one template group as a Default Template Group. The default template group is used to extract content from PDF files using Apache PDFBOX. You must ensure that templates and rules are configured for the default template group so that the content discovery task can extract data from the PDF files.

    However, you can also process the PDF files by using the auto selected Default Template Group defined with the Match Tag Patterns condition delivered with the software.

Update a template file

  1. To update a template file, click Edit Template . Click Browse in the Editing <Template Name> Template window to select the modified PDF template file, and click Update.

  2. Click PDF Template Keywords in the Associate Templates for Template Group pane to open the PDF Template Keywords window with the list of keywords for creating the template document.

  3. The rules for any edited template are completely regenerated in the Associate Rules for Template pane.