Get PDF with Puppeteer API on New Work Order Completed from MaintainX API

Pipedream makes it easy to connect APIs for Puppeteer, MaintainX and 2,800+ other apps remarkably fast.

Trigger workflow on

New Work Order Completed from the MaintainX API

Next, do this

Get PDF with the Puppeteer API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a MaintainX trigger and Puppeteer action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Work Order Completed trigger
1. Connect your MaintainX account
2. Configure timer
Configure the Get PDF action
1. Connect your Puppeteer account
2. Configure URL
3. Optional- Configure Download Path
4. Optional- Configure Display Header Footer
5. Optional- Configure Footer Template
6. Optional- Select a Format
7. Optional- Configure Header Template
8. Optional- Configure Height
9. Optional- Configure Landscape
10. Optional- Configure Bottom Margin
11. Optional- Configure Left Margin
12. Optional- Configure Right Margin
13. Optional- Configure Top Margin
14. Optional- Configure Omit Background
15. Optional- Configure Page Ranges
16. Optional- Configure Prefer CSS Page Size
17. Optional- Configure Print Background
18. Optional- Configure Scale
19. Optional- Configure Timeout
20. Optional- Configure Width
21. Configure syncDir
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Work Order Completed on MaintainX

Description:Emit new event each time a new work order is completed.

Version:0.0.1

Key:maintainx-new-work-order-completed

View on GitHub

MaintainX Overview#

The MaintainX API lets you automate workflows related to work orders, assets, and maintenance activities within the MaintainX platform. With this API on Pipedream, you can build serverless workflows to react to events, sync data, and connect MaintainX to other apps and services, creating a seamless integration hub for facility and equipment management tasks.

Trigger Code#

