VOOZH about

URL: https://www.cdata.com/kb/tech/pdfmonkey-sync-csv.rst

⇱ Automated Continuous PDFMonkey Replication to Local Delimited Files


Automated Continuous PDFMonkey Replication to Local Delimited Files

πŸ‘ Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Sync for automated, continuous, customizable PDFMonkey replication to delimited files (CSV/TSV).

Always-on applications rely on automatic failover capabilities and real-time data access. CData Sync integrates live PDFMonkey data into local delimited files (CSV/TSV), allowing you to consolidate all of your data into a single location for archiving, reporting, analytics, machine learning, artificial intelligence and more.

Configure CSV/TSV as a Replication Destination

Using CData Sync, you can replicate PDFMonkey data to delimited files, like CSV or TSV. To add a replication destination, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select CSV as a destination. πŸ‘ Configure a Destination connection to CSV.
  3. Enter the necessary connection properties. To connect to a directory for storing delimited files, set the following:
    • Destination Folder: Set this location on the disk for the delimited files.
    • Include Column Headers: Set this to True for the first row in each file to represent the column names.
  4. Click Test Connection to ensure that the connection is configured properly. πŸ‘ Configure a Destination connection.
  5. Click Save Changes.

Configure the PDFMonkey Connection

You can configure a connection to PDFMonkey from the Connections tab. To add a connection to your PDFMonkey account, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select a source (PDFMonkey).
  3. Configure the connection properties.

    Using API Key Authentication

    PdfMonkey uses API key authentication. To obtain an API key:

    1. Log in to your PdfMonkey account at https://app.pdfmonkey.io
    2. Navigate to your account settings
    3. Open the API Key page
    4. Copy your API key

    After obtaining your API key, set the following connection properties:

    • AuthScheme: Set this to APIKey.
    Set the following in the ProfileSettings connection property:
    • APIKey: Set this to your PdfMonkey API key.

    Example Connection String

    Profile=C:\profiles\PdfMonkey.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"
    

    Connecting to PdfMonkey

    Once the authentication is configured, you can connect to PdfMonkey and query data from any of the available tables such as CurrentUser, DocumentCards, Documents, DocumentTemplateCards, and DocumentTemplates.

    πŸ‘ Configuring a Profile Source connection (Klaviyo is shown).
  4. Click Connect to ensure that the connection is configured properly.
  5. Click Save Changes.

Configure Replication Queries

CData Sync enables you to control replication with a point-and-click interface and with SQL queries. For each replication you wish to configure, navigate to the Jobs tab and click Add Job. Select the Source and Destination for your replication.

πŸ‘ Select Source and Destination connections for the replication.

Replicate Entire Tables

To replicate an entire table, click Add Tables in the Tables section, choose the table(s) you wish to replicate, and click Add Selected Tables.

πŸ‘ Choose entire tables to replicate (Salesforce is shown).

Customize Your Replication

You can use the Columns and Query tabs of a task to customize your replication. The Columns tab allows you to specify which columns to replicate, rename the columns at the destination, and even perform operations on the source data before replicating. The Query tab allows you to add filters, grouping, and sorting to the replication. πŸ‘ Configure a replication Transform.

Schedule Your Replication

In the Schedule section, you can schedule a job to run automatically, configuring the job to run after specified intervals ranging from once every 10 minutes to once every month.

πŸ‘ Schedule your job to run automatically.

Once you have configured the replication job, click Save Changes. You can configure any number of jobs to manage the replication of your PDFMonkey data to delimited files.