vlocode-project - v1.40.0-beta-4
    Preparing search index...

    Interface DatapackTypeDefinition

    Interface defining the query properties for a datapack type

    interface DatapackTypeDefinition {
        datapackType: string;
        description?: string | ((record: any) => string);
        displayName?: string | ((record: any) => string);
        grouping?: {
            displayName: string | ((record: any) => string);
            fields: string[];
        };
        matchingKey?: { fields: string[]; returnField?: string };
        salesforceUrl?:
            | Record<string, (record: any) => string>
            | ((record: any) => string);
        source: SalesforceQueryData;
        typeLabel: string;
    }
    Index

    Properties

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

    Properties

    datapackType: string

    Name of the datapack type

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

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

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

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

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

    Defines optional grouping logic for the datapack type.

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

    Allows changing the default Matching Key for the datapack type.

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

    Allows overwriting the default Salesforce URL for the datapack type.

    source: SalesforceQueryData

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

    typeLabel: string

    Settings

    Member Visibility

    On This Page

    Properties