Entity values reference

All sources

Name	Description	Used for	Required	Default
KeyName	The secret name containing the legacy encryption key	Legacy encryption / migration	Only when supplying a legacy encryption key

Notebook

When a notebook cell takes a long time to complete, you can increase the timeout.
If timeout_per_cell_in_seconds is not set as an entity value, the default timeout is 1800 seconds (30 minutes). A higher value than 30 minutes may be necessary for APIs that require pagination.

Name	Description	Required	Default
NotebookName	Name of the notebook used to extract the data	Yes
CustomParametersJSON	Parameter containing JSON-styled key-value pairs	No (Yes for AFAS)
timeout_total_in_seconds	Total timeout for the notebook per entity (in seconds)	No	43200
timeout_per_cell_in_seconds	Timeout for each notebook cell of the entity (in seconds)	No	1800

For the AFAS notebook abbreviation, CustomParametersJSON is required and must contain Environment, Token, KeyColumns, KeyName, and EncryptionKeyVault.

OneLake

Name	Description	Required	Default
Database	Name of database connected to	Yes
SourceLakehouseGuid	GUID of Lakehouse to connect to	Yes
SourceWorkspaceGuid	GUID of workspace where the Lakehouse is located	Yes

ADLS

Name	Description	Required	Default
Container	Container where the data is located	Yes

(S)FTP, ADLS, OneLake Files

Name	Description	Required	Default
Archive	If true, the file is moved to an archive location on the source system after it has been successfully processed.	No	false
ArchiveFolder	Overrides the default archive folder name/path to use when archiving. Only used when Archive = true.	No	Archive
DeleteFromSource	Boolean indicating whether the file(s) need to be deleted after copying to Landing Zone	No	false
NameContainsWildcards	Boolean indicating whether sourceName contains wildcard symbols	No	false

ASQL

Name	Description	Required	Default
CustomQuery	Custom read query	No

ADF

Name	Description	Required	Default
PipelineName	Name of the pipeline in your ADF resource to run	Yes	PL_CUST_XXXX
CustomParametersJSON	Parameter containing JSON-styled key-value pairs	No	{"key1": "xxxx", "key2": "xxxx"}

REST

Name	Description	Used for	Required	Default
LoadPattern	Specifies the handling pattern, for example AFAS or pagination_absolute_url	REST	No	https://...
relative_url	URL of the REST endpoint	REST - ANONYMOUS	Yes	https://...
relative_url	URL of the REST endpoint	REST - ANONYMOUS_PAGINATION	Yes	https://...
pagination_absolute_url	JSON path containing the pagination URL; only used with LoadPattern set to pagination_absolute_url	REST - ANONYMOUS_PAGINATION	No	$.NextPageLink

SAP

The following optional values configure RFC table reads and partitioning. partitionColumnName is required when partitioning is enabled.

Name	Description	Required	Default
customRfcReadTableFunctionModule	Expression for a custom RFC Read Table function module	No
maxPartitionsNumber	Expression for the maximum number of partitions as a whole number	No
partitionColumnName	Expression for the partition column name; required when partitioning is enabled	Conditional
partitionLowerBound	Expression for the lower bound of the partition column in hhmmss format	No
partitionOption	Expression for the partitioning option	No
partitionUpperBound	Expression for the upper bound of the partition column in hhmmss format	No
rfcTableFields	Expression for the columns to extract from the RFC table	No
rfcTableOptions	Expression for the RFC table select query	No

Encryption

When you enable Encryption for sensitive sources, make sure you have configured the variable data_privacy_key_vault on Tenant, Domain, or Environmental level.

Wildcards

Wildcard symbols can be * (matches zero or more characters) and ? (matches exactly one character).

Archiving

Ensure the connection used for the source that is to be archived has write permissions to that location; otherwise archiving may fail.

Note

• Archiving happens only after successful processing of the file. If processing fails, the file is not archived and remains at its original location.
• If ArchiveFolder is not provided, the default archive folder Archive is used.
• ArchiveFolder can be a folder name or path.
• The archive destination path is built using the following pattern:
  /<ArchiveFolder>/<SourceSchema>/<SourceName>/yyyy/mm/dd/<SourceName>_Timestamp/<FileName>
• Archive and DeleteFromSource can be combined. In this case, after successful ingestion, the file is moved to the archive folder first and then deleted.