Class OmniStudioConverter

Index

Constructors

Properties

Methods

convertDatapack convertDatapackRecord convertOmniScript convertRecord getField getMapping transformDatapackRecordValue

Constructors

constructor

new OmniStudioConverter(logger?: ILogger): OmniStudioConverter
Parameters
- logger: ILogger = ...
Returns OmniStudioConverter
- Defined in packages/vlocity-deploy/src/convert/omniStudioConverter.ts:13

Properties

`Private`logger

logger: ILogger = ...

Methods

convertDatapack

convertDatapack(datapack: VlocityDatapack): VlocityDatapack
Converts a Vlocity datapack to the corresponding OmniStudio format.
Parameters
- datapack: VlocityDatapack
  The Vlocity datapack to convert
Returns VlocityDatapack
A new VlocityDatapack instance with converted data in OmniStudio format

Throws
Error when no OmniStudio runtime mapping is found for the given datapack type
- Defined in packages/vlocity-deploy/src/convert/omniStudioConverter.ts:23

`Private`convertDatapackRecord

convertDatapackRecord(data: object): object
Parameters
- data: object
Returns object
- Defined in packages/vlocity-deploy/src/convert/omniStudioConverter.ts:39

convertOmniScript

convertOmniScript(
scriptRecord: OmniScriptElementRecord,
elements: OmniScriptRecord[],
): { elements: OmniScriptElementRecord[]; process: OmniProcessRecord }
Converts an OmniScript record and its elements into a process and its corresponding elements.
Parameters
- scriptRecord: OmniScriptElementRecord
  The OmniScript record to be converted.
- elements: OmniScriptRecord[]
  An array of OmniScript element records to be converted.
Returns { elements: OmniScriptElementRecord[]; process: OmniProcessRecord }
An object containing the converted process and an array of converted elements.
- Defined in packages/vlocity-deploy/src/convert/omniStudioConverter.ts:121

convertRecord

convertRecord(
sobjectType: string,
record: object,
): { attributes: { type: string } }
Converts a given record to a specified type using OmniStudio runtime mappings.
Parameters
- sobjectType: string
  The SObject type of the record.
- record: object
  The record to be converted.
Returns { attributes: { type: string } }
Throws
- Throws an error if no OmniStudio runtime mappings are found for the given SObject type.
- Defined in packages/vlocity-deploy/src/convert/omniStudioConverter.ts:138

`Private`getField

getField(
data: object,
field: string,
): undefined | { name: string; value: unknown }
Parameters
- data: object
- field: string
Returns undefined | { name: string; value: unknown }
- Defined in packages/vlocity-deploy/src/convert/omniStudioConverter.ts:87

`Private`getMapping

getMapping(type: string): undefined | ObjectMapping
Parameters
- type: string
Returns undefined | ObjectMapping
- Defined in packages/vlocity-deploy/src/convert/omniStudioConverter.ts:169

`Private`transformDatapackRecordValue

transformDatapackRecordValue(value: unknown): unknown
Parameters
- value: unknown
Returns unknown
- Defined in packages/vlocity-deploy/src/convert/omniStudioConverter.ts:104