Import & Export Definitions (Datamarts)

This page provides detailed information about import and export definitions for datamarts (Analytics > Data Manager > Datamarts > Import & Export > Import & Export Definitions (JSON)).

Field	Type	Example Value	Description
version	integer	0	A version of a Datamart (mainly used by backend server).
typedId	string	2147483742.DM	ID and Type Code combination.
uniqueName	string	BillingTransactions	Unique name of the Datamart.
label	string	Billing Transactions	Label of the Datamart.
fields	object	Fields Example Values JSON "fields": [ { "name": "Base", "label": "Base", "labelTranslations": {}, "rank": 1, "measureType": "PERUNIT", "visibility": 1, "source": "DMDS.Meatball_transaction", "sourceField": "Base", "expression": "", "system": false, "key": false, "partitioningKey": false, "distributionKey": false, "dimension": false, "aggregation": false, "queryable": true, "auxiliary": false, "deployed": true, "persisted": true, "calculated": false, "calendarField": false, "type": "MONEY", "owningFC": "Meatball_transaction", "messages": {}, "time": false, "hidden": false }, { "name": "Bonus", "label": "Boni", "labelTranslations": {}, "rank": 2, "measureType": "PERUNIT", "visibility": 1, "source": "DMDS.Meatball_transaction", "sourceField": "Bonus", "expression": "", "system": false, "key": false, "partitioningKey": false, "distributionKey": false, "dimension": false, "aggregation": false, "queryable": true, "auxiliary": false, "deployed": true, "persisted": true, "calculated": false, "calendarField": false, "type": "MONEY", "owningFC": "Meatball_transaction", "messages": {}, "time": false, "hidden": false } ]	A list of all the fields that the Datamart includes.
lastUpdateByName	string	john.doe	Username.
source	string	DMDS.Meatball_transaction	The primary Data Source that is used as source of data for the Datamart or an empty string if there is no such source and `sourceless` is set to true.
type	string	DATAMART	Data entity type.
sources	object	JSON `"sources": [ "DMDS.Meatball_transaction", "DMDS.Meatball_productPA", "DMDS.Meatball_customerPA", "DMDS.Meatball_product", "DMDS.Meatball_customer", "DMDS.cal" ],`	A list of the Data Sources that are used as source of data for the Datamart including a primary Data Source. In case Datamart has no primary or secondary Data Sources the value is an empty array.
sourceless	boolean	TRUE	This field is set to true when the Datamart has no Data Sources for retrieving data. In this case, the Datamart behaves more like a Data Source, and queries will return the data exactly as it was loaded, with no data joined from other Data Sources.
sourceName	string	DM.BillingTransactions	This field combines the UniqueName and the Type Code.
baseUomCode	string	EA	Base unit of measure code.
baseCcyCode	string	EUR	Base currency code.
locked	boolean	FALSE	If this field is set to true, Datamart is locked for changes.
valid	boolean	TRUE	This field indicates if a Datamart is valid or not. An invalid Datamart cannot be properly used.
auxiliary	boolean	FALSE	This is a common property for different Field Collections. For Datamarts, it is typically set to false.
deployed	boolean	TRUE	This field indicates if a Datamart has a physical table in the Analytics database (PA DB).
view	boolean	FALSE	This field indicates whether a Datamart is a view, serving as the opposite of the `deployed` field.
keyFields	object	JSON "keyFields": [ { "name": "InvoiceLineID", "label": "Invoice Line ID", "labelTranslations": {}, "rank": 8, "visibility": 1, "source": "DMDS.Meatball_transaction", "sourceField": "InvoiceLineID", "expression": "InvoiceLineID", "system": false, "key": true, "partitioningKey": false, "distributionKey": false, "dimension": true, "aggregation": false, "queryable": true, "auxiliary": false, "deployed": true, "persisted": true, "dbColumn": "attribute3", "dbTable": "seeddata_DM_datamart_transaction", "calculated": false, "calendarField": false, "type": "TEXT", "owningFC": "Meatball_transaction", "messages": {}, "time": false } ],	List of the columns that serve as a keys.
loadableFields	object	JSON `"loadableFields": [ "InvoiceLineID", "Rebate", "PriceGap", "TargetPrice", "TP", "isDeleted", "lastUpdateDate", "formulaResult", "formulaDetailedResults", "warnings", "alerts" ],`	This field is a list of the `localFields` within the Datamart, excluding any calculated fields.
createdBy	integer	2147492707	User ID.
lastUpdateBy	integer	2147492707	User ID.
columnar	boolean	FALSE	If this field is set to true, the refresh data of a Datamart is stored in columnar tables, which can be beneficial in some uses cases. For more information see Columnar Datamart.
isPlasma	boolean	FALSE	If this field is set to true, the Datamart is part of the Plasma Accelerator.
localFields	object	JSON `"localFields": [ "InvoiceLineID", "Rebate", "PriceGap", "TargetPrice", "TP", "isDeleted", "lastUpdateDate", "formulaResult", "formulaDetailedResults", "warnings", "alerts" ],`	A list of fields persisted (stored) in this Datamart, including: Fields created specifically within this Datamart (not imported from other sources). All key fields, including those from all sources. Auxiliary fields.
queryable	boolean	TRUE	If this field is set to false, it is not possible to execute any queries against the Datamart.
messages	object	[-] messages {}	List of messages.
warnings	object	[-] warnings {}	List of warnings.