Category: External Data Parameters

Compatible with: Composer 8

Parameter Name: xid

Parameter Value: [QueryAlias:ExternalConnection:QueryId]

Parameter Requirements: None

Parameter Description: The xid parameter indicates an external data source.

  • QueryAlias – Choose an alias for your query and enter it here. Required. Cannot contain spaces or special characters, and must be between 3 and 20 characters long. This QueryAlias becomes the dataset name in Template Builder and in your template.
  • ExternalConnection - ExternalConnection is the alias of the data connection you set up in Step 1) Set up and Configure external data sources.
  • QueryID – Salesforce Id of the Conga Query you set up in Step 2) Build your Conga Query.

The xid parameter supports both Conga Keys and standard record IDs.

Use pv functionality to dynamically filter the results of your query. When using pv functionality with external data, you must define pv in both the Conga Query and in the xid parameter. For example, the following query syntax has pv0 defined, in addition to the related second xid parameter value in the example below: Products?$format=json&$filter=UnitsInStock gt {pv0]

Example:

&xid=MyOracleDataAlias:MyOracleExternalConnection:a045000001DjTva,

ExternalProduct:CongaData:a045000001DjTva?pv0={!Account.AverageStock}