PDF Generator
HomeBlogDocsContact
  • Overview
    • Try It!
    • Introduction
    • Key Features
    • Industry Use Cases
      • PDF Generator for Human Resources
    • Videos
  • Technical Docs
    • Getting Started
    • Building a PDF Template
      • HTML to PDF Merge Templates
      • Printable Labels
        • Label Templates
        • Label Configuration
        • Adding New Avery Type Label Configuration
        • Printing Labels
      • Merge Keys
      • Data Sources
    • Generating a PDF Document
      • Create from Wizard
      • Create from Flow Action
      • Create from Script
    • The Generate PDF Wizard
      • PDF Wizard (Standard Forms)
      • PDF Wizard (Workspaces)
      • PDF Wizard (List View)
    • Adding QR / Barcodes to PDFs
      • How-to Create Barcode Labels
    • TinyMCE Configs
    • Logging
    • Troubleshooting
Powered by GitBook
On this page
  1. Technical Docs
  2. The Generate PDF Wizard

PDF Wizard (List View)

PreviousPDF Wizard (Workspaces)NextAdding QR / Barcodes to PDFs

Last updated 1 day ago

In order to copy the Generate PDF UI Action to selectively print labels from list view:

  1. Copy the UI Action

    1. Visit Yansa PDF Generator -> Label Templates in the left nav.

    2. Right-click the form header and select Configure -> UI Actions.

    3. Select & open the UI Action titled 'Generate Labels from Selection (Sample).

    4. Update the Name and Table fields to match the table where you wish to place the list choice that will open the wizard. Following the instructions in the Script field, update code values to accommodate your needs (see below for details on available customizations). Insert and Stay to create a new copy of the UI Action.

  2. Visit the standard list view for the specified table. Select some items and click the list item to open the Generate Labels from Selection wizard.

Generating PDF labels from list view is not available in UI Builder/Workspace lists.

Customization Options

By default, the Generate Labels from Selection UI Action will have a Script similar to below:

var modalOptions = {};
modalOptions.merge_read_only = true;
modalOptions.merge_step_display = false;
modalOptions.source_table = g_list.getTableName();
modalOptions.pdf_template = 'db61bb64c3612a500be07fedd40131b2';

var selectedRecords = g_list.getChecked();
if (selectedRecords.length > 0) {
    var ga = new GlideAjax('PDFGeneratorAjax');
    ga.addParam('sysparm_name', 'createDataSource');
    ga.addParam('sysparm_table', g_list.getTableName());
    ga.addParam('sysparm_ids', selectedRecords);
    ga.getXMLAnswer(renderModalCallback);
}

function renderModalCallback(answer) {
    modalOptions.pdf_data_source = answer;
    var pdfModal = new GlideModal("x_yala_pdf_pdf_generator_list", false, "modal-lg");
    pdfModal.setTitle("Generate PDF");
    for (var key in modalOptions){
        pdfModal.setPreference(key, modalOptions[key].toString());
    }
    pdfModal.render();
    pdfModal.on('beforeclose', function() {
        var ga = new GlideAjax('PDFGeneratorAjax');
        ga.addParam('sysparm_name', 'deleteDataSource');
        ga.addParam('sysparm_id', modalOptions.pdf_data_source);
        ga.getXMLAnswer(function() {
            console.log('Data source removed.');
        });
    });
}

To customize the behavior of the wizard, you can set any option below on the modalOptions object.

Customize the Select Template step:

  • modalOptions.select_step_display: [boolean]: Show/hide the first 'Select template' step. Otherwise, template must be pre-set [default: true]

  • modalOptions.pdf_template: [sys_id of template]: Preset the selected template

  • modalOptions.pdf_template_read_only: [boolean]: Display the 'Select template' step, but enable/disable it as read-only [default: false]

  • modalOptions.pdf_template_display: [boolean]: Display the 'Select template' step, but show/hide the select box [default: true]

Customize the Merge Data step:

  • modalOptions.merge_step_display: [boolean]: Show/hide the second 'Merge data into PDF' step. Otherwise, data source/record must be pre-set [default: true]

  • modalOptions.source_table: [tableName]: Set the source table for merge data

  • modalOptions.source_table_include_extensions: [boolean]: Include extended tables from source table

  • modalOptions.source_record_table: [tableName]: Set the source table for merge data

  • modalOptions.source_record_id: [sys_id of record]: Set the source record for merge data

  • modalOptions.merge_read_only: [boolean]: Enable/disable the 'Merge data into PDF' step as read-only [default: false]

  • modalOptions.pdf_data_source: [sys_id of data source]: Set data source for merge data. (Note: Only applies to label printing)

Customize the Edit PDF step:

The 'Edit' step is not currently available in list views.

Customize the Save PDF step:

  • modalOptions.save_step_display: [boolean]: Show/hide the third 'Save PDF' step [default: true]

  • modalOptions.enable_download: [boolean]: Enable the 'Download' option [default: true]

  • modalOptions.enable_save_to_current_table: [tableName]: Enable the 'Attach to current' option. [default: false]

  • modalOptions.enable_save_to_current_id: [sys_id of record]: Enable the 'Attach to current' option. [default: false]

PDF Wizard
Select Items from List