jsonSource - APEXlang Reference

`jsonSource`

Parent: app

Children: dataProfileColumn

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=255 Enter a name of the JSON Source.
`type`	`enum`	Yes		data type=`string`; lov=`STATIC` Valid values: `tableWithJsonColumn` `jsonCollectionTable`

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
  ```
}

source

Property	Type	Required	Details
`location`	`enum`	Yes	data type=`string`; lov=`STATIC` Valid values: `localDatabase` `restEnabledSql`
`remoteServer`	`reference`	Yes	data type=`reference`; lov=`COMPONENT`; references=`restEnabledSqlDatabase` Applies when`location = restEnabledSql`
`tableOwner`	`string`	No	data type=`string`; maxLen=32767 Select the schema that owns the data source.
`tableName`	`string`	Yes	data type=`string`; maxLen=128 Enter the case-sensitive table name. You can type in the name or pick from the list.
`whereClause`	`multiline string`	No	data type=`multiline string`; maxLen=4000

source {
  location: localDatabase
  remoteServer: @component
  tableOwner: value
  tableName: value
  whereClause: ```sql
    value
  ```
}

advanced

Property	Type	Required	Default Value	Details
`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`
`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 JSON Source in API Calls.
`firstLineContainsHeaders`	`boolean`	Yes	`true`	data type=`boolean` Applies when`format in (csv)format in (xlsx)`

advanced {
  xmlNamespaces: ```
    value
  ```
  csvSeparator: value
  csvEnclosedBy: value
  defaultXlsxSheetName: value
  skipRows: 42
  staticId: value
  firstLineContainsHeaders: false
}

remoteCache

Property	Type	Required	Default Value	Details
`caching`	`enum`	No		data type=`string`; lov=`STATIC` Valid values: `allUsers` `user` `session` Applies when`location = restEnabledSql`
`timeout`	`multiline string`	No		data type=`multiline string`; maxLen=255 Applies when`location = restEnabledSql and caching is set`

remoteCache {
  caching: allUsers
  timeout: ```
    value
  ```
}

subscription

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

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

jsonSource sample (
    name: value
    type: tableWithJsonColumn
    dataProfile {
        name: value
        format: csv
        rowSelector: value
        useRawSelectors: false
        comments: ```
          value
        ```
    }
    source {
        location: localDatabase
        remoteServer: @component
        tableOwner: value
        tableName: value
        whereClause: ```sql
          value
        ```
    }
    advanced {
        xmlNamespaces: ```
          value
        ```
        csvSeparator: value
        csvEnclosedBy: value
        defaultXlsxSheetName: value
        skipRows: 42
        staticId: value
        firstLineContainsHeaders: false
    }
    remoteCache {
        caching: allUsers
        timeout: ```
          value
        ```
    }
    subscription {
        master: @component
    }
    comments {
        comments: ```
          value
        ```
    }
)