Interface DatapackTypeDefinition

Interface defining the query properties for a datapack type

Hierarchy

  • DatapackTypeDefinition

Properties

datapackType description? displayName? grouping? matchingKey? salesforceUrl? source typeLabel

Properties

datapackType

datapackType: string

Name of the datapack type

Optional description

description?: string | ((record) => string)

Description of a single datapack for the UI. Single line format.

Type declaration

    • (record): string

    • Parameters

      • record: any

      Returns string

Optional displayName

displayName?: string | ((record) => string)

Function to format the name of the datapack for display in the UI

Type declaration

    • (record): string

    • Parameters

      • record: any

      Returns string

Optional grouping

grouping?: {
    displayName: string | ((record) => string);
    fields: string[];
}

Defines optional grouping logic for the datapack type.

Type declaration

  • displayName: string | ((record) => string)
  • fields: string[]

Optional matchingKey

matchingKey?: {
    fields: string[];
    returnField?: string;
}

Allows changing the default Matching Key for the datapack type.

Type declaration

  • fields: string[]
  • Optional returnField?: string

Optional salesforceUrl

salesforceUrl?: Record<string, ((record) => string)> | ((record) => string)

Allows overwriting the default Salesforce URL for the datapack type.

Type declaration

    • (record): string

    • Parameters

      • record: any

      Returns string

source

source: SalesforceQueryData

Defines the source query how to retrieve the datapack records from Salesforce.

typeLabel

typeLabel: string

Settings

Member Visibility

Theme

On This Page