Skip to main content

Data requirements

This topic covers the input data requirements for NLG Apps and Arria Answers. If you get unexpected results, please check that your data meets the requirements stated below.

The topic is organized as follows:

Note

The topic assumes the data is being uploaded in tabular form (either a CSV or XLSX file).

Measures

A measure is a numeric, quantitative field in your data. Measures in the sample dataset include Sales and Profit.

The requirements for measures are:

  • Decimal numbers must use a period for the decimal separator.

  • If using thousand grouping separators, they must be commas.

  • Aggregation type must be one of the following: Sum, Avg, Min, Max, or Count*.

Tip

*Arria Answers does not support the Count aggregation type.

See Query types for guidance on which aggregation types are required by each type of query.

Tip

Not all aggregation and entity type combinations are supported by every NLG app. See the NLG Apps Directory for app-specific guidance.

 

Top

Dimensions

A dimension is a categorical, qualitative field in your data. Dimensions in the sample dataset include Country and Product.

The values in a dimension field are known as dimension instances. For example, Canada and Germany may be instances of the Country dimension.

There are no formal restrictions for categorical dimensions. The values are typically textual or alphanumeric rather than purely numeric; however, purely numeric outputs are allowed.

In Arria for Qlik Sense, the term time dimension refers to a special type of dimension that contains date values. Time dimensions are used to analyze your data by day, month, quarter, or year. The data requirements for time dimensions are described below.

 

Top

Time dimensions

A time dimension is a particular type of dimension that contains date values. You can use time dimensions to analyze your data by year, quarter, month, or day.

This section provides guidance on valid field names and data values when using time dimensions with NLG Apps and Arria Answers.

Tip

When Arria for Qlik Sense identifies an attribute as a time dimension, the Entity Type field is automatically set to DateTime. If necessary, you can set the entity type in the NLG Apps wizard or the Arria Answers wizard.

There are two ways to store dates in your raw data:

Date columns

Qlik Sense automatically creates a hierarchy of date fields from single date columns in your raw data.

arria-date-columns.png
qlik-arria-date-hierarchy.png

Important

Of the created fields, only Date, Date > Year, Date > Quarter, Date > Month, and Date > Date are supported. Using any other field in the Qlik Sense date hierarchy may result in inaccurate narratives or error messages.

To query your data for a specific day in Arria Answers — e.g. What were my Sales on 5th August? — you must use the Date or Date > Date fields or upload a dataset that separates date components into multiple columns.

Each field in the date hierarchy is counted as a single time dimension. This is important to know when considering the minimum number of time dimensions required by each NLG app. See the Data Requirements section for each app for further information (NLG Apps directory).

 

Supported field names/labels

The standard field names assigned by Qlik Sense are supported: Date, Date > Year, Date > Quarter, Date > Month, Date > Day.

 

Supported date formats

Any data field that is automatically recognized as a date by Qlik Sense is supported by NLG Apps and Arria Answers.

 

Date components across multiple columns

An alternative to a single date column is to spread your date components (year, quarter, month, day) across multiple columns.

Qlik Sense creates a data field for each of these columns in your raw data (outlined in red, below).

qlik-arria-separate-date-columns.png
qlik-arria-date-components.png

NLG Apps and Arria Answers use the following date components:

Years

Supported field names/labels

A single field containing year values must be named as follows:

Naming Rule

Example Column/Attribute Names

y

y, Y

*yr*

yr, YR, Yr_Name, YR of Sales

*year*

year, YEAR, Year_Name, Year of Sales

The asterisks (*) are wildcards that represent one or more spaces, hyphens, or underscores. These rules are case-insensitive.

Tip

You can use the Alias field in the NLG Apps wizard and the Arria Answers wizard to override date column/attribute names and comply with the naming rules.

 

Supported values

A year value must be a two-digit or four-digit number (for example, "22" or "2022").

 

Top

Quarters

Supported field names/labels

A single field containing quarter values must be named as follows:

Naming Rule

Example Column/Attribute Names

q

q, Q

*qt*

qt, QT, Qt_Name, target qt

*qtr*

qtr, QTR, Qtr_Name, target qtr

*quarter*

quarter, QUARTER, Quarter_Name, target quarter

The asterisks (*) are wildcards that represent one or more spaces, hyphens, or underscores. These rules are case-insensitive.

Tip

You can use the Alias field in the NLG Apps wizard and the Arria Answers wizard to override date column/attribute names and comply with the naming rules.

 

Supported values

A quarter value can be given in alphanumeric or numeric form:

Quarter

Example Alphanumeric Values

Example Numeric Values

Quarter 1

Q1, Qt1, Qtr 1, Quarter 1

1

Quarter 2

Q2, Qt2, Qtr 2, Quarter 2

2

Quarter 3

Q3, Qt3, Qtr 3, Quarter 3

3

Quarter 4

Q4, Qt4, Qtr 4, Quarter 4

4

Any combination of the strings "Q", "Qt", "Qtr", and "Quarter" plus a number, with or without spaces, is acceptable for alphanumeric values. Therefore, "Q4", "Q 4", and "4Q" are equally valid. Also, any mixture of cases is acceptable. Therefore, "QUARTER 1" and "qUARTER 1" (to give two alternatives) are valid alternatives to "Quarter 1".

 

Top

Months

Supported field names/labels

A single field containing month values must be named as follows:

Naming Rule

Example Column/Attribute Names

m

m or M

*mon*

mon, MON, Mon_Name, payment mon

*mth*

mth, MTH, Mth_Name, payment mth

*month*

month, MONTH, Month_Name, payment month

The asterisks (*) are wildcards that represent one or more spaces, hyphens, or underscores. These rules are case-insensitive.

Tip

You can use the Alias field in the NLG Apps wizard and the Arria Answers wizard to override date column/attribute names and comply with the naming rules.

 

Supported values

A month value can be given in text or numeric form:

Month

Example Text Values

Example Numeric Values

January

January, Jan

01, 1

February

February, Feb

02, 2

March

March, Mar

03, 3

April

April, Apr

04, 4

May

May

05, 5

June

June, Jun

06, 6

July

July, Jul

07, 7

August

August, Aug

08, 8

September

September, Sep

09, 9

October

October, Oct

10

November

November, Nov

11

December

December, Dec

12

This requirement is case-insensitive, so "JAN", "JAn" and "jan" are valid alternatives to "Jan".

 

Top

Days

Supported field names/labels

A single field containing day values must be named as follows:

Naming Rule

Example Column/Attribute Names

d

d and D

*day*

day, Day, DAY, day_NAME, Day Name

The asterisks (*) are wildcards that represent one or more spaces, hyphens, or underscores. These rules are case-insensitive.

Tip

You can use the Alias field in the NLG Apps wizard and the Arria Answers wizard to override date column/attribute names and comply with the naming rules.

 

Supported values

A day value must be a one-digit or two-digit number (e.g. 5 or 05). Ordinal numbers (e.g. 5th) are invalid.

 

Top