Create Datamart Table Step – create-data-mart

Type

Description

Type

Description

create-data-mart

Creates a Datamart according to the step specification.

Specific Attributes

Attribute Name

Description

Example

Required

Attribute Name

Description

Example

Required

dmName

Specifies a name of the Datamart.

"dmName": "Standard_Sales_Data"

true

dmLabel

Specifies a label of the Datamart.

"dmLabel": "Standard Sales Data"

true

dataSources

Specifies a list of Data Source names which will be included in the Datamart.

"dataSources": [ "Product" ]

false

sourceName

Specifies a name of the Data Source which will be used as a Datamart source.

"sourceName": "TXStandardData"

true

conditionalDataSources

Specifies a list of Data Sources which will be added if the specified step is not skipped. Each object contains:

  • stepName – Name of a step which must not be skipped to include the Data Source in the Datamart.

  • dataSourceName – Name of a Data Source.

"conditionalDataSources": [ { "stepName": "customer-master", "dataSourceName": "Customer" } ]

false

fieldsWithFunction

Specifies a list of Datamart fields with their specific function in the Datamart. Each object must have these attributes:

  • uniqueName – Name of a field in the Datamart.

  • function – Name of a function supported by Pricefx and Datamart entity.

"fieldsWithFunction": [ { "uniqueName": "PricingDate", "function": "PRICINGDATE" }, { "uniqueName": "Quantity", "function": "PERUNITBASIS" }, { "uniqueName": "InvoicePrice", "function": "PERCENTBASIS" } ]

false

conditionalFields

Allows you to create a Datamart with predefined calculated fields.

The prerequisite is that the field is present in at least one Data Sources used for Datamart creation. Fields in this section will be added only if the fields listed in the condition are added as well. If the Datamart contains the required fields, the field described in the field attribute is added into the list of fields.

"conditionalFields": [ { "requiredFields": ["PricingDate"], "field": { "name": "conditionalField1" } } ]



excludedFields

Excludes fields from the given Data Sources. Fields must be array assigned to the specified Data Source.



Example



PlatformManager version 1.75.0