Class DatapackImportService

Service to import multipacks stored on the org through the Vlocity DataRaptor API.

Index

Constructors

Properties

Methods

activateDatapacks cancelImport getAllDataPackData getMultipackData importMultipack initialize installMultipack reportProgress runActivate runImport startImport updateDatapackInfo

Constructors

constructor

new DatapackImportService(remoting: VisualforceRemoting): DatapackImportService
Parameters
- remoting: VisualforceRemoting
Returns DatapackImportService
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:68

Properties

`Private` `Readonly`remoting

remoting: VisualforceRemoting

Methods

`Private`activateDatapacks

activateDatapacks(
    deployResult: DatapackData,
    progress?: ImportProgressDelegate,
    cancelationToken?: CancellationToken,
): Promise<DatapackImportProgress>
Parameters
- deployResult: DatapackData
- Optionalprogress: ImportProgressDelegate
- OptionalcancelationToken: CancellationToken
Returns Promise<DatapackImportProgress>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:161

`Private`cancelImport

cancelImport(id: string): Promise<VisualforceRemotingResponse>
Parameters
- id: string
Returns Promise<VisualforceRemotingResponse>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:133

`Private`getAllDataPackData

getAllDataPackData(id: string): Promise<DatapackData>
Parameters
- id: string
Returns Promise<DatapackData>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:206

`Private`getMultipackData

getMultipackData(datapackName: string): Promise<MultipackResource>
Parameters
- datapackName: string
Returns Promise<MultipackResource>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:211

`Private`importMultipack

importMultipack(
    datapackData: MultipackResource,
    progress?: ImportProgressDelegate,
    cancelationToken?: CancellationToken,
): Promise<DatapackImportProgress>
Parameters
- datapackData: MultipackResource
- Optionalprogress: ImportProgressDelegate
- OptionalcancelationToken: CancellationToken
Returns Promise<DatapackImportProgress>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:137

initialize

initialize(vlocityNamespace?: string): Promise<DatapackImportService>
Parameters
- vlocityNamespace: string = 'vlocity_cmt'
Returns Promise<DatapackImportService>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:71

installMultipack

installMultipack(
    multipackName: string,
    options?: {
        cancelationToken?: CancellationToken;
        predicate?: (datapack: DatapackInfo) => boolean;
        progress?: ImportProgressDelegate;
        skipActivation?: boolean;
    },
): Promise<DatapackImportProgress>
Installs a multipack by its name, optionally filtering the datapacks to import.

This method retrieves the specified multipack, applies an optional filter to its datapacks, imports the filtered datapacks, activates them, and updates their status to 'Complete'.
Parameters
- multipackName: string
  The name of the multipack to install.
- Optionaloptions: {
      cancelationToken?: CancellationToken;
      predicate?: (datapack: DatapackInfo) => boolean;
      progress?: ImportProgressDelegate;
      skipActivation?: boolean;
  }
  Optional runtime options to control installation. Use options.predicate to provide a filter function to decide which datapacks to import.
Returns Promise<DatapackImportProgress>
A promise that resolves to the import progress status of the datapacks.
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:86

`Private`reportProgress

reportProgress(
status: DatapackImportProgress,
progress?: ImportProgressDelegate,
): DatapackImportProgress
Parameters
- status: DatapackImportProgress
- Optionalprogress: ImportProgressDelegate
Returns DatapackImportProgress
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:186

`Private`runActivate

runActivate(id: string, datapackKeys: string[]): Promise<DatapackImportProgress>
Parameters
- id: string
- datapackKeys: string[]
Returns Promise<DatapackImportProgress>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:196

`Private`runImport

runImport(id: string): Promise<DatapackImportProgress>
Parameters
- id: string
Returns Promise<DatapackImportProgress>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:122

`Private`startImport

startImport(datapackData: MultipackResource): Promise<DatapackImportProgress>
Parameters
- datapackData: MultipackResource
Returns Promise<DatapackImportProgress>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:115

`Private`updateDatapackInfo

updateDatapackInfo(
id: string,
status: string,
): Promise<VisualforceRemotingResponse>
Parameters
- id: string
- status: string
Returns Promise<VisualforceRemotingResponse>
- Defined in packages/vlocity/src/datapack/datapackImportService.ts:129

Class DatapackImportService

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DatapackImportService

Properties

Private Readonlyremoting

Methods

PrivateactivateDatapacks

Parameters

Returns Promise<DatapackImportProgress>

PrivatecancelImport

Parameters

Returns Promise<VisualforceRemotingResponse>

PrivategetAllDataPackData

Parameters

Returns Promise<DatapackData>

PrivategetMultipackData

Parameters

Returns Promise<MultipackResource>

PrivateimportMultipack

Parameters

Returns Promise<DatapackImportProgress>

initialize

Parameters

Returns Promise<DatapackImportService>

installMultipack

Parameters

Returns Promise<DatapackImportProgress>

PrivatereportProgress

Parameters

Returns DatapackImportProgress

PrivaterunActivate

Parameters

Returns Promise<DatapackImportProgress>

PrivaterunImport

Parameters

Returns Promise<DatapackImportProgress>

PrivatestartImport

Parameters

Returns Promise<DatapackImportProgress>

PrivateupdateDatapackInfo

Parameters

Returns Promise<VisualforceRemotingResponse>

Settings

On This Page

`Private` `Readonly`remoting

`Private`activateDatapacks

`Private`cancelImport

`Private`getAllDataPackData

`Private`getMultipackData

`Private`importMultipack

`Private`reportProgress

`Private`runActivate

`Private`runImport

`Private`startImport

`Private`updateDatapackInfo