vlocode-project - v2.4.3
    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);
        exportMode?: DatapackExportMode;
        grouping?: {
            displayName: string | ((record: any) => string);
            fields: string[];
        };
        matchingKey?: { fields: string[]; returnField?: string };
        salesforceUrl?: SalesforceUrlDefinition;
        scope?: string;
        source: SalesforceQueryData;
        typeLabel: string;
    }
    Index

    Properties

    datapackType description? displayName? exportMode? grouping? matchingKey? salesforceUrl? scope? 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

    exportMode?: DatapackExportMode

    Defines how the datapack should be exported. If not provided, the datapack will be exported using the default export mode.

    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?: SalesforceUrlDefinition

    Allows overwriting the default Salesforce URL for the datapack type.

    scope?: string

    Optional scope for datapack definitions to allow multiple configurations for the same Object Type.

    source: SalesforceQueryData

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

    typeLabel: string

    Settings

    Member Visibility

    On This Page

    Properties