vlocode-project - v1.42.0
    Preparing search index...

    Interface ExportFieldDefinition

    interface ExportFieldDefinition {
        embeddedLookup?: boolean;
        expandArray?: boolean;
        fileName?: string | string[];
        ignoreFields?: string[];
        processor?: string;
        sortFields?: string[];
    }

    Hierarchy

    • ExpandFileDefinition
      • ExportFieldDefinition
    Index

    Properties

    embeddedLookup?: boolean

    When this field is alookup field and this flag is set to true, the related record is exported as an embedded object in the same datapack instead of a separate datapack.

    expandArray?: boolean

    When true expands an array value in the datapack to individual files.

    fileName?: string | string[]

    When set it define the file name to which the export is written. For fields it would mean an new file is created to write the values in this field to. Only set if the intenion is to write the field value to a separate file instead of including it in the main datapack json file.

    When this is a string the string is parsed as format and values between brackets are replace by field values from the object to export, i.e {Name}. When this is defined as an array each value in the array is evaluated as a field value expression and constants need to be prixed with a _:

    name:
    - Name
    - _constantValue
    # OR
    name: "{Name}_constantValue"

    If no extension is provided the extension is inferred from the field type:

    • json: .json
    • binary: .bin
    ignoreFields?: string[]

    When the field is a lookup and embeddedLookup is true, this array defines a list of fields to exclude from the export of the related record.

    This can be used to prevent circular references when exporting related records as embedded objects. For example when exporting an Account with related Contacts as embedded objects, excluding the AccountId field from the Contact export will prevent circular reference between the Account and Contact datapacks.

    processor?: string

    Processor function snippet to use for processing the field data before exporting.

    sortFields?: string[]

    List of fields by which to sort the exported data when exporting as an embedded object.