Skip to main content

Data requirements

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

The topic is organized as follows:

Measures

A measure is a numeric, quantitative field in your data, such as Sales, Profit, or Temperature.

The requirements for measures data are:

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

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

 

Top

Dimensions

A dimension is a categorical, qualitative field in your data, such as Country or 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 will typically be textual or alphanumeric rather than purely numeric; however, purely numeric outputs are allowed.

In Arria for Excel, 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.

Important

To ensure date fields are handled as time dimensions, categorize them as dimensions and set the Entity Type field to DateTime in the Configure Narrative wizard.

excel-arria-set-year-dimension.png

 

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

Date columns

arria-date-columns.png

Supported field names

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

Naming Rule

Example Field Names

*date*

date, Date, DATE, Sales_Date, SALE DateTime

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 Step 1 of the NLG Apps wizard to override date field names and comply with date field naming rules.

 

Supported date formats

The ISO 8601 date and time format (yyyy-mm-dd) is supported. In addition, Arria for Excel supports the following date locales and types by converting them to the ISO 8601 format:

English (US)

English (UK)

French (France)

German (Germany)

Dutch (Netherlands)

mm/dd/yy

dd/mm/yyyy

dd mmmm yyyy

dd.mm.yy

dd-mm-yy

m/dd/yyyy

dd/mm/yy

dd-mmm-yyyy

dd mmmm yyyy

 

Date components across multiple columns

qlik-arria-separate-date-columns.png

Arria's out-of-the-box apps use the following date components:

Years

Supported field names

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

Naming Rule

Example Field 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 Step 1 of the NLG Apps wizard to override date field names and comply with date field 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

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

Naming Rule

Example Field 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 Step 1 of the NLG Apps wizard to override date field names and comply with date field 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

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

Naming Rule

Example Field 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 Step 1 of the NLG Apps wizard to override date field names and comply with date field 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

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

Naming Rule

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 Step 1 of the NLG Apps wizard to override date field names and comply with date field 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