dataLoadDefinition - APEXlang Reference

`dataLoadDefinition`

Parent: app

Children: dataProfileColumn

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=255 The name for the data load definition.

Property Groups:

dataProfile

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=255
`format`	`enum`	Yes	`json`	data type=`string`; lov=`STATIC` Valid values: `csv` `json` `xlsx` `xml`
`rowSelector`	`string`	No		data type=`string`; maxLen=255 Applies when`format in (json)format in (xml)`
`useRawSelectors`	`boolean`	Yes	`false`	data type=`boolean` Applies when`format = json`
`comments`	`multiline string`	No		data type=`multiline string`; maxLen=4000

dataProfile {
  name: value
  format: csv
  rowSelector: value
  useRawSelectors: false
  comments: ```
    value
  ```
}

target

Property	Type	Required	Default Value	Details
`type`	`enum`	Yes	`table`	data type=`string`; lov=`STATIC` Valid values: `table` `collection`
`tableOwner`	`string`	No		data type=`string`; maxLen=32767 Applies when`type = table`
`tableName`	`string`	Yes		data type=`string`; maxLen=128 Applies when`type = table`
`name`	`string`	Yes		data type=`string`; maxLen=128; textCase=`UPPER` Applies when`type = collection`
`loadingMethod`	`enum`	Yes	`append`	data type=`string`; lov=`STATIC` Valid values: `append` `merge` `replace` Applies when`type = table`
`loadingMethod`	`enum`	Yes	`append`	data type=`string`; lov=`STATIC` Valid values: `append` `replace` Applies when`type = collection`

target {
  type: table
  tableOwner: value
  tableName: value
  name: value
  loadingMethod: append
}

advanced

Property	Type	Required	Default Value	Details
`encoding`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `iso-8859-6` `windows-1256` `big5` `gbk` `iso-8859-5` `koi8-r` `koi8-u` `windows-1251` `iso-8859-2` `windows-1250` `iso-8859-7` `windows-1253` `iso-8859-8-i` `windows-1255` `euc-jp` `shift-jis` `euc-kr` `iso-8859-4` `windows-1257` `iso-8859-3` `tis-620` `iso-8859-9` `windows-1254` `us-ascii` `utf-16be` `utf-16le` `utf-8` `windows-1258` `iso-8859-1` `windows-1252`
`numericChars`	`string`	No		data type=`string`; maxLen=2
`xmlNamespaces`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`format = xml`
`csvSeparator`	`string`	No		data type=`string`; maxLen=5 Applies when`format = csv`
`csvEnclosedBy`	`string`	No		data type=`string`; maxLen=1 Applies when`format = csv`
`commitInterval`	`integer`	No		data type=`integer`; maxLen=32767
`defaultXlsxSheetName`	`string`	No		data type=`string`; maxLen=255 Applies when`format = xlsx`
`skipRows`	`number`	No		data type=`number`; maxLen=5 Applies when`format in (csv)format in (xlsx)`
`staticId`	`string`	Yes		data type=`string`; maxLen=255 Use the Static ID to reference the Data Load Definition in API Calls.
`firstLineContainsHeaders`	`boolean`	Yes	`true`	data type=`boolean` Applies when`format in (csv)format in (xlsx)`

advanced {
  encoding: iso-8859-6
  numericChars: value
  xmlNamespaces: ```
    value
  ```
  csvSeparator: value
  csvEnclosedBy: value
  commitInterval: 42
  defaultXlsxSheetName: value
  skipRows: 42
  staticId: value
  firstLineContainsHeaders: false
}

errorHandling

Property	Type	Required	Default Value	Details
`whenOnError`	`enum`	Yes	`stop`	data type=`string`; lov=`STATIC` Valid values: `ignore` `stop` `logErrorIntoCollection` `logIntoErrorLog`
`name`	`string`	Yes		data type=`string`; maxLen=128; textCase=`UPPER` Applies when`whenOnError = logErrorIntoCollection`
`tableName`	`string`	Yes		data type=`string`; maxLen=128 Applies when`whenOnError = logIntoErrorLog`

errorHandling {
  whenOnError: ignore
  name: value
  tableName: value
}

subscription

Property	Type	Required	Default Value	Details
`master`	`reference`	No		data type=`reference`; lov=`COMPONENT`; references=`dataLoadDefinition`

subscription {
  master: @component
}

comments

Property	Type	Required	Default Value	Details
`comments`	`multiline string`	No		data type=`multiline string`; maxLen=4000

comments {
  comments: ```
    value
  ```
}

APEXlang Example

dataLoadDefinition sample (
    name: value
    dataProfile {
        name: value
        format: csv
        rowSelector: value
        useRawSelectors: false
        comments: ```
          value
        ```
    }
    target {
        type: table
        tableOwner: value
        tableName: value
        name: value
        loadingMethod: append
    }
    advanced {
        encoding: iso-8859-6
        numericChars: value
        xmlNamespaces: ```
          value
        ```
        csvSeparator: value
        csvEnclosedBy: value
        commitInterval: 42
        defaultXlsxSheetName: value
        skipRows: 42
        staticId: value
        firstLineContainsHeaders: false
    }
    errorHandling {
        whenOnError: ignore
        name: value
        tableName: value
    }
    subscription {
        master: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)