Class OmniStudioConverter

Hierarchy

OmniStudioConverter

Index

Constructors

constructor

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

Properties

`Private` logger

logger: ILogger = ...

Methods

convertDatapack

convertDatapack(datapack): 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:22

`Private` convertDatapackRecord

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

convertOmniScript

convertOmniScript(scriptRecord, elements): {
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.
- elements: OmniScriptElementRecord[]
- process: OmniProcessRecord
- Defined in packages/vlocity-deploy/src/convert/omniStudioConverter.ts:120

convertRecord

convertRecord(sobjectType, record): {
    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;
    };
}
- attributes: {
  type: string;
  }
  - 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:137

`Private` getField

getField(data, field): 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:86

`Private` getMapping

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

`Private` transformDatapackRecordValue

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

Class OmniStudioConverter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

logger: ILogger = ...

Returns OmniStudioConverter

Properties

Private logger

Methods

convertDatapack

Parameters

datapack: VlocityDatapack

Returns VlocityDatapack

Throws

Private convertDatapackRecord

Parameters

data: object

Returns object

convertOmniScript

Parameters

scriptRecord: OmniScriptElementRecord

elements: OmniScriptRecord[]

Returns { elements: OmniScriptElementRecord[]; process: OmniProcessRecord; }

elements: OmniScriptElementRecord[]

process: OmniProcessRecord

convertRecord

Parameters

sobjectType: string

record: object

Returns { attributes: { type: string; }; }

attributes: { type: string; }

type: string

Throws

Private getField

Parameters

data: object

field: string

Returns undefined | { name: string; value: unknown; }

Private getMapping

Parameters

type: string

Returns undefined | ObjectMapping

Private transformDatapackRecordValue

Parameters

value: unknown

Returns unknown

Settings

Member Visibility

Theme

On This Page

`Private` logger

`Private` convertDatapackRecord

Returns {
elements: OmniScriptElementRecord[];
process: OmniProcessRecord;
}

Returns {
attributes: {
type: string;
};
}

attributes: {
type: string;
}

`Private` getField

Returns undefined | {
name: string;
value: unknown;
}

`Private` getMapping

`Private` transformDatapackRecordValue