Class DatapackInfoService

constructor

• new DatapackInfoService(
      logger: Logger,
      salesforce: SalesforceService,
  ): DatapackInfoService

  Parameters

  • logger: Logger
  • salesforce: SalesforceService

  Returns DatapackInfoService

Readonlylogger

getDatapackByObject

• getDatapackByObject(
      sobjectType: string,
      datapackType?: string,
  ): Promise<DatapackTypeDefinition | undefined>

  Gets the datapack info for the specified Datapack type. Returns undefined if no datapack is configured for the specified type, otherwise returns the datapack definition.

  Parameters

  • sobjectType: string
  • OptionaldatapackType: string

    Datapack type

  Returns Promise<DatapackTypeDefinition | undefined>

getDatapackByType

• getDatapackByType(
      datapackType: string,
  ): Promise<DatapackTypeDefinition | undefined>

  Parameters

  • datapackType: string

  Returns Promise<DatapackTypeDefinition | undefined>

getDatapackConfiguration

• getDatapackConfiguration(
      datapackType: string,
  ): Promise<DatapackConfiguration | undefined>

  Gets the datapack configuration for the specified datapack type, returns undefined if no configuration is found for the type.

  Parameters

  • datapackType: string

    Datapack type

  Returns Promise<DatapackConfiguration | undefined>

  Datapack configuration record or undefined if no configuration is found for the type

getDatapackConfigurations

• getDatapackConfigurations(): Promise<DatapackConfiguration[]>

  Gets all datapack configurations defined in the org, returns an empty array if no datapack configurations are found.

  Returns Promise<DatapackConfiguration[]>

  Array of datapack configuration records, empty array if no configurations are found

getDatapackDefinitions

• getDatapackDefinitions(): Promise<DatapackTypeDefinition[]>

  Get the SObject Type and Datapack Type of all datapacks defined in Salesforce through a Datapack Configuration record.

  Returns Promise<DatapackTypeDefinition[]>

  Array of datapack info objects linking datapacks to SObjects

getDatapackType

• getDatapackType(sobjectType: string): Promise<string | undefined>

  Gets the datapack name for the specified SObject type, namespaces prefixes are replaced with %vlocity_namespace% when applicable

  Parameters

  • sobjectType: string

    Salesforce object type

  Returns Promise<string | undefined>

registerDatapackDefinitions

• registerDatapackDefinitions(
      definitions: {
          datapackType: string;
          sobjectType: string;
          typeLabel?: string;
      }[],
  ): void

  Register datapack type definitions from a local source such as loaded export definitions. Registered definitions take precedence over the datapack configurations in the org and the built-in definitions, so datapacks resolve to their actual datapack type (e.g. ProductRule) instead of the generic SObject type when no org configuration exists for the object.

  Parameters

  • definitions: { datapackType: string; sobjectType: string; typeLabel?: string }[]

  Returns void