LIST DataSource

Setting Up #

Suppose you have an Opportunity and want your generated document to include a list of all products associated with it.

For each Opportunity Product, the document should display:

• Product Name
• Quantity

The table row will automatically repeat for every Opportunity Product found.

Create a List Data Source #

1. Open PDF Butler and navigate to Data Sources.
2. Click New.
3. Provide a name for your Data Source.
   Example: Opportunity Products
4. Change the Type to: List
   Selecting List tells PDF Butler that the query will return multiple records instead of a single record.
5. Save the Data Source.

Build the SOQL Query #

1. Open the newly created Data Source.
2. Use the SOQL Builder to generate the query.
   The SOQL Builder helps you create queries without manually writing SOQL.
3. Choose an object (for this example we will use: Opportunity Line Item (Opportunity Product))
   This object contains the products associated with an Opportunity.
4. Select the fields you want to retrieve.
   For this example: Opportunity Id, Product Name, Quantity
   You can add additional fields as needed.
5. Configure the Filter to retrieve only the products belonging to the current Opportunity.
   This ensures that only Opportunity Products related to the current Opportunity are returned.
6. Save the query.

Open the Doc Config #

1. Open your Doc Config.
2. Load the newly created List Data Source.
3. The Data Source is now available for Config Types.

Create a Repeating Table Row #

Since the Data Source returns multiple records, the table row must repeat for each record.

1. Create a Config Type of type: TABLE_ROW
2. Select the Opportunity Products List Data Source.
   This tells PDF Butler to repeat the row once for every Opportunity Product returned by the query.
3. Inside the repeating table row, create Config Types for each merge field.
4. Create a merge field for the Product Name.
   Data Source: Opportunity Products
   Field: Product Name
5. Create another merge field for the Quantity.
   Data Source: Opportunity Products
   Field: Quantity
   Formatting can be applied if required.
6. Save the Doc Config.

Generate the Document #

1. Open an Opportunity record.
2. Generate the document using your Doc Config.

PDF Butler will:

1. Retrieve all Opportunity Products related to the Opportunity.
2. Repeat the table row for every product.
3. Populate the Product Name and Quantity merge fields.
4. Generate the completed document.