Creating a Document Export Query with Configurable Joins

Updated March 10, 2023 14:21

Expand-All Collapse-All

To create a document export query with Configurable Joins, you will:

1. Create a query on the Document base and configure the required settings.
2. Add exports and filters as needed.
3. Configure the document export format.

Creating a Query on the Document Base

From the main navigation, select Queries / Reports.
Click New Query.
Select New Query. Configure the following settings:
- Type: Configurable Joins
- Category: Related
- Base: Document
Click Save. The query summary page appears.

On the right of the query summary page, select Edit Properties and configure the following settings:
- Limit Rows: 5000
  - There is a strict limit of 5,000 documents per query execution. Ensure that this setting is configured with a value of 5,000 or less.
- Execution Options: Retrieve only the new records since the query was last run
- Fetch Behavior: Preserve where clause on fetch if required by one or more filters.
- Queue: None (default)
  - The queue setting is incompatible with a document export. Do not adjust this setting.
- Secondary Key: Leave blank
  - A secondary Key is not required for Document Export queries built using the Configurable Joins - Document base! This setting was previously required due to how the Slate Template Library - Document Export (Application) base was constructed.
Click Save.

Standard Exports

Among others, the exports pdf:xml and pdf:file are available from the Document base as Direct Exports (as they were in the Document Export (Application) base).

Important!

Adding these exports to a query on the Document base will prepend the export names with "Document. "

To function as a document export query, you must remove the prepended "Document " text. Click Rename Exports and remove this text before proceeding.

Replacing custom SQL with Subquery Exports

If you used Custom SQL to customize the pdf:xml or pdf:file exports, you can rebuild and customize these exports using Subquery Exports.

Configuring the Document Export Format

Regardless of whether you intend to download the documents manually or export them on a schedule, configuring the Schedule Export settings is required. These settings define the format of the downloaded files. Follow the instructions in the Scheduling Document Exports article to complete this step.