ProcessMaker API Documentation
Script Central

PDF Generator Connector

Automatically generate PDFs of Display-type ProcessMaker Screens in a Process.

Overview

The PDF Generator connector is part of the PDF Generator package that can automatically generate PDFs of Display-type ProcessMaker Screens during Requests. Use the PDF Generator connector in your Process models when you want to provide a printable copy of a Display-type ProcessMaker Screen, such as for Request summaries or purchase order receipts.

ProcessMaker Package Required

The PDF Generator connector requires that the PDF Generator package be installed in your ProcessMaker instance. The PDF Generator connector and the PDF Generator package are not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the PDF Generator connector can be installed in your ProcessMaker instance.

When the PDF Generator connector successfully generates the PDF during an in-progress Request, the PDF output can be downloaded from the Files tab in its Request summary. The PDF Generator names the PDF output the same as the ProcessMaker Screen from which the PDF was generated. As long as the PDF Generator successfully generates the PDF, the PDF output remains available from that Request's summary regardless of that Request's status.

Package and Permissions Required

The PDF Generator connector requires that the ProcessMaker PDF Generator package be installed in your ProcessMaker instance. The PDF Generator connector and the PDF Generator package are not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the PDF Generator connector can be installed in your ProcessMaker instance.

Furthermore, your ProcessMaker user account or group membership must have the following permissions to configure a PDF Generator connector to the Process model unless your user account has the Make this user a Super Admin setting selected:

  • Processes: Edit Processes

  • Processes: View Processes

See the Process permissions or ask your ProcessMaker Administrator for assistance.

Add a PDF Generator Connector to the Process Model

Follow these steps to add a PDF Generator connector to the Process model:

  1. View your Processes. The Processes page displays.

  2. Create a new Process or click the Open Modeler iconto edit the selected Process model. Process Modeler displays.

  3. Locate the PDF Generator connector in the Elements and Connectors palette that is to the left of the Process Modeler canvas. If the Hide Menus buttonis enabled, the Elements and Connectors palette displays the PDF Generator connector's icon.

  4. Drag the connector into the Process model canvas where you want to place it. If a Pool element is in your Process model, the PDF Generator connector cannot be placed outside of the Pool element.

PDF Generator connector

After adding the PDF Generator connector, consider adding the following Boundary-type Process model elements to design business solutions when your best-case scenarios don't happen:

After the connector is placed into the Process model, you may adjust its location in the following ways:

Moving a PDF Generator connector has the following limitations in regards to the following Process model elements:

  • Pool element: If the PDF Generator connector is inside of a Pool element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the PDF Generator connector inside the Pool element closest to where you attempt to move it.

  • Lane element: If the PDF Generator connector is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the PDF Generator connector cannot be moved outside of the Pool element.

Change the Color of a PDF Generator Connector

The PDF Generator connector and label are black-colored by default. After a PDF Generator connector is added to a Process model, its shape and label color can be changed. Element and connector colors may only be changed individually.

Follow these steps to change the color and label for a PDF Generator connector:

  1. View your Processes. The Processes page displays.

  2. Click the Open Modeler iconto edit the selected Process model. Process Modeler displays.

  3. Select the PDF Generator connector to change its color. Available options display above the selected connector.

  4. Click the Open Color Palette icon. The color palette displays.

  5. Do one of the following:

    • Select a color swatch: Select one of the color swatches from the color palette. The PDF Generator connector and label change to that color.

    • Specify a custom color: Click theicon to display the color selector, and then select a color, enter the Hex color code, or enter the red, green, blue, and alpha color values for the custom color. The PDF Generator connector and label change to that color.

    • Reset to the default color: Click theicon to reset the PDF Generator connector and label to its default color.

Copy a PDF Generator Connector

Copying a PDF Generator connector copies the original along with its current settings, making it easier and faster to continue designing without adding default elements or connectors with their default settings.

The copied PDF Generator connector displays below the original. Any Sequence Flow and/or Message Flow elements incoming to or outgoing from the original are not copied.

Follow these steps to copy a PDF Generator connector in your Process model:

  1. View your Processes. The Processes page displays.

  2. Click the Open Modeler iconto edit the selected Process model. Process Modeler displays.

  3. Select the PDF Generator connector to copy. Available options display above the selected connector.

  4. Click the Copy Element icon. The Process model connector copies.

Delete a PDF Generator Connector

Deleting a Process model connector also deletes any Sequence Flow and/or Message Flow elements incoming to or outgoing from that element. For example, if a Process model connector is deleted that has both incoming and outgoing Sequence Flow elements, the Sequence Flow elements must be reconnected for the remaining elements/connectors.

Follow these steps to delete a PDF Generator connector from your Process model:

  1. View your Processes. The Processes page displays.

  2. Click the Open Modeler iconto edit the selected Process model. Process Modeler displays.

  3. Select the PDF Generator connector to delete. Available options display above the selected connector.

  4. Click the Delete icon. The Process model connector deletes.

Settings

The PDF Generator connector has the following panels that contain settings:

Configuration Panel Settings

Edit the Connector Name

Follow these steps to configure a PDF Generator connector:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the PDF Generator connector from the Process model in which to configure its settings. Panels to configure this connector display.

  3. Expand the Configuration panel if it is not presently expanded. The Name setting displays. This is a required setting.

  4. In the Name setting, edit the selected connector's name and then press Enter.

Select the ProcessMaker Screen from Which to Generate a PDF

Follow these steps to select from which Display-type ProcessMaker Screen to generate a PDF:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the PDF Generator connector from the Process model in which to configure its settings. Panels to configure this connector display.

  3. Expand the Configuration panel if it is not presently expanded, and then locate the Select a Display Screen setting.

  4. From the Select a Display Screen drop-down menu, select which ProcessMaker Screen to generate a PDF. Only Display-type ProcessMaker Screens display from this setting.

Related Topics