import maintainx from "../../maintainx.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  name: "New Work Order Completed",
  version: "0.0.1",
  key: "maintainx-new-work-order-completed",
  description: "Emit new event each time a new work order is completed.",
  type: "source",
  dedupe: "unique",
  props: {
    maintainx,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      static: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  methods: {
    emitEvent(data) {
      if (!data.completedAt) {
        return;
      }

      this._setLastWorkOrderId(data.id);

      this.$emit(data, {
        id: data.id,
        summary: `New work order with ID ${data.id}`,
        ts: Date.parse(data.createdAt),
      });
    },
    _setLastWorkOrderId(id) {
      this.db.set("lastWorkOrderId", id);
    },
    _getLastWorkOrderId() {
      return this.db.get("lastWorkOrderId");
    },
  },
  hooks: {
    async deploy() {
      const { workOrders } = await this.maintainx.getWorkOrders({
        params: {
          limit: 10,
        },
      });

      workOrders.reverse().forEach(this.emitEvent);
    },
  },
  async run() {
    const lastWorkOrderId = this._getLastWorkOrderId();

    let cursor;

    do {
      const {
        nextCursor, workOrders,
      } = await this.maintainx.getWorkOrders({
        params: {
          cursor,
          limit: 100,
        },
      });

      workOrders.reverse().forEach(this.emitEvent);

      if (
        workOrders.length < 100 ||
        workOrders.filter((workOrder) => workOrder.id === lastWorkOrderId)
      ) {
        return;
      }

      cursor = nextCursor;
    } while (cursor);
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
MaintainX	`maintainx`	`app`	This component uses the MaintainX app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

Trigger Authentication#

MaintainX uses API keys for authentication. When you connect your MaintainX account, Pipedream securely stores the keys so you can easily authenticate to MaintainX APIs in both code and no-code steps.

To retrieve your API Key,

Navigate to your MaintainX account and sign in
Go to “Settings” > “Integrations”
Click the “API Keys” tab

About MaintainX#

MaintainX is mobile-first work order and procedure digitization software that allows factory frontline teams to know what they need to do and how to do it.

Action#

Get PDF on Puppeteer

Description:Generate a PDF of a page using Puppeteer. [See the documentation](https://pptr.dev/api/puppeteer.page.pdf)

Version:1.0.5

Key:puppeteer-get-pdf

View on GitHub

Puppeteer Overview#

Puppeteer is a Node.js library which provides a high-level API to control Chrome/Chromium over the DevTools Protocol. Puppeteer runs in headless mode on Chromium on Pipedream.

Using Puppeteer you can perform tasks including:

Capture Screenshots: Convert webpages into images.
Processing PDFs: parse and scan PDFs.
Web Scraping: Extract data from websites.
UI/UX Testing: Verify user interface and experience.
Integration with Test Frameworks: Combine with testing frameworks.
Task Automation: Automate web-related tasks like form filling.
Functional Testing: Automate user interactions to test web application functionality.
Regression Testing: Ensure new code changes don't introduce bugs.

Action Code#

import puppeteer from "../../puppeteer.app.mjs";
import constants from "../../common/constants.mjs";
import common from "../common/common.mjs";
import fs from "fs";

export default {
  ...common,
  key: "puppeteer-get-pdf",
  name: "Get PDF",
  description:
    "Generate a PDF of a page using Puppeteer. [See the documentation](https://pptr.dev/api/puppeteer.page.pdf)",
  version: "1.0.5",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    puppeteer,
    ...common.props,
    downloadPath: {
      type: "string",
      label: "Download Path",
      description:
        "Download the PDF to the `/tmp` directory with the specified filename",
      optional: true,
    },
    displayHeaderFooter: {
      type: "boolean",
      label: "Display Header Footer",
      description: "Whether to show the header and footer.",
      optional: true,
      default: false,
    },
    footerTemplate: {
      type: "string",
      label: "Footer Template",
      description: "HTML template for the print footer.",
      optional: true,
    },
    format: {
      type: "string",
      label: "Format",
      description: "The paper format of the PDF",
      options: constants.PAPER_FORMAT,
      optional: true,
    },
    headerTemplate: {
      type: "string",
      label: "Header Template",
      description:
        "HTML template for the print header. Should be valid HTML with the following classes used to inject values into them: `date` - formatted print date, `title` - document title, `url` - document location, `pageNumber` - current page number, `totalPages` - total pages in the document.",
      optional: true,
    },
    height: {
      type: "string",
      label: "Height",
      description:
        "Sets the height of paper. You can pass in a number or a string with a unit.",
      optional: true,
    },
    landscape: {
      type: "boolean",
      label: "Landscape",
      description: "Whether to print in landscape orientation.",
      optional: true,
      default: false,
    },
    marginBottom: {
      type: "string",
      label: "Bottom Margin",
      description: "Margin for the bottom of the page",
      optional: true,
    },
    marginLeft: {
      type: "string",
      label: "Left Margin",
      description: "Margin for the left side of the page",
      optional: true,
    },
    marginRight: {
      type: "string",
      label: "Right Margin",
      description: "Margin for the right side of the page",
      optional: true,
    },
    marginTop: {
      type: "string",
      label: "Top Margin",
      description: "Margin for the top of the page",
      optional: true,
    },
    omitBackground: {
      type: "boolean",
      label: "Omit Background",
      description:
        "Hides default white background and allows generating pdfs with transparency.",
      optional: true,
      default: false,
    },
    pageRanges: {
      type: "string",
      label: "Page Ranges",
      description: "Paper ranges to print, e.g. 1-5, 8, 11-13.",
      optional: true,
    },
    preferCSSPageSize: {
      type: "boolean",
      label: "Prefer CSS Page Size",
      description:
        "Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.",
      optional: true,
      default: false,
    },
    printBackground: {
      type: "boolean",
      label: "Print Background",
      description: "Set to true to print background graphics.",
      optional: true,
      default: false,
    },
    scale: {
      type: "string",
      label: "Scale",
      description:
        "Scales the rendering of the web page. Amount must be between 0.1 and 2.",
      optional: true,
    },
    timeout: {
      type: "integer",
      label: "Timeout",
      description: "Timeout in milliseconds. Pass 0 to disable timeout.",
      optional: true,
      default: 30000,
    },
    width: {
      type: "string",
      label: "Width",
      description:
        "Sets the width of paper. You can pass in a number or a string with a unit.",
      optional: true,
    },
    syncDir: {
      type: "dir",
      accessMode: "write",
      sync: true,
    },
  },
  methods: {
    ...common.methods,
    async downloadToTMP(pdf) {
      const path = this.downloadPath.includes("/tmp")
        ? this.downloadPath
        : `/tmp/${this.downloadPath}`;
      fs.writeFileSync(path, pdf);
      return path;
    },
  },
  async run({ $ }) {
    const options = {
      displayHeaderFooter: this.displayHeaderFooter,
      footerTemplate: this.footerTemplate,
      format: this.format,
      headerTemplate: this.headerTemplate,
      height: this.height,
      landscape: this.landscape,
      margin: {
        bottom: this.marginBottom,
        left: this.marginLeft,
        right: this.marginRight,
        top: this.marginTop,
      },
      omitBackground: this.omitBackground,
      pageRanges: this.pageRanges,
      preferCSSPageSize: this.preferCSSPageSize,
      printBackground: this.printBackground,
      scale: this.scale
        ? parseFloat(this.scale)
        : undefined,
      timeout: this.timeout,
      width: this.width,
    };

    const url = this.normalizeUrl();
    const browser = await this.puppeteer.launch();
    const page = await browser.newPage();
    await page.goto(url);
    const pdf = await page.pdf(options);
    await browser.close();

    const filePath =
      pdf && this.downloadPath
        ? await this.downloadToTMP(pdf)
        : undefined;

    if (pdf) {
      $.export("$summary", `Successfully generated PDF from ${url}`);
    }

    return filePath
      ? filePath
      : pdf;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Puppeteer	`puppeteer`	`app`	This component uses the Puppeteer app.
URL	`url`	`string`	The URL of the page to scrape. For example, `https://example.com`.
Download Path	`downloadPath`	`string`	Download the PDF to the `/tmp` directory with the specified filename
Display Header Footer	`displayHeaderFooter`	`boolean`	Whether to show the header and footer.
Footer Template	`footerTemplate`	`string`	HTML template for the print footer.
Format	`format`	`string`	Select a value from the drop down menu:`{ "value": "letter", "label": "Letter - 8.5in x 11in" }{ "value": "legal", "label": "Legal - 8.5in x 14in" }{ "value": "tabloid", "label": "Tabloid - 11in x 17in" }{ "value": "ledger", "label": "Ledger - 17in x 11in" }{ "value": "a0", "label": "A0 - 33.1in x 46.8in" }{ "value": "a1", "label": "A1 - 23.4in x 33.1in" }{ "value": "a2", "label": "A2 - 16.54in x 23.4in" }{ "value": "a3", "label": "A3 - 11.7in x 16.54in" }{ "value": "a4", "label": "A4 - 8.27in x 11.7in" }{ "value": "a5", "label": "A5 - 5.83in x 8.27in" }{ "value": "a6", "label": "A6 - 4.13in x 5.83in" }`
Header Template	`headerTemplate`	`string`	HTML template for the print header. Should be valid HTML with the following classes used to inject values into them: `date` - formatted print date, `title` - document title, `url` - document location, `pageNumber` - current page number, `totalPages` - total pages in the document.
Height	`height`	`string`	Sets the height of paper. You can pass in a number or a string with a unit.
Landscape	`landscape`	`boolean`	Whether to print in landscape orientation.
Bottom Margin	`marginBottom`	`string`	Margin for the bottom of the page
Left Margin	`marginLeft`	`string`	Margin for the left side of the page
Right Margin	`marginRight`	`string`	Margin for the right side of the page
Top Margin	`marginTop`	`string`	Margin for the top of the page
Omit Background	`omitBackground`	`boolean`	Hides default white background and allows generating pdfs with transparency.
Page Ranges	`pageRanges`	`string`	Paper ranges to print, e.g. 1-5, 8, 11-13.
Prefer CSS Page Size	`preferCSSPageSize`	`boolean`	Give any CSS @page size declared in the page priority over what is declared in the width or height or format option.
Print Background	`printBackground`	`boolean`	Set to true to print background graphics.
Scale	`scale`	`string`	Scales the rendering of the web page. Amount must be between 0.1 and 2.
Timeout	`timeout`	`integer`	Timeout in milliseconds. Pass 0 to disable timeout.
Width	`width`	`string`	Sets the width of paper. You can pass in a number or a string with a unit.
syncDir	`syncDir`	`dir`