Vous êtes sur la page 1sur 158

atg

Customer Intelligence
Version 2007.1
Data Warehouse Guide

ATG
One Main Street
Cambridge, MA 02142
www.atg.com

ATG Customer Intelligence Data Warehouse Guide


Document Version
ACI2007.1 DATAWAREHOUSEv1 7/13/07

Copyright
Copyright 2007 Art Technology Group, Inc. All rights reserved.
This publication may not, in whole or in part, be copied, photocopied, translated, or reduced to any electronic medium or machine-readable
form for commercial use without prior consent, in writing, from Art Technology Group, Inc. (ATG) ATG does authorize you to copy
documents published by ATG on the World Wide Web for non-commercial uses within your organization only. In consideration of this
authorization, you agree that any copy of these documents which you make shall retain all copyright and other proprietary notices
contained herein.

Trademarks
ATG, Art Technology Group, and DYNAMO are registered trademarks of Art Technology Group, Inc.
ATG Wisdom, ATG Dynamo Application Server, ATG Adaptive Scenario Engine, ATG Scenario Personalization, ATG Portal, ATG Commerce,
ATG Content Administration, ATG Data Anywhere Architecture, ATG Search, ATG Response Management, ATG Merchandising, ATG
Knowledge, ATG Self Service, ATG Commerce Assist, ATG Advisor, ATG Forum and ATG Business Control Center are trademarks of Art
Technology Group, Inc.
Microsoft, Windows and Word are the trademarks or registered trademarks of Microsoft Corporation in the United States and other countries.
IBM, AIX, and MQ-Series are the trademarks or registered trademarks of IBM Corporation in the United States and other countries. Oracle is a
registered trademark, and other Oracle product names, service names; slogans or logos referenced in this document are trademarks or
registered trademarks of Oracle Corporation. Adobe Acrobat Reader is a registered trademark of Adobe. CORBA is a trademark of the OMG
(Object Management Group). Java and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems,
Inc. in the United States and other countries. Primus, and its respective logo, and Primus Knowledge Solutions, are trademarks, registered
trademarks, or service marks of Primus.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/).
EditLive Authoring Software Copyright 2004 Ephox Corporation. All rights reserved. Includes code licensed from RSA Security, Inc.. Some
portions licensed from IBM are available at http://oss.software.ibm.com/icu4j/. Includes software developed by the Apache Software
Foundation (http://www.apache.org/). Contains spell checking software from Wintertree Software Inc.. The Sentry Spell Checker Engine
2000 Wintertree Software Inc..
All other product names, service marks, and trademarks mentioned herein are trademarks of their respective owners. This publication may
not, in whole or in part, be copied, photocopied, translated, or reduced to any electronic medium or machine-readable form for commercial
use without prior consent, in writing, from Art Technology Group (ATG), Inc. ATG does authorize you to copy documents published by ATG
on the World Wide Web for non-commercial uses within your organization only. In consideration of this authorization, you agree that any
copy of these documents which you make shall retain all copyright and other proprietary notices contained herein.

No Warranty
This documentation is provided as is without warranty of any kind, either expressed or implied, including, but not limited to, the implied
warranties of merchantability, fitness for a particular purpose, or non-infringement.
The contents of this publication could include technical inaccuracies or typographical errors. Changes are periodically added to the
information herein; these changes will be incorporated in the new editions of the publication. ATG may make improvements and/or changes
in the publication and/or product(s) described in the publication at any time without notice.

Limitation of Liability
In no event will ATG be liable for direct, indirect, special, incidental, economic, cover, or consequential damages arising out of the use of or
inability to use this documentation even if advised of the possibility of such damages. Some states do not allow the exclusion or limitation of
implied warranties or limitation of liability for incidental or consequential damages, so the above limitation or exclusion may not apply to
you.
ATG One Main Street Cambridge MA 02142
617.386.1000 phone 617.386.1111 fax www.atg.com

ATG Customer Intelligence Data Warehouse Guide

Contents

Introduction

Audience
Document Conventions
More Information
Introduction to the ATG Data Warehouse
Introduction to the Metadata Model
Key to Column Data Type Names

1
1
2
3
3
5

Platform Database Tables

Localizing Table Data


Time Tables
ARF_CAL_MOY
ARF_CAL_DOW
ARF_CAL_QOY
ARF_TIME_YEAR
ARF_TIME_QTR
ARF_TIME_MONTH
ARF_TIME_WEEK
ARF_TIME_DAY
ARF_TIME_HOUR
ARF_TIME_TOD
Time Loaders
Time Jobs
Time Dimension Handlers
Internal User Directory Tables
ARF_IU_USER
ARF_IU_ORG
ARF_IU_DIR_LVL
Internal User Loaders
Internal User Jobs
Internal User Dimension Handlers
Demographic Tables
ARF_GENDER
ARF_AGE_GROUP
ARF_LANGUAGE
ARF_MARITAL_STATUS
ARF_CURRENCY

7
8
8
9
9
10
10
11
11
12
12
13
13
14
14
14
14
15
15
16
16
16
16
16
17
18
18
19

iii
Contents

ATG Customer Intelligence Data Warehouse Guide

ARF_GEO_COUNTRY
ARF_GEO_REGION
ARF_DEMOGRAPHIC
Segment Tables
ARF_SEGMENT
ARF_SEGCLSTR
ARF_SEGCLTR_MBRS
Stimulus Group Tables
ARF_STIMULUS
ARF_STIMGRP
ARF_STIMGRP_MBRS
User Table
Site Visit Table
Platform ERD

Commerce Database Tables


ARF_CURRENCY_CONV
ARF_CATEGORY
ARF_PRODUCT
ARF_SKU
ARF_PROMOTION
ARF_PROMOGRP
ARF_PROMOGRP_MBRS
ARF_LINE_ITEM
DCS_PROF_PROD_PURCH_FACT
DCS_PROF_BRAND_PURCH_FACT
DCS_PROF_CAT_PURCH_FACT
DCS_PROF_PRICE_FACT
DCS_PROD_AFF_FACT
DCS_PROD_AFF_GLOBAL_FACT
DCS_CAT_AFF_FACT
DCS_CAT_AFF_GLOBAL_FACT
DCS_AFF_EXT_STATUS
DCS_AFF_EXT_STATUS_DAYS
Commerce ERD

Knowledge Database Tables


KDW_CONTROL
KDW_SOLNCLASS_DIM
KDW_SOLNSTATUS_DIM
KDW_AUD_DIM
KDW_ACT_DIM
KDW_OWNGROUP_DIM
KDW_SOLN_DIM
KDW_SOLN_AUD
KDW_SOLN_TOPIC

20
21
21
22
22
23
24
24
24
25
25
26
27
29

31
31
32
33
34
36
37
38
38
44
45
45
46
46
48
49
51
52
52
54

55
55
56
56
56
57
57
57
59
59

iv
Contents

ATG Customer Intelligence Data Warehouse Guide

KDW_SESSACTPK_FACT
KDW_PSESSACTPK
KDW_SACTTOTPK_FACT
KDW_PSACTTOTPK
KDW_AGENTACT_FACT
KDW_SOLNACT_FACT
Knowledge ERD

Response Management Database Tables


DW_RM_CONTROL
DW_RM_CHANNEL
DW_RM_CLS_IMSG
DW_RM_UNCLS_IMSG
DW_RM_USER_OMSG
DW_RM_AUTO_OMSG
DW_TKT_USR_ACT
DW_TKT_CUST_OPN
DW_TKT_USR_OPN
DW_TKT_AUTO_ESC
DW_RM_ROUTING_NODE
DW_SVC_LOG_ORG
Response Management ERD

59
60
60
61
61
62
63

65
65
66
66
67
67
68
69
70
70
71
71
71
72

Outreach Database Tables

73

ARF_CAMPAIGN
ARF_CAMPAIGN_STAGE
ARF_CAMPAIGN_ACTION_TYPE
ARF_CAMPAIGN_ACTION
ARF_CAMPAIGN_EVENT
ARF_LANDING_PAGE
ARF_EMAIL_DOMAIN
ARF_CAMPAIGN_ENTERED_FACT
ARF_CAMPAIGN_ACTION_FACT_TYPE
ARF_CAMPAIGN_ACTION_FACT
ARF_CAMPAIGN_AUDIT_TRAIL_FACT
Outreach ERD

73
74
75
76
77
78
79
79
80
80
81
82

Search Database Tables


ARF_SEARCH_PROJECT
ARF_SEARCH_ENVIRONMENT
ARF_SEARCH_SITE
ARF_QUERY_TYPE
ARF_QUESTION_TYPE
ARF_QUESTION_TYPE_GROUP
ARF_QUESTION_TYPE_GROUP_MBRS
ARF_QUESTION

83
84
84
85
86
87
87
88
88

v
Contents

ATG Customer Intelligence Data Warehouse Guide

ARF_CONTENT
ARF_SEARCH_NUMBER
ARF_SEARCH_NUMBER_GROUP
ARF_SEARCH_NUMBER_GRP_MBRS
ARF_SEARCH_TOPIC
ARF_TOPIC_GROUP
ARF_TOPIC_GROUP_MBRS
ARF_WORD
ARF_WORD_GROUP
ARF_WORD_GROUP_MBRS
ARF_PROFILE_TYPE
ARF_QUERY
ARF_VIEW_CONTENT
ARF_SEARCH_SITE_VISIT
Search ERD

89
89
89
90
90
91
92
92
92
93
93
93
95
96
97

Platform Metadata Model

99

Platform Action Logs


Time Metadata
Gender Metadata
Age Group Metadata
Language Metadata
Marital Status Metadata
Demographic Metadata
Currency Metadata
Country and Region Metadata
Segment Metadata
Stimulus Metadata
User Metadata
Site Visit Metadata

99
100
101
101
102
103
104
104
105
106
107
108
109

Internal User Directory Metadata


Internal User Action Logs
Internal User Directory Model View
Internal User Directory Dimensional View

10 Commerce Metadata Model


Catalog Metadata
Order Metadata
Affinity Metadata
Aggregate Affinity Facts
Personal Affinity Facts

11 Knowledge Metadata Model


Knowledge Action Logs
Knowledge Model View

111
111
112
112

115
115
117
119
119
122

125
125
125

vi
Contents

ATG Customer Intelligence Data Warehouse Guide

Knowledge Dimensional View

12 Response Management Metadata Model


Response Management Action Logs
Response Management Model View
Response Management Dimensional View

13 Outreach Metadata Model


Outreach Model View
Email Recipient Lists
Audit Trail Facts
Email Facts
Participation Facts
Outreach Dimensional View

14 Search Metadata Model


Search Model View
Search Dimensional View

Glossary

126

129
129
129
130

137
137
137
138
139
141
141

143
143
144

147

vii
Contents

ATG Customer Intelligence Data Warehouse Guide

viii
Contents

ATG Customer Intelligence Data Warehouse Guide

1 Introduction

The ATG Customer Intelligence Data Warehouse Guide is a reference book that describes in the ATG data
warehouse in detail. The data warehouse stores all information that can be accessed through ACI reports.
The first half of this book describes the database tables that make up the ATG data warehouse. The
second half provides information about the metadata model, which is accessed through the Framework
Manager and used to build Customer Intelligence reports.
This chapter includes the following sections:
Audience
Document Conventions
More Information
Introduction to the ATG Data Warehouse
Key to Column Data Type Names

Audience
This book is intended for two user audiences:

Database administrators, who may need to know how the data warehouse is
constructed, and the details of the tables it includes.

Report creators, who may need information on the metadata model to create effective
reports.

All readers should be familiar with data warehouses generally, and with ACI concepts and terminology.

Document Conventions
The following conventions are used throughout the documentation:

1
1 - Introduction

ATG Customer Intelligence Data Warehouse Guide

Convention

Explanation

Italics

Introduces new terms and indicates emphasis.

Bold

Emphasizes important information, or indicates field names, menu items, or button


names.

monospace

Indicates syntax examples, values that you specify, or results that you receive.

Brackets [ ]

Indicates optional items. For example, in the following statement: SELECT


[DISTINCT], DISTINCT is an optional keyword.

The directory where you installed ATG 2007.1 is identified as <ATG2007.1Dir>.

More Information
For more information on ATG Customer Intelligence, see the following guides:

Document

Contains Information About

ATG Customer Intelligence Installation


and Configuration Guide

Installation and initial setup of ATG Customer Intelligence.

ATG Query Studio User Guide

Creating simple queries and ad hoc reports using Query


Studio.

ATG Report Studio User Guide

Creating complex, fully formatted reports using Report


Studio.

Administration and Security Guide

Managing servers, security, reports, and Portal Services, as


well as for setting up samples and customization. See your
administrator for more information.

Framework Manager User Guide

Creating and publishing models using Framework


Manager. See your administrator for more information.

Troubleshooting Guide

Helping administrators quickly identify and solve problems


related to the Reporting application. See your administrator
for more information.

For information on the applications that can be used with ACI, see the following books:

ATG Response Management Administration Guide

ATG Commerce Programming Guide

ATG Service Installation and Configuration Guide

2
1 - Introduction

ATG Customer Intelligence Data Warehouse Guide

Introduction to the ATG Data Warehouse


The ATG data warehouse is a relational data base optimized for reporting and analysis. It is populated
from the databases used by the applications in the ATG product suite; these databases are sometimes
referred to as operational or OnLine Transaction Processing (OLTP) databases. The data in the data
warehouse is subject oriented, integrated, informational, non-volatile and time variant.
The diagram that follows shows the position of the data warehouse within a typical ATG installation.

Introduction to the Metadata Model


The metadata model is a business presentation of the information provided by the ATG data warehouse.
The model is used by business users and report creators, rather than working directly with the database.
There are three layers (views) to the metadata model, representing increasing levels of abstraction of the
underlying report data:

Database View. Directly represents the data as it appears in the ATG data warehouse.
The database is queried by Data Source Query Subjects, which map directly to SQL
queries on your database. In the user interface, lines that link data source query
subjects show relationships and cardinality between query subjects.

3
1 - Introduction

ATG Customer Intelligence Data Warehouse Guide

Model View. A more abstract way of interacting with the data, the model view uses
Model Query Subjects to combine Data Source Query Subjects into informational
chunks more easily accessible to a business user.

Dimensional View. An abstraction layer providing the highest-level view of reporting


data, targeted at business users.

Data Source and Model Query Subjects contain query items, which can be used for to retrieve any of the
following item types:

ID. The item is an identifier. Identifiers are usually not of interest to reports. Most ID
fields have ID in the name of the database field.

Fact. Metric, measure, indicator, or other (usually numeric) data that can be
aggregated, and is the focus of reporting. Sales numbers or manufactured units are
examples of facts.

Attribute. Provides the context in which facts can be usefully viewed, such as time or
location.

Reports are composed of combinations of facts and attributes, for example: sales (fact) per month (month
is an attribute of the Time dimension).
The dimensional view is most important to report users. This view shows metrics in terms of their
attributes. It includes the following entities:

Measure dimensions - Facts, counts, numeric data, the things you are trying to
measure, aggregate, and report on.

Regular dimensions - Facts in context of their attributes. For example, $3 million is a


fact; $3 million in revenue for widget foo in 2003 is a fact with two dimensions,
product and time. Regular dimensions define the ways in which measure dimensions
can be organized.

Scope relationships - Relate the measure and the regular dimensions. See dimensional
map in the UI.

4
1 - Introduction

ATG Customer Intelligence Data Warehouse Guide

Another important concept is that of a hierarchy. Hierarchies allow you to roll up or aggregate
information in different levels and then navigate it easily. Dimensions can be composed of multiple
hierarchies (always at least one), which tell you how things roll up. A classic example is time; if you have
year, quarter, month, day, hour, you can define two hierarchies:

year > month > day > hour

year > quarter > month > day > hour

Each item is a level in the hierarchy. Levels also contain attributes. In your reports, you can now provide
two possible levels at which the end-user can explore data.
For more information on metadata modeling, see the Framework Manager User Guide.

Key to Column Data Type Names


Database vendors sometimes use different names for similar data types. The table that follows shows the
names used in this document and the equivalents used by various database vendors.

This Guide

Oracle

MS-SQL

Sybase

DB2

SOLID

MySQL

char

char

char

char

char

char

char

varchar

varchar2

varchar

varchar

varchar

varchar

varchar

one-digit

number(1,0)

tinyint

tinyint

numeric(1,0)

tinyint

tinyint

tinyint

number(3,0)

tinyint

tinyint

numeric(3,0)

tinyint

tinyint

smallint

number(5,0)

smallint

smallint

smallint

smallint

smallint

integer

number(10,0)

integer

integer

integer

integer

integer

bigint

number(19,0)

bigint

number(19,0)

bigint

bigint

bigint

numeric

number

numeric

numeric

numeric

numeric

numeric

datetime

date

datetime

datetime

timestamp

timestamp

datetime

timestamp

timestamp

datetime

datetime

timestamp

timestamp

datetime

5
1 - Introduction

ATG Customer Intelligence Data Warehouse Guide

6
1 - Introduction

ATG Customer Intelligence Data Warehouse Guide

2 Platform Database Tables

This chapter describes the ATG data warehouse database tables that are included with every ACI
installation, and are not related to any particular ATG application. It includes the following sections:
Localizing Table Data
Time Tables
Internal User Directory Tables
Demographic Tables
Segment Tables
Stimulus Group Tables
User Table
Site Visit Table
Platform ERD
Each section includes a description of the table(s) and, if applicable, how the information is updated in the
data warehouse. Some tables contain information that can (or should) be regularly reloaded, while others
contain more static data.

Localizing Table Data


Many tables contain a pair of column_name and column_name_EN columns. These are used to support
sites that use multiple languages. In these cases, the column_name column holds the default version of
the data, which is used if no locale is specified for the report. The column_name_EN column holds the data
in English. You can add additional columns with additional languages if necessary. For example, to add
gender data in French, add a GENDER_NAME_FR column to the ARF_GENDER table.
When a user is working with the metadata model, the ATGDW metadata model allows the Framework
Manager to select the appropriate column to display based on the users locale. If the users locale is not
known or there is no column for that locale, then data from the default column is used.

7
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

Time Tables

The database view is shown in the figure below. It is made up of ten tables, seven of which are used to
store an instant in time and three which are used to store auxiliary data.
The tables beginning with ARF_TIME store data about an instant in time. In essence they provide
individual access every piece of data that might be represented in a timestamp. This allows the same
report query to be used with multiple databases, which may have different date and time storage. It also
improves report performance; for example, there is no need to perform extraction functions on
timestamp data to retrieve just the month.

ARF_CAL_MOY
The ARF_CAL_MOY table stores names and order information for the twelve months of the year.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

SHORT_NAME

varchar

No

Name of the month in short format;


for example:
NOV

8
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

LONG_NAME

varchar

No

Name of the month in long format;


for example:
NOVEMBER

MONTH_OF_YEAR

tinyint

No

The number of the month within a


year, for example:
11

ARF_CAL_DOW
The ARF_CAL_DOW table stores names and order information for the seven days of the week. To change
the day on which your week begins, change the numeric data in the DAY_OF_WEEK column. By default
the week begins on Monday (1) and ends with Sunday (7).

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

SHORT_NAME

varchar

No

Name of the day in short format; for


example:
WED

LONG_NAME

varchar

No

Name of the day in long format; for


example:
WEDNESDAY

DAY_OF_WEEK

tinyint

No

The number of the day within a week,


for example:
4

ARF_CAL_QOY
This table stores names and order information for the years four quarters.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

QTR_OF_YEAR

tinyint

No

The number of the quarter within a


year, for example:
2

9
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

SHORT_NAME_EN

varchar

No

Name of the quarter in short form,


for example:
Q1

LONG_NAME_EN

varchar

No

Name of the quarter in long form, for


example:
Quarter 1

ARF_TIME_YEAR
The ARF_TIME_YEAR table stores the year part of an instant. There is one row for each year on which you
want to report.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

YEAR_OF_ERA

smallint

No

The year part of the instant. For


example:
2006

YEAR_TIMESTAMP

timestamp

No

A timestamp representing the


beginning of the year. By default
this is midnight (Coordinated
Universal Time) on 1 January.

ARF_TIME_QTR
This table stores quarter information for an instant. There is one row for each quarter of each year of
interest for reporting.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

YEAR_ID

varchar

40

No

Foreign key to ARF_TIME_YEAR.ID


column.

QOY_ID

varchar

40

No

Foreign key to ARF_CAL_QOY.ID


column.

10
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

QTR_TIMESTAMP

timestamp

No

A timestamp representing the


beginning of the quarter. By
default this is midnight
(Coordinated Universal Time) on 1
January, 1 April, 1 July, and 1
October of each year.

QTR_OF_YEAR

tinyint

No

The number of the quarter within


a year, for example:
2

ARF_TIME_MONTH
The ARF_TIME_MONTH table stores the month part of an instant. There is one row for each month in each
year of interest for reporting.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

YEAR_ID

varchar

40

No

Foreign key to
ARF_TIME_YEAR.ID column.

QTR_ID

varchar

40

No

Foreign key to
ARF_TIME_QTR.ID column.

MOY_ID

varchar

40

No

Foreign key to
ARF_CAL_MOY.ID column.

MONTH_OF_YEAR

tinyint

No

Integer between 1 and 12, the


number of the month within a
year.

MONTH_TIMESTAMP

timestamp

No

A timestamp representing the


beginning of the month.

ARF_TIME_WEEK
The ARF_TIME_WEEK table stores the week part of an instant. There is one row for each week of each year
of interest for reporting.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

11
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

YEAR_ID

varchar

WEEK_OF_YEAR

WEEK_TIMESTAMP

40

No

Foreign key to
ARF_TIME_YEAR.ID column.

tinyint

No

Integer between 1 and 53, the


number of the week within the
year.

timestamp

No

A timestamp representing the


beginning of the week.

ARF_TIME_DAY
The ARF_TIME_DAY table is used to store the day part of an instant. There is one row for each day in one
year.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

WEEK_ID

varchar

40

No

Foreign key to ARF_TIME_WEEK.ID


column.

MONTH_ID

varchar

40

No

Foreign key to
ARF_TIME_MONTH.ID column.

DOW_ID

varchar

40

No

Foreign key to ARF_CAL_DOW.ID


column.

DAY_TIMESTAMP

timestamp

No

Timestamp representing the


beginning of the day.

DAY_OF_WEEK

tinyint

No

Integer between 1 and 7, the


number of the day within the
week.

DAY_OF_MONTH

tinyint

No

Integer between 1 and 31, the


number of the day within the
month.

DAY_OF_YEAR

smallint

No

Integer between 1 and 366, the


number of the day within the year.

ARF_TIME_HOUR
The ARF_TIME_HOUR table stores the hour part of an instant. There is one row for each hour of one day.

12
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

DAY_ID

varchar

40

No

Foreign key to
ARF_TIME_DAY.ID column.

HOUR_TIMESTAMP

timestamp

No

Timestamp representing the


beginning of the hour.

HOUR_OF_DAY

tinyint

No

Integer between 0 and 23, the


number of the hour within the
day.

ARF_TIME_TOD
This table has information about the time of day. There is one row for each minute of one day,
representing clock time.

Column Name

Type

ID

Length

Null Allowed

Description

int

No

Identifier; primary key.

HOUR_OF_DAY

tinyint

No

Integer between 0 and 23,


indicating the hour within the
day.

MIN_OF_HOUR

tinyint

No

Integer between 0 and 59, the


number of the minute within the
hour.

MIN_OF_DAY

smallint

No

Integer between 0 and 1439, the


number of the minute within the
day.

HALFDAY_OF_DAY

tinyint

No

Either 0 (indicating AM) or 1


(indicating PM).

HOUR_OF_HALFDAY

tinyint

No

Integer between 0 and 11,


indicating the hour within a
twelve-hour half day.

Time Loaders
The global Nucleus component /atg/reporting/datawarehouse/loaders/TimeRepositoryLoader
loads time data into the data warehouse. The loadTime method can be used to load time data between
two dates. The component also contains operations used to load and lookup year, month, week, day and
hour parts of the instant.

13
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

Time Jobs
The global component

/atg/reporting/datawarehouse/process/jobs/TimeRepositoryLoaderJob periodically loads

time data into the data warehouse. By default the job is scheduled to run every two weeks and load two
weeks of data into the data warehouse.
The TimeRepositoryLoaderJob can be configured to load time from a date in the past by changing the
startDate property. The frequency and the interval of time loaded by this job can be configured by
changing the duration property and the schedule property.

Time Dimension Handlers


A report summary service dimension handler to be used in conjunction with the time series data in the
data warehouse is available. The name of the class implementing this feature is
atg.reporting.summary.TimeRepositoryDimensionHandler and is packaged with the
ARF.DW.base module. This dimension handler can be used to summarize data on the hour(default), day,
month, week, or year level.

Internal User Directory Tables


This section describes the database tables that comprise the internal user directory.

ARF_IU_USER
The ARF_IU_USER table stores data about internal users. Internal users are users based within your
company. For example, customer service agents using ATG Knowledge are internal users, while customers
at an ATG Commerce site are external users.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

USER_ID

varchar

40

No

User ID

LOGIN

varchar

40

No

Users login

FIRST_NAME

varchar

40

No

Users first name

LAST_NAME

varchar

40

Yes

Users last name

PARENT_ORG_ID

varchar

40

Yes

ID of the organization to which the


user belongs. Foreign key to
ARF_IU_ORG tables ID column.

14
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

DIR_LVL_ID

varchar

LAST_UPDATED

timestamp

DELETED

numeric

40

No

Identifies the level to which this


user belongs. Foreign key to
ARF_IU_DIR_LVL tables ID
column.

No

Date and time this record was last


updated.

No

Indicates whether the record has


been deleted.

ARF_IU_ORG
The ARF_IU_ORG table stores data about internal organizations.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

ORG_ID

varchar

40

No

NAME_EN

varchar

40

No

Name of the organization in


English.

DESCRIPTION_EN

varchar

254

Yes

Description of the organization in


English.

PARENT_ORG_ID

varchar

40

Yes

Identifier of the parent


organization, if applicable. Foreign
key to the ID column of this table.

DIR_LVL_ID

varchar

40

No

Identifies the level of this


organization. Foreign key to the ID
column of the ARF_IU_DIR_LVL
column.

LAST_UPDATED

timestamp

No

Date this record was last updated

DELETED

numeric

No

Whether this record indicates


deleted organization.

ARF_IU_DIR_LVL
The ARF_IU_DIR_LVL table stores the levels of the hierarchy. By default, there are ten levels to which
organizations can be assigned.

15
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

NAME_EN

varchar

40

No

Level name in English.

DEPTH

smallint

No

Identifies the levels depth.

PARENT_ID

varchar

Yes

Parent level of this level, if applicable.


Foreign key to the ID column of this
table.

40

Internal User Loaders


The global Nucleus service
/atg/reporting/datawarehouse/loaders/InternalUserDirectoryLoader loads user directory
data into the data warehouse. The services loadUser method loads a user and its ancestors into the data
warehouse. The services loadOrganization method loads an organization and its ancestors into the

data warehouse.

Internal User Jobs


The global service
/atg/reporting/datawarehouse/process/jobs/InternalUserDirectoryLoaderJob periodically
loads internal user directory data into the data warehouse. By default the service is scheduled to run every
night. This service is started as part of the ARF.DW.InternalUsers module.

Internal User Dimension Handlers


A report summary service dimension handler to be used in conjunction with the internal user directory
data in the data warehouse is available. The name of the class implementing this feature is
atg.reporting.summary.InternalUserDimensionHandler. A different dimension handler as exists
for handling internal organizations. The name of this class is
atg.reporting.summary.InternalOrganizationDimensionHandler. These two dimension
handlers are packaged with the ARF.DW.InternalUsers module.

Demographic Tables
This section describes the group of tables that provide demographic data for reports.

ARF_GENDER
The ARF_GENDER table is preloaded with three genders: male, female, and unspecified.

16
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

ID

tinyint

GENDER_NAME

varchar

GENDER_NAME_EN

varchar

Length

Null Allowed

Description

No

Identifier; primary key.

40

No

Name of gender in the default


language.

40

Yes

Name of gender in English.

ARF_AGE_GROUP
The ARF_AGE_GROUP table defines ranges for age groups into which users can be categorized, and
provides names for the ranges.
To change the ranges of an age group, you can modify the AGE_MIN, AGE_MAX, AGE_GROUP_NAME and
AGE_GROUP_NAME_EN values. The default groups are:

Unspecified

0-17

18-24

25-34

35-44

45-54

55+

Column Name

Type

ID

tinyint

AGE_GROUP_NAME

varchar

AGE_GROUP_NAME_EN

varchar

AGE_MIN

AGE_MAX

Length

Null Allowed

Description

No

Identifier; primary key.

40

No

Name of age group in the


default language.

40

Yes

Name of age group in English.

tinyint

No

Determines the lower


boundary for membership in
the age group.

tinyint

No

Determines the upper


boundary for membership in
the age group.

17
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

ARF_LANGUAGE

This table holds a list of languages that can be referenced by other tables. It uses the ISO 639-1 and 639-2
codes.

Column Name

Type

Length

Null Allowed

Description

ID

smallint

No

Identifier; primary key.

LANG_NAME

varchar

254

No

Name of language in default


language.

LANG_NAME_EN

varchar

254

Yes

Name of language in English.

ISO_639_1_ALPHA2

char

Yes

ISO 639-1 two-letter


alphabetic code for the
language.

ISO_639_2_ALPHA3

char

No

ISO 639-1 three-letter


alphabetic code for the
language.

RECORD_START_DATE

timestamp

Yes

Date when the information


in this warehouse record
became effective.

RECORD_END_DATE

timestamp

Yes

Date when the information


in this warehouse record is
no longer effective.

ARF_MARITAL_STATUS
This table provides marital statuses that can be referenced by other tables. The default statuses provided
are:

Unspecified

Married

Single

Column Name

Type

ID

tinyint

MARITAL_STATUS_NAME

varchar

MARITAL_STATUS_NAME_EN

varchar

Length

Null Allowed

Description

No

Identifier; primary key.

40

No

Name of the status in the


default language.

40

Yes

Name of the status in


English.

18
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

ARF_CURRENCY
The ARF_CURRENCY table stores a list of currencies for reference. It uses the ISO 4217 codes. The provided
currencies are:

Australian Dollar

Canadian Dollar

Yuan Renminbi

Japanese yen

Mexican Peso

Russian Ruble

Rand

Swiss Franc

Pound Sterling

US Dollar

Euro

Unspecified

Column Name

Type

ID

smallint

CURRENCY_NAME

varchar

CURRENCY_NAME_EN

Length

Null Allowed

Description

No

Identifier; primary key.

254

No

Name of currency in the


default language.

varchar

254

Yes

Name of currency in English.

ISO4217_ALPHA3

char

No

ISO 4217 three-letter


alphabetic code for the
currency.

ISO4217_NUM3

smallint

Yes

ISO 4217 three-number


numeric code for the
currency.

RECORD_START_DATE

timestamp

Yes

Date when the information in


this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information in


this warehouse record is no
longer effective.

19
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

ARF_GEO_COUNTRY
The ARF_GEO_COUNTRY table stores a list of countries for reference. It uses the ISO 3166 and FIPS codes.
The provided countries are:

Australia

Canada

China

France

Germany

Italy

Japan

Mexico

Russian Federation

South Africa

Spain

Switzerland

United Kingdom

United States

Unspecified

Column Name

Type

ID

smallint

COUNTRY_NAME

varchar

COUNTRY_NAME_EN

Length

Null Allowed

Description

No

Identifier; primary key.

254

No

Name of country in the


default language.

varchar

254

Yes

Name of country in English.

ISO3166_1_ALPHA2

char

Yes

ISO 3166 two-character


alphabetic code for the
country.

ISO3166_1_ALPHA3

char

Yes

ISO 3166 three-character


alphabetic code for the
country.

ISO3166_1_NUM3

smallint

Yes

ISO 3166 three-character


numeric code for the country.

FIPS10_4_CODE

char

Yes

FIPS four-digit code for the


country.

20
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

RECORD_START_DATE

timestamp

Yes

Date when the information in


this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information in


this warehouse record is no
longer effective.

ARF_GEO_REGION
The ARF_GEO_REGION table stores a list of regions for reference. It uses the ISO 3166 and FIPS codes. The
provided regions include all US states and Canadian provinces.

Column Name

Type

ID

Length

Null Allowed

Description

smallint

No

Identifier; primary key.

COUNTRY_ID

smallint

No

Identifier of the country of


which the region is a part (see
the ARF_GEO_COUNTRY
table).

REGION_NAME

varchar

254

No

Name of region in the default


language.

REGION_NAME_EN

varchar

254

Yes

Name of region in English.

ISO_3166_2_CODE

char

Yes

ISO 3166 two-character code


for the region.

FIPS10_4_CODE

char

Yes

FIPS code for the region.

RECORD_START_DATE

timestamp

Yes

Date when the information in


this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information in


this warehouse record is no
longer effective.

ARF_DEMOGRAPHIC
This table contains one row for each possible combination of gender, age group, marital status, and
region.

21
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

ID

Length

Null Allowed

Description

smallint

No

Identifier; primary key.

GENDER_ID

tinyint

No

Foreign key to ARF_GENDER.ID


column.

AGE_GROUP_ID

tinyint

No

Foreign key to
ARF_AGE_GROUP.ID column.

MARITAL_STATUS_ID

tinyint

No

Foreign key to
ARF_MARITAL_STATUS.ID
column..

REGION_ID

smallint

No

Foreign key to
ARF_GEO_REGION.ID column.

Segment Tables
The segment tables contain information about segments and segment clusters to which customers can
belong.

ARF_SEGMENT
Customers are assigned to segments based on rules created in the ATG Business Control Center.
Customers can be members of multiple segments. Segments are also known as profile groups.

Column Name

Type

ID

smallint

NSEGMENT_ID

varchar

SEGMENT_NAME

Length

Null Allowed

Description

No

Identifier; primary key.

254

No

Natural key of segment.

varchar

254

No

Name of segment.

SEGMENT_DESC

varchar

254

Yes

Description of segment.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the information


in this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information


in this warehouse record is
no longer effective.

22
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.
0 = No
1 = Yes

DELETED

one-digit

No

Indicates that this record


has been deleted.
0= No
1 = Yes

ARF_SEGCLSTR
A segment cluster represents the group of segments of which a particular person is a member. For
example,
Segment A
Segment B
Segment C
Segment D
Segment E
Segments B and D are a bold cluster, while C and E are an Italic cluster. There are 2^5 possible
combinations of two segments in this example; each potential cluster must have a unique name.
Since a person can belong to multiple segments, reporting sales by segment alone can give deceptive
results. Segment clusters show how users group themselves.

Column Name

Type

ID

int

NAME

varchar

HASH_VALUE

varchar

LENGTH

tinyint

Length

Null Allowed

Description

No

Identifier; primary key.

254

Yes

Segment cluster name.

256

No

Used during data loading.

No

Size of the cluster segment. In the


example used above, the length of the
Bold segment is 2.

23
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

ARF_SEGCLTR_MBRS
This table relates the individual segments to their cluster. It contains a row for each segment in a segment
cluster.

Column Name

Type

SEGCLSTR_ID

Length

Null Allowed

Description

integer

No

Foreign key to ARF_SEGCLSTR.ID


column. Primary key component.

SEGMENT_ID

smallint

No

Foreign key to ARF_SEGMENT.ID


column. Primary key component.

MEMBER

tinyint

Indicates that the segment is a member


of the cluster. Primary key component.

Stimulus Group Tables


The stimulus group tables hold information about what motivated the customer to place an order, such
as which ATG Outreach campaign might have prompted it.

ARF_STIMULUS
This table contains the list of stimuli that can be used in the system.

Column Name

Type

ID

smallint

NSTIMULUS_ID

varchar

STIMULUS_DESC

Length

Null Allowed

Description

No

Identifier; primary key.

254

No

Natural key for stimulus.

varchar

254

Yes

Name given to stimulus.

STIMULUS_TYPE

varchar

254

Yes

Type of stimulus.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the information


in this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information


in this warehouse record is
no longer effective.

24
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.
0 = No
1 = Yes

DELETED

one-digit

No

Indicates that this record


has been deleted.
0= No
1 = Yes

ARF_STIMGRP
Orders have more than one stimulus, so as with segments, the list of all possible stimulus groups is
determined and stored in this table.

Column Name

Type

ID

int

NAME

varchar

HASH_VALUE

varchar

LENGTH

tinyint

Length

Null Allowed

Description

No

Identifier; primary key.

254

Yes

Stimulus group name.

256

No

Used during data


loading.

No

Size of the stimulus


group.

ARF_STIMGRP_MBRS
This table relates individual stimuli to stimulus groups.

Column Name

Type

STIMGRP_ID

STIMULUS_ID

Length

Null Allowed

Description

integer

No

Foreign key to ARF_STIMGRP.ID


column. Primary key component.

smallint

No

Foreign key to ARF_STIMULUS.ID


column. Primary key component.

25
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

User Table

The ARF_USER table contains information from the users profile.

Column Name

Type

ID

int

NUSER_ID

varchar

LOGIN

Length

Null Allowed

Description

No

Identifier; primary key.

40

No

Natural key of user.

varchar

40

No

Users login.

FIRST_NAME

varchar

40

Yes

Users first name.

MIDDLE_NAME

varchar

40

Yes

Users middle name.

LAST_NAME

varchar

40

Yes

Users last name.

EMAIL

varchar

255

Yes

Users email address.

DATE_OF_BIRTH

date

Yes

Users date of birth.

LANG_ID

smallint

No

Identifier of language from


the ARF_LANGUAGE table.

GENDER_ID

tinyint

No

Identifier of gender from


the ARF_GENDER table.

MARITAL_STATUS_ID

tinyint

No

Identifier of marital status


from the
ARF_MARITAL_STATUS
table.

HOME_REGION_ID

smallint

No

Identifier of the region of


the users home address,
from the ARF_GEO_REGION
table.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the information


in this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information


in this warehouse record is
no longer effective.

26
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.
0 = No
1 = Yes

DELETED

one-digit

No

Indicates that this record


has been deleted.
0= No
1 = Yes

Site Visit Table


The ARF_SITE_VISIT table stores information about visits to your Web site. There is one row per visit.

Column Name

Type

SITE_VISIT_ID

bigint

START_DAY_ID

varchar

START_TIME_ID

VISITOR_ID

Length

Null Allowed

Description

No

Identifier; primary key.

No

Day the site visit began. Foreign


key to ARF_TIME_DAY.ID
column.

integer

No

Time the site visit began. Foreign


key to ARF_TOD.ID column.

integer

No

User ID of visitor. Foreign key to


ARF_USER.ID column.

40

If visitor is anonymous, this is set


to Unspecified User.
STIMGRP_ID

smallint

No

Stimulus group associated with


the visit. Foreign key to
ARF_STIMGRP.ID column.

DEMOGRAPHIC_ID

smallint

No

Demographic which represents


the demographic profile of this
site visit
Foreign key to
ARF_DEMOGRAPHIC.ID column.

SESSION_ID

varchar

128

No

Session ID of the visit, from the


application server.

27
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

NUM_PAGE_VIEWS

smallint

No

Number of pages the visitor


viewed during the visit.

DURATION_SECONDS

smallint

No

Duration of the visit in seconds.

28
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

Platform ERD

29
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

30
2 - Platform Database Tables

ATG Customer Intelligence Data Warehouse Guide

3 Commerce Database Tables

This chapter describes the tables in the ATG data warehouse that are used exclusively by the ATG
Commerce application. Commerce reports also make use of the tables described in the Platform Database
Tables chapter.
This chapter includes the following sections:
ARF_CURRENCY_CONV
ARF_CATEGORY
ARF_PRODUCT
ARF_SKU
ARF_PROMOTION
ARF_PROMOGRP
ARF_PROMOGRP_MBRS
ARF_LINE_ITEM
DCS_PROF_PROD_PURCH_FACT
DCS_PROF_BRAND_PURCH_FACT
DCS_PROF_CAT_PURCH_FACT
DCS_PROF_PRICE_FACT
DCS_PROD_AFF_FACT
DCS_PROD_AFF_GLOBAL_FACT
DCS_CAT_AFF_FACT
DCS_CAT_AFF_GLOBAL_FACT
DCS_AFF_EXT_STATUS
DCS_AFF_EXT_STATUS_DAYS
Commerce ERD

ARF_CURRENCY_CONV
This table holds information used to convert currencies in customer orders.

31
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

Length

Null Allowed

Description

DAY_ID

varchar

40

No

Primary key component.


Foreign key to
ARF_TIME_DAY.ID
column.

SRC_CURRENCY_ID

smallint

No

Currency to be
converted from. Primary
key component. Foreign
key to
ARF_CURRENCY.ID
column.

DST_CURRENCY_ID

smallint

No

Currency to be
converted to. Primary
key component. Foreign
key to
ARF_CURRENCY.ID
column.

SRC_DST_CONVERSION_RATE

double

No

Conversion rate from the


source to the
destination currency.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

DST_SRC_CONVERSION_RATE

double

No

Conversion rate from the


destination to the
source currency.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

ARF_CATEGORY
This table stores category information from your product repository. There is one row per category.

32
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

NCATEGORY_ID

varchar

40

No

Natural ID for the category.

NAME

varchar

254

No

Category name in the


default language.

NAME_EN

varchar

254

Yes

Category name in English.

DESCRIPTION

varchar

254

Yes

Category description in the


default language.

DESCRIPTION_EN

varchar

254

Yes

Category description in
English.

PARENT_CAT_ID

int

Yes

ID of the parent category, if


applicable. Foreign key to
ARF_CATEGORY.ID column.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the information


in this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information


in this warehouse record is
no longer effective.

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.
0 = No
1 = Yes

DELETED

one-digit

No

Indicates that this record


has been deleted.
0= No
1 = Yes

ARF_PRODUCT
This table stores product information from your product repository. There is one row per product.

33
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

NPRODUCT_ID

varchar

40

No

Natural key of product.

NAME

varchar

254

No

Product name in the default


language.

NAME_EN

varchar

254

Yes

Product name in English.

DESCRIPTION

varchar

254

Yes

Product description in the


default language.

DESCRIPTION_EN

varchar

254

Yes

Product description in
English.

PARENT_CAT_ID

int

Yes

ID of the products parent


category, if applicable.
Foreign key to
ARF_CATEGORY.ID column.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the information


in this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information


in this warehouse record is
no longer effective.

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.
0 = No
1 = Yes

DELETED

one-digit

No

Indicates that this record


has been deleted.
0= No
1 = Yes

ARF_SKU
This table stores SKU information from your product repository. There is one row per SKU.

34
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

NSKU_ID

varchar

40

No

Natural key of SKU.

NAME

varchar

254

No

SKU name in the default


language.

NAME_EN

varchar

254

Yes

SKU name in English.

DESCRIPTION

varchar

254

Yes

SKU description in the


default language.

DESCRIPTION_EN

varchar

254

Yes

SKU description in
English.

PARENT_PROD_ID

int

Yes

ID of the SKUs parent


product. Foreign key to
ARF_PRODUCT.ID
column.

WHOLESALE_PRICE

double

Yes

Wholesale price of the


item represented by the
SKU.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

LIST_PRICE

double

Yes

List price of the item


represented by the SKU.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

SALE_PRICE

double

Yes

Sale price of the item


represented by the SKU.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

35
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

ON_SALE

numeric or
tinyint

1 (for
numeric)

Yes

Indicates whether or
not the item is currently
on sale.
0 = No
1 = Yes

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the


information in this
warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the


information in this
warehouse record is no
longer effective.

MOST_RECENT

one-digit

No

Indicates that this


record is the most
recent.
0 = No
1 = Yes

DELETED

one-digit

No

Indicates that this


record has been
deleted.
0= No
1 = Yes

ARF_PROMOTION
This table holds information about product promotions.

Column Name

Type

ID

smallint

NPROMO_ID

varchar

Length

40

Null Allowed

Description

No

Identifier; primary key.

No

Natural key of promotion.

36
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

PROMO_NAME

varchar

254

No

Promotion name in the


default language.

PROMO_NAME_EN

varchar

254

Yes

Promotion name in English.

PROMO_DESC

varchar

254

Yes

Promotion description in
the default language.

PROMO_DESC_EN

varchar

254

Yes

Promotion description in
English.

PROMO_TYPE

varchar

254

Yes

Promotion type.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the information


in this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information


in this warehouse record is
no longer effective.

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.
0 = No
1 = Yes

DELETED

one-digit

No

Indicates that this record


has been deleted.
0= No
1 = Yes

ARF_PROMOGRP
This table holds information about promotion groups.

Column Name

Type

ID

smallint

NAME

varchar

Length

254

Null Allowed

Description

No

Identifier; primary key.

No

Name of the promotion


group.

37
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

HASH_VALUE

varchar

LENGTH

smallint

256

No

Used during data loading.

No

Size of the promotion group.

ARF_PROMOGRP_MBRS
This table relates the individual promotions to their promotion groups. It contains a row for each
promotion in a promotion group.

Column Name

Type

PROMO_GRP_ID

PROMOTION_ID

Length

Null Allowed

Description

smallint

No

Primary key component. Foreign key


to ARF_PROMOGRP.ID column.

smallint

No

Primary key component. Foreign key


to ARF_PROMOTION.ID column.

ARF_LINE_ITEM
This table contains one row for every line item in every order placed by customers. Note the following:

Discount refers to any amount subtracted from the price of the item or the order, such
as coupons.

Tax and shipping costs are applied to an order. The pipeline processors that populate
the data warehouse allocate these costs across line items. See the ATG Commerce
Programming Guide for information on these processors.

Local currency refers to the currency in which the customer pays; standard currency is
the currency used for reporting.

Column Name

Type

Length

Null
Allowed

Description

SUBMIT_DAY_ID

varchar

40

No

Day order was


submitted. Foreign key
to ARF_TIME_DAY.ID
column.

38
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

SUBMIT_TIME_ID

int

No

Time the order was


submitted. Foreign key
to ARF_TIME_TOD.ID
column.

SKU_ID

int

No

Identifier of SKU
ordered. Foreign key to
ARF_SKU.ID column.

PRODUCT_ID

int

No

Identifier for items


product. Foreign key to
ARF_PRODUCT.ID
column.

CATEGORY_ID

int

No

Identifier for items


category. Foreign key
to ARF_CATEGORY.ID
column.

CUSTOMER_ID

int

No

Customers user ID.


Foreign key to
ARF_USER.ID column.

STIM_GRP_ID

smallint

No

Reference to the group


of stimuli that may
have stimulated the
order. Foreign key to
ARF_STIMGRP.ID
column.

SEGCLSTR_ID

int

No

Identifier of segment
cluster of which the
customer is a member.
Foreign key to
ARF_SEGCLSTR.ID
column.

PROMOGRP_ID

int

No

Identifier of promotion
group that applies to
the line item. Foreign
key to
ARF_PROMOGRP.ID
column.

BILLING_REGION_ID

smallint

No

Identifier for the region


of the customers
billing address. Foreign
key to
ARF_GEO_REGION.ID
column.

39
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

SHIPPING_REGION_ID

smallint

No

Identifier for the region


of the customers
shipping address.
Foreign key to
ARF_GEO_REGION.ID
column.

LOCAL_CURRENCY_ID

smallint

No

Currency in which the


line item was
purchased. Foreign key
to ARF_CURRENCY.ID
column.

DEMOGRAPHIC_ID

smallint

No

Foreign key to
ARF_DEMOGRAPHIC_ID
column, which provides
references to age,
marital status, etc..

SITE_VISIT_ID

bigint

No

ID of site visit.

ORDER_ID

int

No

ID of order. Surrogate
key.

LINE_ITEM_ID

bigint

No

Identifier; primary key.


Surrogate key.

NORDER_ID

varchar

40

No

Natural key of order


from the Order
repository..

NLINE_ITEM_ID

varchar

40

No

Natural key of line item


from the Order
repository.

QUANTITY

int

No

Quantity of this line


item ordered.

LOCAL_UNIT_PRICE

double

No

Unit price in the local


currency. The field
length is 19 digits, with
7 digits to the left of the
decimal and 12 to the
right.

40
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

LOCAL_GROSS_REVENUE

double

No

Revenue before
adjustments due to
discounts, taxes, and
shipping, in the local
currency. Equal to unit
price * quantity.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

LOCAL_DISCOUNT_AMOUNT

double

No

Any discount applied to


this specific line item, in
the local currency.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

LOCAL_ORDER_TAX_ALLOC

double

No

Amount of tax on the


order that is allocated
to this line item, in the
local currency. The
allocation is
determined by the
processing pipeline.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

LOCAL_ORDER_SHIPPING_ALLOC

double

No

Amount of shipping on
the order that is
allocated to this line
item. The allocation is
determined by the
processing pipeline.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

41
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

LOCAL_ORDER_DISCOUNT_ALLOC

double

No

Amount of any orderlevel discounts that is


allocated to this line
item, in the local
currency. The allocation
is determined by the
processing pipeline.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

LOCAL_NET_REVENUE

double

No

Revenue after
adjustments due to
discounts, taxes, and
shipping, in the local
currency.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

LOCAL_ORDER_NET_REVENUE

double

No

Revenue for the entire


order of which this line
item is a part, after
adjustments due to
discounts, taxes, and
shipping, in the local
currency.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

STANDARD_UNIT_PRICE

double

No

Unit price in the


reporting currency. The
field length is 19 digits,
with 7 digits to the left
of the decimal and 12
to the right.

42
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

STANDARD_GROSS_REVENUE

double

No

Revenue before
adjustments due to
discounts, taxes, and
shipping, in the
reporting currency.
Equal to unit price *
quantity.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

STANDARD_DISCOUNT_AMOUNT

double

No

Any discount applied to


this specific line item, in
the reporting currency.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

STANDARD_ORDER_TAX_ALLOC

double

No

Amount of tax on the


order that is allocated
to this line item, in the
reporting currency. The
allocation is
determined by the
processing pipeline.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

STANDARD_ORDER_SHIPPING_ALLOC

double

No

Amount of shipping on
the order that is
allocated to this line
item, in the reporting
currency. The allocation
is determined by the
processing pipeline.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

43
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

STANDARD_ORDER_DISCOUNT_ALLOC

double

No

Amount of any orderlevel discounts that is


allocated to this line
item, in the reporting
currency. The allocation
is determined by the
processing pipeline.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

STANDARD_NET_REVENUE

double

No

Revenue after
adjustments due to
discounts, taxes, and
shipping, in the
reporting currency.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

STANDARD_ORDER_NET_REVENUE

double

No

Revenue for the entire


order of which this line
item is a part, after
adjustments due to
discounts, taxes, and
shipping, in the
reporting currency.
The field length is 19
digits, with 7 digits to
the left of the decimal
and 12 to the right.

DCS_PROF_PROD_PURCH_FACT
This table stores data about how many times any customer has purchased a particular product. It is used
for the Affinity Selling feature of ATG Commerce.

Column Name

Type

CUSTOMER_ID

int

Length

Null Allowed

Description

No

Primary key component. Foreign


key to ARF_USER.ID column.

44
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

PRODUCT_ID

int

DAY_ID

varchar

LAST_PURCHASE

OCCURRENCES

No

Primary key component. Foreign


key to ARF_PRODUCT.ID column.

No

Primary key component. Foreign


key to ARF_TIME_DAY.ID column.

timestamp

Yes

The last time the customer


purchased the product on the
specified day.

int

No

The quantity of items of the


product purchased by the
customer on this day.

40

DCS_PROF_BRAND_PURCH_FACT
This table is reserved for future use.

DCS_PROF_CAT_PURCH_FACT
This table stores data about how many times any customer has purchased a particular product. It is used
for the Affinity Selling feature of ATG Commerce.

Column Name

Type

CUSTOMER_ID

Length

Null Allowed

Description

int

No

Primary key component. Foreign


key to ARF_USER.ID column.

CATEGORY_ID

int

No

Primary key component. Foreign


key to ARF_CATEGORY.ID column.

DAY_ID

varchar

No

Primary key component. Foreign


key to ARF_TIME_DAY.ID column.

LAST_PURCHASE

timestamp

Yes

The last time the customer


purchased a product from this
category on the specified day.

OCCURRENCES

int

No

The quantity of items from this


category purchased by the
customer on this day.

40

45
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

DCS_PROF_PRICE_FACT
This table contains information about the prices that customers pay.

Column Name

Type

CUSTOMER_ID

int

DAY_ID

varchar

LAST_PURCHASE

Length

Null Allowed

Description

No

Primary key component.


Foreign key to ARF_USER.ID
column.

No

Primary key component.


Foreign key to
ARF_TIME_DAY.ID column.

timestamp

Yes

The last time the customer


purchased a product on this
day.

OCCURRENCES

int

No

The quantity of items


purchased by the customer
on this day.

MAX_PRICE

double

Yes

The maximum price paid


(after discounts) for an item
on this day.

MIN_PRICE

double

Yes

The minimum price paid


(after discounts) for an item
on this day.

AVERAGE_PRICE

double

Yes

The average price paid


(after discounts) for the
items on this day.

STANDARD_DEVIATION

double

Yes

The standard deviation of


the prices (after discounts)
of the items on this day.

40

DCS_PROD_AFF_FACT
This table stores data about how often pairs of products are purchased together. It is used for the Affinity
Selling feature of ATG Commerce.

46
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

PRODUCT_1_ID

Length

Null
Allowed

Description

int

No

Primary key component. Foreign


key to ARF_PRODUCT.ID column.

PRODUCT_2_ID

int

No

Primary key component. Foreign


key to ARF_PRODUCT.ID column.

DAY_ID

varchar

No

Primary key component. Foreign


key to ARF_TIME_DAY.ID
column.

SEGMENT_ID

tinyint

No

Primary key component. Foreign


key to ARF_SEGMENT.ID column.

PURCHASE_PURCHASE_OCCURRENCES

int

Yes

The number of times these two


products have been purchased
by the same customer, on the
day the second product was
purchased.

PURCHASE_PURCHASE_AFFINITY

double

Yes

The number of times these two


products have been purchased
by the same customer, on the
day the second product was
purchased, weighted by the
number of days between the first
and second product purchases.

40

The field length is 19 digits, with


7 digits to the left of the decimal
and 12 to the right.
PURCHASE_BROWSE_OCCURRENCES

int

Yes

Reserved for future use.

PURCHASE_BROWSE_AFFINITY

double

Yes

Reserved for future use.

BROWSE_BROWSE_OCCURRENCES

int

Yes

Reserved for future use.

BROWSE_BROWSE_AFFINITY

double

Yes

Reserved for future use.

INFLATION

double

Yes

A value used to ensure that


recent purchase pairs are
recommended more strongly
than pairs purchased farther in
the past.

PURCHASE_PURCHASE_INFLATED

double

Yes

The INFLATION value times the


PURCHASE_PURCHASE_AFFINITY
value.

47
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

PURCHASE_PURCHASE_TOTAL_SPREAD

int

Yes

Spread is defined as the number


of days between purchases for
each product in a product pair.
For example, if Product 1 is
purchased on April 1, and
Product 2 is purchased on April
5, the spread is 4. The Purchase
to Purchase Total Spread
represents the sum of the
spreads for all product pairs.

DCS_PROD_AFF_GLOBAL_FACT
This table stores data about how often pairs of products are purchased together. It is used for the Affinity
Selling feature of ATG Commerce.

Column Name

Type

PRODUCT_1_ID

Length

Null
Allowed

Description

int

No

Primary key component. Foreign


key to ARF_PRODUCT.ID column.

PRODUCT_2_ID

int

No

Primary key component. Foreign


key to ARF_PRODUCT.ID column.

DAY_ID

varchar

No

Primary key component. Foreign


key to ARF_TIME_DAY.ID
column.

PURCHASE_PURCHASE_OCCURRENCES

int

Yes

The number of times these two


products have been purchased
by the same customer, on the
day the second product was
purchased.

PURCHASE_PURCHASE_AFFINITY

double

Yes

The number of times these two


products have been purchased
by the same customer, on the
day the second product was
purchased, weighted by the
number of days between the first
and second product purchases.

40

The field length is 19 digits, with


7 digits to the left of the decimal
and 12 to the right.

48
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

PURCHASE_BROWSE_OCCURRENCES

int

Yes

Reserved for future use.

PURCHASE_BROWSE_AFFINITY

double

Yes

Reserved for future use.

BROWSE_BROWSE_OCCURRENCES

int

Yes

Reserved for future use.

BROWSE_BROWSE_AFFINITY

double

Yes

Reserved for future use.

INFLATION

double

Yes

A value used to ensure that


recent purchase pairs are
recommended more strongly
than pairs purchased farther in
the past.

PURCHASE_PURCHASE_INFLATED

double

Yes

The INFLATION value times the


PURCHASE_PURCHASE_AFFINITY
value.

PURCHASE_PURCHASE_TOTAL_SPREAD

int

Yes

Spread is defined as the number


of days between purchases for
each product in a product pair.
For example, if Product 1 is
purchased on April 1, and
Product 2 is purchased on April
5, the spread is 4. The Purchase
to Purchase Total Spread
represents the sum of the
spreads for all product pairs.

DCS_CAT_AFF_FACT
This table stores data about how often items from category pairs are purchased together. It is used for the
Affinity Selling feature of ATG Commerce.

Column Name

Type

CATEGORY_1_ID

CATEGORY_2_ID

Length

Null
Allowed

Description

int

No

Primary key component. Foreign


key to ARF_CATEGORY.ID
column.

int

No

Primary key component. Foreign


key to ARF_CATEGORY.ID
column.

49
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

DAY_ID

varchar

SEGMENT_ID

40

No

Primary key component. Foreign


key to ARF_TIME_DAY.ID
column.

tinyint

No

Primary key component. Foreign


key to ARF_SEGMENT.ID column.

PURCHASE_PURCHASE_OCCURRENCES

int

Yes

The number of times products


from these two categories have
been purchased by the same
customer, on the day the second
product was purchased.

PURCHASE_PURCHASE_AFFINITY

double

Yes

The number of times products


from these two categories have
been purchased by the same
customer, on the day the second
product was purchased,
weighted by the number of days
between the first and second
product purchases.
The field length is 19 digits, with
7 digits to the left of the decimal
and 12 to the right.

INFLATION

double

Yes

A value used to ensure that


recent purchase pairs are
recommended more strongly
than pairs purchased farther in
the past.

PURCHASE_PURCHASE_INFLATED

double

Yes

The INFLATION value times the


PURCHASE_PURCHASE_AFFINITY
value.

PURCHASE_PURCHASE_TOTAL_SPREAD

int

Yes

Spread is defined as the number


of days between purchases for
each product in a product pair.
For example, if Product 1 is
purchased on April 1, and
Product 2 is purchased on April
5, the spread is 4. The Purchase
to Purchase Total Spread
represents the sum of the
spreads for all product pairs.

50
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

DCS_CAT_AFF_GLOBAL_FACT
This table contains site-wide category-to-category affinity data.

Column Name

Type

CATEGORY_1_ID

Length

Null
Allowed

Description

int

No

Primary key component. Foreign


key to ARF_CATEGORY.ID
column.

CATEGORY_2_ID

int

No

Primary key component. Foreign


key to ARF_CATEGORYID
column.

DAY_ID

varchar

No

Primary key component. Foreign


key to ARF_TIME_DAY.ID
column.

PURCHASE_PURCHASE_OCCURRENCES

int

Yes

The number of times products


from these two categories have
been purchased by the same
customer, on the day the second
product was purchased.

PURCHASE_PURCHASE_AFFINITY

double

Yes

The number of times products


from these two categories have
been purchased by the same
customer, on the day the second
product was purchased,
weighted by the number of days
between the first and second
product purchases.

INFLATION

double

Yes

A value used to ensure that


recent purchase pairs are
recommended more strongly
than pairs purchased farther in
the past.

PURCHASE_PURCHASE_INFLATED

double

Yes

The INFLATION value times the


PURCHASE_PURCHASE_AFFINITY
value.

40

51
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

PURCHASE_PURCHASE_TOTAL_SPREAD

int

Yes

Spread is defined as the number


of days between purchases for
each product in a product pair.
For example, if Product 1 is
purchased on April 1, and
Product 2 is purchased on April
5, the spread is 4. The Purchase
to Purchase Total Spread
represents the sum of the
spreads for all product pairs.

DCS_AFF_EXT_STATUS
This table is used by the AffinityExtractor service to keep track of what data appears in the summary
(see the Setting up Commerce Reporting chapter in the ATG Commerce Programming Guide for
information).
This table contains the ID of the status item, and the type of affinity data that this status item is tracking.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

ITEM_TYPE

varchar

128

No

The type of affinity being tracked. The


value of this column is the name of the
item descriptor of the extract repository
items.
For example:
productPurchaseAffinity
aggregateProductAffinity

DCS_AFF_EXT_STATUS_DAYS
This table contains the set of days for which data has been extracted into the extract repository.

52
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

The ID of the status item. Foreign key to


the DCS_AFF_EXT_STATUS.ID column.

DAY_ID

varchar

40

No

ID of the day item that is included in the


extracted data. Foreign key to
ARF_TIME_DAY.ID column.

53
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

Commerce ERD

54
3 - Commerce Database Tables

ATG Customer Intelligence Data Warehouse Guide

4 Knowledge Database Tables

This chapter describes the tables in the ATG data warehouse that are used exclusively by the ATG
Knowledge application. Knowledge reports also make use of the tables described in the Platform
Database Tables chapter.
This chapter includes the following sections:
KDW_CONTROL
KDW_SOLNCLASS_DIM
KDW_SOLNSTATUS_DIM
KDW_AUD_DIM
KDW_ACT_DIM
KDW_OWNGROUP_DIM
KDW_SOLN_DIM
KDW_SOLN_AUD
KDW_SOLN_TOPIC
KDW_SESSACTPK_FACT
KDW_PSESSACTPK
KDW_SACTTOTPK_FACT
KDW_PSACTTOTPK
KDW_AGENTACT_FACT
KDW_SOLNACT_FACT
Knowledge ERD

KDW_CONTROL
The control record is used by the atg.reporting.summary.ReportSummaryService. It stores the time
that the last audit event was read by the summarization process. It contains the following columns:

55
4 - Knowledge Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

LAST_REPORT_TIME

timestamp

Yes

Time the most recent report


was run.

KDW_SOLNCLASS_DIM
This table contains the list of solution classes. It includes the following columns:

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

NAME_EN

varchar

255

No

Solution class name in English.

DESC_EN

varchar

255

Yes

Solution class description in


English.

KDW_SOLNSTATUS_DIM
This table contains the list of solution status options. It contains the following columns:

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

NAME_EN

varchar

255

No

Name of the status in


English.

KDW_AUD_DIM
This table contains the list of audiences. It contains the following:

56
4 - Knowledge Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

NAME_EN

varchar

255

No

Name of the audience in


English.

KDW_ACT_DIM
This table stores activities, which are shown in the Agent/Solution Activity reports. It contains the
following:

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

NAME_EN

varchar

255

No

Activity name in
English.

KDW_OWNGROUP_DIM
This table contains the list of owning groups. It includes the following:

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

NAME_EN

varchar

255

No

Owning group name in English.

ORGANIZATION_ID

varchar

40

Yes

Organization to which the group


belongs. Foreign key to the
ARF_UI_ORG.ORGANIZATION_ID
column.

KDW_SOLN_DIM
This table contains the list of solutions. It includes the following:

57
4 - Knowledge Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

TITLE_EN

varchar

1000

Yes

Solution title.

CLASS_ID

varchar

40

No

Foreign key to the


KDW_SOLNCLASS_DIM.ID
column.

DATE_CREATED

datetime

No

Date and time the solution was


created.

DATE_MODIFIED

datetime

Yes

Date and time the solution was


last modified.

DATE_DELETED

datetime

Yes

Date and time the solution was


deleted.

MODIFIED_BY_ID

varchar

Yes

User ID of the person who last


modified the solution. Foreign
key to the ARF_IU_USER.ID
column.

LAST_USE_DATE

timestamp

Yes

Date and time the solution was


last used.

DELETED

one-digit

Yes

Indicates whether or not the


solution has been deleted.

40

1 = Yes
0 = No
STATUS_ID

varchar

40

No

Foreign key to the


KDW_SOLNSTATUS_DIM.ID
column.

OWNING_GROUP_ID

varchar

40

Yes

Foreign key to the


KDW_OWNGROUP_DIM.ID
column.

PROFILE_ID

varchar

40

No

Foreign key to the


ARF_IU_USER.ID column.

BEST_BET

one-digit

No

Indicates whether or not the


solution is a Best Bet.
1 = Yes
0 = No

LANGUAGE_ID

varchar

40

No

Foreign key to the


SDW_LANG_DIM.ID column.

58
4 - Knowledge Database Tables

ATG Customer Intelligence Data Warehouse Guide

USE_COUNT

integer

Yes

Use count property for


solution.

KDW_SOLN_AUD
This tables stores relationships between solutions and audiences. It includes the following:

Column Name

Type

Length

Null Allowed

Description

SOLN_ID

varchar

40

No

Primary key component. Foreign key to


the KDW_SOLN_DIM.ID column.

AUD_ID

varchar

40

No

Primary key component. Foreign key to


the KDW_AUD_DIM.ID column.

KDW_SOLN_TOPIC
This table stores references between solutions and topics. It includes the following:

Column Name

Type

Length

Null Allowed

Description

SOLN_ID

varchar

40

No

Primary key component. Foreign key to


the KDW_SOLN_DIM.ID column.

TOPIC_ID

varchar

40

No

Primary key component. Foreign key to


the SDW_TOPIC_DIM.ID column.

KDW_SESSACTPK_FACT
This table stores facts about session activity peaks. It includes the following:

59
4 - Knowledge Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

Length

Null Allowed

Description

HOUR_ID

varchar

40

No

Hour in which events occurred.


Primary key component. Foreign
key to ARF_TIME_HOUR.ID column.

ORGANIZATION_ID

varchar

40

No

Primary key component. Foreign


key to ARF_IU_ORG.ID column.

NUM_EVENTS

integer

Yes

Number of events occurring in this


hour. Session activity peak count.

KDW_PSESSACTPK
This is an intermediate table which is used for filling the KDW_SESSACTPK_FACT table. This table includes
the following:

Column Name

Type

Length

Null Allowed

Description

HOUR_ID

varchar

40

No

Primary key component. Foreign


key to ARF_TIME_HOUR.ID
column.

TIME_AS_IS

timestamp

No

Primary key component.

ORGANIZATION_ID

varchar

No

Primary key component. Foreign


key to ARF_IU_ORG.ID column.

NUM_EVENTS

integer

Yes

Number of events that occurred.


Session activity peak count.

40

KDW_SACTTOTPK_FACT
This table records information about total session activity, without reference to organizations such as in
KDW_SESSACTPK_FACT. It includes the following:

Column Name

Type

Length

Null Allowed

Description

HOUR_ID

varchar

40

No

Hour in which the activity took place.


Primary key. Foreign key to
ARF_TIME_HOUR.ID column.

60
4 - Knowledge Database Tables

ATG Customer Intelligence Data Warehouse Guide

NUM_EVENTS

integer

Yes

Number of events. Session activity peak


count.

KDW_PSACTTOTPK
This is an intermediate table, which is used for filling the KDW_SACTTOTPK_FACT table. This table
includes the following:

Column Name

Type

Length

Null Allowed

Description

HOUR_ID

varchar

40

No

Hour in which the activity took


place. Primary key component.
Foreign key to ARF_TIME_HOUR.ID
column.

TIME_AS_IS

timestamp

No

Primary key component.

NUM_EVENTS

integer

Yes

Session activity peak count.

KDW_AGENTACT_FACT
This table stores facts about agent activities. It includes the following:

Column Name

Type

Length

Null Allowed

Description

PROFILE_ID

varchar

40

No

Foreign key to ARF_IU_USER.ID column.


Primary key component.

ACTIVITY_ID

varchar

40

No

Identifies the activity the agent


performed. Primary key component.
Foreign key to KDW_ACT_DIM.ID
column.

HOUR_ID

varchar

40

No

The hour in which the activity took


place. Primary key component. Foreign
key to ARF_TIME_HOUR.ID column.

NUM_EVENTS

integer

Yes

Number of events.

61
4 - Knowledge Database Tables

ATG Customer Intelligence Data Warehouse Guide

KDW_SOLNACT_FACT
This table records facts about solution activities. It includes the following:

Column Name

Type

Length

Null Allowed

Description

ACTIVITY_ID

varchar

40

No

Activity identifier. Primary key


component. Foreign key to
KDW_ACT_DIM.ID column.

PROFILE_ID

varchar

40

No

Profile identifier. Primary key


component. Foreign key to
ARF_IU_USER.ID column.

HOUR_ID

varchar

40

No

Hour identifier. Primary key component.


Foreign key to ARF_TIME_HOUR.ID
column.

SOLUTION_ID

varchar

40

No

Solution identifier. Primary key


component. Foreign key to
KDW_SOLN_DIM.ID column.

NUM_EVENTS

integer

Yes

Number of events

62
4 - Knowledge Database Tables

ATG Customer Intelligence Data Warehouse Guide

Knowledge ERD

63
4 - Knowledge Database Tables

ATG Customer Intelligence Data Warehouse Guide

64
4 - Knowledge Database Tables

ATG Customer Intelligence Data Warehouse Guide

5 Response Management Database


Tables

This chapter describes the tables in the ATG data warehouse that are used exclusively by the ATG
Response Management application. Response Management reports also make use of the tables described
in the Platform Database Tables chapter.
This chapter includes the following sections:
DW_RM_CONTROL
DW_RM_CHANNEL
DW_RM_CLS_IMSG
DW_RM_UNCLS_IMSG
DW_RM_USER_OMSG
DW_RM_AUTO_OMSG
DW_TKT_USR_ACT
DW_TKT_CUST_OPN
DW_TKT_USR_OPN
DW_TKT_AUTO_ESC
DW_RM_ROUTING_NODE
DW_SVC_LOG_ORG
Response Management ERD

DW_RM_CONTROL
The control record contains the time that the last audit event was read by the summarization process.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

65
5 - Response Management Database Tables

ATG Customer Intelligence Data Warehouse Guide

LAST_REPORT

timestamp

No

Time the summarization process last


ran.

DW_RM_CHANNEL
This table holds the static value display names for the supported channel IDs (email and sms).

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

NAME_EN

varchar

255

No

Name of channel in English. Defaults are


email and SMS.

DW_RM_CLS_IMSG
Table for counting all classified inbound message events.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier.

HOUR_ID

varchar

40

No

Foreign key to ARF_TIME_HOUR.ID


column. Primary key component.

TKT_QUEUE_ID

varchar

40

No

Foreign key to DW_SVC_LOG_ORG.ID


column refers to the Ticket Queue
dimension record. Primary key
component.

IN_CHANNEL_ID

varchar

40

No

Foreign key to DW_RM_CHANNEL.ID


column. Primary key component.

CLS_TARGET_ID

varchar

40

No

Foreign key to
DW_RM_ROUTING_NODE.ID column
refers to the Classification Target
dimension. Primary key component.

66
5 - Response Management Database Tables

ATG Customer Intelligence Data Warehouse Guide

IN_COUNT

integer

No

Number of messages received in that


hour; for that channel, that have been
routed to that ticket queue and
classified to that target.

DW_RM_UNCLS_IMSG
This table records unclassified inbound messages.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier.

HOUR_ID

varchar

40

No

Foreign key to ARF_TIME_HOUR.ID


column. Primary key component.

TKT_QUEUE_ID

varchar

40

No

Foreign key to DW_SVC_LOG_ORG.ID


column refers to the Ticket Queue
dimension record. Primary key
component.

IN_CHANNEL_ID

varchar

40

No

Foreign key to DW_RM_CHANNEL.ID


column. Primary key component.

IN_COUNT

integer

No

Number of messages received in that


hour; for that channel, that have been
routed to that ticket queue.

DW_RM_USER_OMSG
Counts all internal user, outbound message events.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier.

HOUR_ID

varchar

40

No

Foreign key to ARF_TIME_HOUR.ID


column. Primary key component.

67
5 - Response Management Database Tables

ATG Customer Intelligence Data Warehouse Guide

TKT_QUEUE_ID

varchar

40

No

Foreign key to
DW_SVC_LOG_ORG.ID column
refers to the Ticket Queue
dimension record. Primary key
component.

OUT_CHANNEL_ID

varchar

40

No

Foreign key to
DW_RM_CHANNEL.ID column.
Primary key component.

USER_ID

varchar

40

No

Foreign key to ARF_IU_USER.ID


column. Primary key component.

USER_RESP_COUNT

integer

No

Number of agent messages sent


out in that hour; for that channel, in
that ticket queue by that
agent/internal user.

DW_RM_AUTO_OMSG
Counts information about automatic outbound message events.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier.

HOUR_ID

varchar

40

No

Foreign key to ARF_TIME_HOUR.ID


column. Primary key component.

TKT_QUEUE_ID

varchar

40

No

Foreign key to
DW_SVC_LOG_ORG.ID column
refers to the Ticket Queue
dimension record. Primary key
component.

OUT_CHANNEL_ID

varchar

40

No

Foreign key to
DW_RM_CHANNEL.ID column.
Primary key component.

AUTO_RESP_COUNT

int

No

Number of automatic messages


sent out in that hour; for that
channel, in that ticket queue.

AUTO_ACK_COUNT

int

No

Number of automatic
acknowledgements sent out in
that hour; for that channel, in that
ticket queue.

68
5 - Response Management Database Tables

ATG Customer Intelligence Data Warehouse Guide

DW_TKT_USR_ACT
This table records each action for a combination of hour, ticket queue, and internal user.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier.

HOUR_ID

varchar

40

No

Foreign key to
ARF_TIME_HOUR.ID column.
Primary key component.

TKT_QUEUE_ID

varchar

40

No

Foreign key to
DW_SVC_LOG_ORG.ID column
refers to the Ticket Queue
dimension record. Primary key
component.

USER_ID

varchar

40

No

Foreign key to
DW_RM_CHANNEL.ID column.
Primary key component.

ASSIGN_COUNT

int

No

Number of tickets assigned to


that internal user under that
ticket queue in that hour.

UNASSIGN_COUNT

int

No

Number of tickets unassigned


to that internal user under that
ticket queue in that hour.

SUSPEND_COUNT

int

No

Number of tickets suspended


by that internal user under
that ticket queue in that hour.

FORWARD_TO_COUNT

int

No

Number of tickets forwarded


by that internal user under
that ticket queue in that hour.

REASSIGN_TO_COUNT

int

No

Number of tickets reassigned


by that internal user under
that ticket queue in that hour.

REASSIGN_FRM_COUNT

int

No

Reserved for future use.

RELEASE_COUNT

int

No

Number of tickets released by


that internal user under that
ticket queue in that hour.

69
5 - Response Management Database Tables

ATG Customer Intelligence Data Warehouse Guide

ESCALATE_COUNT

int

No

Number of tickets escalated by


that internal user under that
ticket queue in that hour.

DEALLOCATE_COUNT

int

No

Reserved for future use.

CLOSE_REOPEN_COUNT

int

No

Number of tickets reopened


by that internal user under
that ticket queue in that hour.

CLOSE_COUNT

integer

No

Number of tickets closed by


that internal user under that
ticket queue in that hour.

CLOSE_DURATION

bigint

No

Total time to close all of the


tickets in CLOSE_COUNT.

MAX_CLOSE_DURATION

bigint

No

Maximum close duration for


the tickets in CLOSE_COUNT.

MIN_CLOSE_DURATION

bigint

No

Minimum close duration for


the tickets in CLOSE_COUNT.

OVERDUE_COUNT

integer

No

Number of that users tickets


which are overdue in that
ticket queue in that hour.

OVERDUE_DURATION

integer

No

Total time all tickets in


OVERDUE_COUNT are
overdue.

MAX_OVERDUE_DUR

bigint

No

Maximum overdue duration


for tickets that have been
closed from
OVERDUE_COUNT.

MAX_INDUE_DURATION

bigint

No

Reserved for future use.

DW_TKT_CUST_OPN
This table is reserved for future use.

DW_TKT_USR_OPN
This table is reserved for future use.

70
5 - Response Management Database Tables

ATG Customer Intelligence Data Warehouse Guide

DW_TKT_AUTO_ESC
This table is reserved for future use.

DW_RM_ROUTING_NODE
This table contains information about the Response Management node structure.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

NAME_EN

varchar

100

No

Node name in English.

DESCRIPTION_EN

varchar

254

Yes

Node description in

PARENT_NODE_ID

varchar

40

Yes

Parent node identifier. Foreign to


the ID column of this table.

TYPE

varchar

40

No

Node type.

LAST_UPDATED

datetime

No

Date the node was last updated.

DELETED

tinyint

No

Whether or not the node has been


deleted.

DW_SVC_LOG_ORG
This table holds a copy of the logical organizations, i.e. ticket queues that are held on the main production
system. This is in the ATGDW and will be used for reporting, rather than accessing the production details.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

NAME_EN

varchar

254

No

Name of the organization in


English.

DESCRIPTION_EN

varchar

254

Yes

Organization description in
English.

PHYSICAL_ORG_ID

varchar

40

No

Ticket Queues (Logical Org)


organization ID.

71
5 - Response Management Database Tables

ATG Customer Intelligence Data Warehouse Guide

TYPE

varchar

LAST_UPDATED
DELETED

40

No

Logical organization type.

datetime

No

Date this record was last updated.

tinyint

No

Indicates that this organization


has been deleted from the
transactional database.
0 = No
1 = Yes

Response Management ERD

72
5 - Response Management Database Tables

ATG Customer Intelligence Data Warehouse Guide

6 Outreach Database Tables

This chapter describes the tables in the ATG data warehouse that are used exclusively by the ATG
Outreach application. Outreach reports also make use of the tables described in the Platform Database
Tables chapter.
This chapter includes the following sections:
ARF_CAMPAIGN
ARF_CAMPAIGN_STAGE
ARF_CAMPAIGN_ACTION_TYPE
ARF_CAMPAIGN_ACTION
ARF_CAMPAIGN_EVENT
ARF_LANDING_PAGE
ARF_EMAIL_DOMAIN
ARF_CAMPAIGN_ENTERED_FACT
ARF_CAMPAIGN_ACTION_FACT_TYPE
ARF_CAMPAIGN_ACTION_FACT
ARF_CAMPAIGN_AUDIT_TRAIL_FACT
Outreach ERD

ARF_CAMPAIGN
This table contains information about Outreach campaigns.

Column Name

Type

ID

integer

NCAMPAIGN_ID

varchar

START_DATE

datetime

Length

40

Null Allowed

Description

No

Identifier; primary key.

No

Natural key of
campaign.

Yes

Campaign start date.

73
6 - Outreach Database Tables

ATG Customer Intelligence Data Warehouse Guide

END_DATE

datetime

Yes

Campaign end date.

DISPLAY_NAME

varchar

255

Yes

Campaign display
name.

DESCRIPTION

varchar

1024

Yes

Campaign
description.

TARGET_AUDIENCE

varchar

1024

Yes

Campaign target
audience.

ESTIMATED_COST

varchar

1024

Yes

Campaign estimated
cost.

ESTIMATED_RESPONSE_RATE

varchar

1024

Yes

Campaign estimated
response rate.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was


last updated.

RECORD_START_DATE

timestamp

Yes

Date when the


information in this
warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the


information in this
warehouse record is
no longer effective.

MOST_RECENT

one-digit

No

Indicates that this


record is the most
recent.
0 = No
1 = Yes

DELETED

one-digit

No

Indicates that this


record has been
deleted.
0= No
1 = Yes

ARF_CAMPAIGN_STAGE
This table contains information about individual stages within Outreach campaigns. A stage is a step or a
phase in a campaign. Every campaign has an initial stage (also called the root stage) that defines the

74
6 - Outreach Database Tables

ATG Customer Intelligence Data Warehouse Guide

actions that begin the campaign, for example sending an e-mail to customers or displaying content on
the Web site. A campaign can also have one or more child stages, which are triggered by customer
responses to earlier campaign actions.

Column Name

Type

ID

integer

NSTAGE_ID

varchar

CAMPAIGN_ID

Length

Null Allowed

Description

No

Identifier; primary key.

No

Natural key of the


campaign stage.

integer

No

Campaign in which this


stage is included.

PARENT_EVENT_ID

integer

Yes

A non-root stage can have a


parent event.

DISPLAY_NAME

varchar

254

Yes

Stage display name.

DESCRIPTION

varchar

4000

Yes

Stage description.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the information


in this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information


in this warehouse record is
no longer effective.

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.

40

0 = No
1 = Yes
DELETED

one-digit

No

Indicates that this record


has been deleted.
0= No
1 = Yes

ARF_CAMPAIGN_ACTION_TYPE
This is a reference table containing action types that can be used in Outreach campaigns.

75
6 - Outreach Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

ID

Length

Null Allowed

Description

smallint

No

Identifier; primary key.

NTYPE_ID

integer

No

Natural ID of the action


type.

DISPLAY_NAME_EN

varchar

Yes

Action type display name.

255

ARF_CAMPAIGN_ACTION
Actions represent ATG Outreach activity, for example sending an e-mail to a group of customers or
publishing content to the Web site.

Column Name

Type

ID

integer

NACTION_ID

varchar

PARENT_STAGE_ID

Length

Null Allowed

Description

No

Identifier; primary key.

No

Natural key of the action.

integer

Yes

Foreign key to
ARF_CAMPAIGN_STAGE.ID

TYPE_ID

smallint

No

Foreign key to
ARF_CAMPAIGN_ACTION_TYPE_ID

POS_INDEX

integer

No

Position index; indicates the


sequence of actions within a stage.

DISPLAY_NAME

varchar

254

Display name of the action.

DESCRIPTION

varchar

4000

Description of the action.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last updated.

RECORD_START_DATE

timestamp

Yes

Date when the information in this


warehouse record became
effective

RECORD_END_DATE

timestamp

Yes

Date when the information in this


warehouse record is no longer
effective.

40

76
6 - Outreach Database Tables

ATG Customer Intelligence Data Warehouse Guide

MOST_RECENT

one-digit

No

Indicates that this record is the


most recent.
0 = No
1 = Yes

DELETED

one-digit

No

Indicates that this record has been


deleted.
0= No
1 = Yes

ARF_CAMPAIGN_EVENT
Events represent the customer behavior that you want to identify and use as a trigger for the next activity
in a campaign. Logging into a Web site, changing a profile, and clicking a specified link are examples of
events.

Column Name

Type

ID

integer

NEVENT_ID

varchar

PARENT_ACTION_ID

integer

TYPE

varchar

DISPLAY_NAME

Length

Null Allowed

Description

No

Identifier; primary key.

No

Natural key of event

Yes

Foreign key to
ARF_CAMPAIGN_ACTION.ID

254

Yes

Campaign event types


include

varchar

254

yes

Event display name.

DESCRIPTION

varchar

4000

Yes

Event description.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the information


in this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information


in this warehouse record is
no longer effective.

40

77
6 - Outreach Database Tables

ATG Customer Intelligence Data Warehouse Guide

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.
0 = No
1 = Yes

DELETED

one-digit

No

Indicates that this record


has been deleted.
0= No
1 = Yes

ARF_LANDING_PAGE
E-mails that you send to the targets of your campaigns can include links to pages on your Web site. A
landing page is the page that appears when a user follows one of these links.

Column Name

Type

ID

integer

NLANDING_PAGE_ID

varchar

DISPLAY_NAME

Length

Null Allowed

Description

No

Identifier; primary key.

40

No

Natural key of landing


page.

varchar

254

yes

Landing page display


name.

DESCRIPTION

varchar

4000

Yes

Landing page description.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the information


in this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information


in this warehouse record is
no longer effective.

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.
0 = No
1 = Yes

78
6 - Outreach Database Tables

ATG Customer Intelligence Data Warehouse Guide

DELETED

one-digit

No

Indicates that this record


has been deleted.
0= No
1 = Yes

ARF_EMAIL_DOMAIN
Stores domain information based on users email addresses.

Column Name

Type

Length

ID

integer

DOMAIN_SUFFIX

varchar

255

DISPLAY_NAME

varchar

255

Null Allowed

Description

No

Identifier; primary
key.

No

The portion of the


users email address
following the @
symbol.
By default, same as
DOMAIN_SUFFIX,
but this can be
configured in the
application.

ARF_CAMPAIGN_ENTERED_FACT
This table contains information about campaigns that have been entered by users.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

CAMPAIGN_ID

integer

No

Foreign key to
ARF_CAMPAIGN.ID

PARTICIPANT_ID

integer

No

Foreign key to ARF_USER.ID.

79
6 - Outreach Database Tables

ATG Customer Intelligence Data Warehouse Guide

SEGMENT_CLUSTER_ID

integer

No

Foreign key to
ARF_SEGCLSTR.ID

DAY_ID

varchar

No

Foreign key to
ARF_TIME_DAY.ID

TIME_ID

integer

No

Foreign key to
ARF_TIME_TOD.ID

ARF_CAMPAIGN_ACTION_FACT_TYPE
Records whether the action was email clicked, email opened, soft bounce, hard bounce, etc.

Column Name

Type

ID

Length

Null Allowed

Description

smallint

No

Identifier; primary
key.

NTYPE_ID

smallint

No

Natural key of type.

DISPLAY_NAME_EN

varchar

Yes

Type name in
English.

255

ARF_CAMPAIGN_ACTION_FACT
This table stored the individual actions performed by users, such as clicking on an email.

Column Name

Type

Length

Null
Allowed

Description

ID

varchar

40

No

Identifier; primary key.

CAMPAIGN_ID

integer

No

Foreign key to ARF_CAMPAIGN.ID

STAGE_ID

integer

No

Foreign key to
ARF_CAMPAIGN_STAGE.ID

ACTION_ID

integer

No

Foreign key to
ARF_CAMPAIGN_ACTION.ID

PARTICIPANT_ID

integer

No

Foreign key to ARF_USER.ID

80
6 - Outreach Database Tables

ATG Customer Intelligence Data Warehouse Guide

SEGMENT_CLUSTER_ID

integer

No

Foreign key to ARF_SEGCLSTR.ID

DOMAIN_ID

integer

Yes

Foreign key to ARF_EMAIL_DOMAIN.ID

TYPE_ID

smallint

No

Foreign key to
ARF_CAMPAIGN_ACTION_FACT_TYPE.ID

LANDING_PAGE_ID

integer

Yes

Foreign key to ARF_LANDING_PAGE.ID

DAY_ID

varchar

No

Foreign key to ARF_TIME_DAY.ID

TIME_ID

integer

No

Foreign key to ARF_TIME_TOD.ID

40

ARF_CAMPAIGN_AUDIT_TRAIL_FACT
Traces a users path through an Outreach campaign.

Column Name

Type

Length

Null Allowed

Description

ID

varchar

40

No

Identifier; primary key.

CAMPAIGN_ID

integer

No

Foreign key to
ARF_CAMPAIGN.ID

STAGE_ID

integer

No

Foreign key to
ARF_CAMPAIGN_STAGE.ID

ACTION_ID

integer

No

Foreign key to
ARF_CAMPAIGN_ACTION.ID

EVENT_ID

integer

No

Foreign key to
ARF_CAMPAIGN_EVENT.ID

PARTICIPANT_ID

integer

No

Foreign key to ARF_USER.ID

SEGMENT_CLUSTER_ID

integer

No

Foreign key to
ARF_SEGCLSTR.ID

DAY_ID

varchar

No

Foreign key to
ARF_TIME_DAY.ID

TIME_ID

integer

No

Foreign key to
ARF_TIME_TODID

LABEL

varchar

Yes

Campaign authors can assign a


label for a given event.

40

254

81
6 - Outreach Database Tables

ATG Customer Intelligence Data Warehouse Guide

Outreach ERD

82
6 - Outreach Database Tables

ATG Customer Intelligence Data Warehouse Guide

7 Search Database Tables

This chapter describes the tables in the ATG data warehouse that are used exclusively by the ATG Search
application. Search reports also make use of the tables described in the Platform Database Tables chapter.
This chapter includes the following sections:
ARF_SEARCH_PROJECT
ARF_SEARCH_ENVIRONMENT
ARF_SEARCH_SITE
ARF_QUERY_TYPE
ARF_QUESTION_TYPE
ARF_QUESTION_TYPE_GROUP
ARF_QUESTION_TYPE_GROUP_MBRS
ARF_QUESTION
ARF_CONTENT
ARF_SEARCH_NUMBER
ARF_SEARCH_NUMBER_GROUP
ARF_SEARCH_NUMBER_GRP_MBRS
ARF_SEARCH_TOPIC
ARF_TOPIC_GROUP
ARF_TOPIC_GROUP_MBRS
ARF_WORD
ARF_WORD_GROUP
ARF_WORD_GROUP_MBRS
ARF_PROFILE_TYPE
ARF_QUERY
ARF_VIEW_CONTENT
ARF_SEARCH_SITE_VISIT
Search ERD

83
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

ARF_SEARCH_PROJECT
This table contains information about the Search projects configured in Search Administration.

Column Name

Type

ID

smallint

NPROJECT_ID

varchar

NAME

Length

Null Allowed

Description

No

Identifier; primary key.

40

No

Natural ID of project.

varchar

254

No

Project name in the default


language.

NAME_EN

varchar

254

Yes

Project name in English.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the information in


this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information in


this warehouse record is no
longer effective.

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.
0 = No
1 = Yes
Default value is 1.

DELETED

one-digit

No

Indicates that this record has


been deleted.
0= No
1 = Yes
Default value is 0.

ARF_SEARCH_ENVIRONMENT
This table contains information about the Search environments used to index content and return answers
to end-users.

84
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

ID

smallint

NENVIRONMENT_ID

varchar

NAME

Length

Null Allowed

Description

No

Identifier; primary key.

40

No

Natural key of environment.

varchar

254

No

Environment name in the


default language.

NAME_EN

varchar

254

Yes

Environment name in
English.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the information in


this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information in


this warehouse record is no
longer effective.

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.
0 = No
1 = Yes

DELETED

one-digit

No

Indicates that this record has


been deleted.
0= No
1 = Yes

PROJECT_ID

smallint

No

Foreign key to
ARF_SEARCH_PROJECT.ID.

ARF_SEARCH_SITE
Contains information about the Search site from the Search client application.

Column Name

Type

ID

smallint

Length

Null Allowed

Description

No

Identifier; primary key.

85
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

NSITE_ID

varchar

254

No

Natural ID of site.

NAME

varchar

254

No

Site name in the default


language.

NAME_EN

varchar

254

Yes

Site name in English.

RECORD_LAST_UPDATE

timestamp

Yes

Date the record was last


updated.

RECORD_START_DATE

timestamp

Yes

Date when the information in


this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information in


this warehouse record is no
longer effective.

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.
0 = No
1 = Yes
Default value is 1.

DELETED

one-digit

No

Indicates that this record has


been deleted.
0= No
1 = Yes
Default value is 0.

ARF_QUERY_TYPE
Reference table containing the different types of queries end-users can issue. Types include: Unspecified,
Simple Search, Browse, Structured Search, Similar Doc Search, and Categorize Search.

Column Name

Type

ID

smallint

NTYPE_ID

varchar

Length

40

Null Allowed

Description

No

Identifier; primary key.

No

Natural key of query


type.

86
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

NAME

varchar

40

No

Name of the query type


in the default language.

NAME_EN

varchar

40

Yes

Name of the query type


in English.

ARF_QUESTION_TYPE
Reference table containing the different types of questions end-users can issue. Types vary by language
and are determined by the Search engine. They can include values such as OneWordQuery and
YesNoQuestion.

Column Name

Type

ID

smallint

NAME

varchar

NAME_EN

varchar

Length

Null Allowed

Description

No

Identifier; primary
key.

40

No

Question type name


in the default
language.

40

Yes

Question type name


in English.

ARF_QUESTION_TYPE_GROUP
This table identifies which question type or types a query belongs to.

Column Name

Type

ID

smallint

NAME

varchar

HASH_VALUE

varchar

LENGTH

smallint

Length

Null Allowed

Description

No

Identifier; primary
key.

254

No

Question type
group name.

254

No

Used during data


loading.

No

Length of the group.

87
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

ARF_QUESTION_TYPE_GROUP_MBRS
Relates question type groups to question types.

Column Name

Type

QUESTION_TYPE_GROUP_ID

QUESTION_TYPE_ID

Length

Null
Allowed

Description

smallint

No

Foreign key to
ARF_QUESTION_TYPE_GROUP.ID;
primary key component.

smallint

No

Foreign key to
ARF_QUESTION_TYPE.ID; primary
key component.

ARF_QUESTION
Stores queries submitted by Search end-users.

Column Name

Type

ID

smallint

NORMAL_QUESTION

varchar

QUESTION

varchar

QUESTION_TYPE_GROUP_ID

Length

Null
Allowed

Description

No

Identifier; primary key.

2000

No

Normalized version of the endusers question. Truncated if it


exceeds the maximum length.

2000

No

Exact question entered by enduser.

integer

No

Foreign key to
QUESTION_TYPE_GROUP.ID.

QUESTION_NUMBER_GROUP_ID

integer

No

Foreign key to
ARF_SEARCH_NUMBER_GROUP.ID.

WORD_COUNT

integer

No

Number of words in the input


question.

88
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

ARF_CONTENT
Stores information about the content returned to end-users as the result of their search.

Column Name

Type

ID

smallint

TITLE

varchar

URL_KEY

Length

Null Allowed

Description

No

Identifier; primary key.

500

Yes

Content title.

varchar

254

No

Hash of the full URL plus first 200


characters of the URL.

URL

varchar

2000

No

URL of the content retrieved.

CONTENT_TYPE

varchar

100

No

Doc Type or for repository items, the


repository item descriptor name

ARF_SEARCH_NUMBER
Stores the numbers used in end-user searches.

Column Name

Type

ID

smallint

QUANTITY

Varchar

Length

40

Null Allowed

Description

No

Identifier; primary
key.

No

ARF_SEARCH_NUMBER_GROUP
This table contains information about numbers used in end-user searches.

Column Name

Type

ID

smallint

NAME

varchar

Length

254

Null Allowed

Description

No

Identifier; primary key.

No

Name of the group.

89
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

HASH_VALUE

varchar

254

LENGTH

smallint

No

Used during data


loading.

No

Size of the number


group.

ARF_SEARCH_NUMBER_GRP_MBRS
This table maps items in the ARF_SEARCH_NUMBER table to items in ARF_SEARCH_NUMBER_GROUPS.

Column Name

Type

SEARCH_NUMBER_GROUP_ID

SEARCH_NUMBER_ID

Length

Null
Allowed

Description

smallint

No

Primary key component; foreign


key to
ARF_SEARCH_NUMBER_GROUP.

integer

No

Primary key component; foreign


key to ARF_SEARCH_NUMBER.

ARF_SEARCH_TOPIC
Stores information about topics configured in the ATG Search Workbench.

Column Name

Type

ID

smallint

NTOPIC_ID

varchar

PARENT_TOPIC_ID

integer

NAME

varchar

NAME_EN

Length

Null Allowed

Description

No

Identifier; primary key.

No

Natural key of topic.

Yes

ID of parent topic from this


table.

254

No

Topic name in the default


language.

varchar

254

Yes

Topic name in English.

DESCRIPTION

varchar

1000

Yes

Topic description in the


default language.

DESCRIPTION_EN

varchar

1000

Yes

Topic description in English.

40

90
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

RECORD_START_DATE

timestamp

Yes

Date when the information in


this warehouse record
became effective

RECORD_END_DATE

timestamp

Yes

Date when the information in


this warehouse record is no
longer effective.

RECORD_LAST_UPDATE

timestamp

Yes

Date this re

MOST_RECENT

one-digit

No

Indicates that this record is


the most recent.
0 = No
1 = Yes
Default value is 1.

DELETED

one-digit

No

Indicates that this record has


been deleted.
0= No
1 = Yes
Default value is 0.

TOPIC_PATH

varchar

4000

Yes

Path to this topic in the topic


taxonomy.

ARF_TOPIC_GROUP
Column Name

Type

ID

smallint

NAME

varchar

HASH_VALUE

varchar

LENGTH

smallint

Length

Null Allowed

Description

No

Identifier; primary
key.

254

No

Topic group name.

254

No

Used during data


loading.

No

Size of the topic


group.

91
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

ARF_TOPIC_GROUP_MBRS
Relates topic groups to topics.

Column Name

Type

TOPIC_GROUP_ID

TOPIC_ID

Length

Null Allowed

Description

integer

No

Foreign key to
ARF_TOPIC_GROUP.PD; primary key
component.

integer

No

Foreign key to
ARF_SEARCH_TOPIC.ID; primary key
component.

ARF_WORD
Stores individual unknown words, as determined by the Search engine.

Column Name

Type

ID

smallint

WORD

varchar

Length

100

Null Allowed

Description

No

Identifier; primary
key.

No

The unknown word


submitted as part of
the query.

Null Allowed

Description

No

Identifier; primary
key.

No

Name of the word


group.

ARF_WORD_GROUP
List of unknown words in a user query.

Column Name

Type

ID

smallint

NAME

varchar

Length

254

92
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

HASH_VALUE

varchar

NUM_WORDS

smallint

254

No

Used during data


loading.

No

Size of the word


group.

ARF_WORD_GROUP_MBRS
Relates words to word groups.

Column Name

Type

WORD_GROUP_ID

WORD_ID

Length

Null Allowed

Description

smallint

No

Foreign key to
ARF_WORD_GROUP.PD; primary key
component.

integer

No

Foreign key to ARF_WORD.ID;


primary key component.

ARF_PROFILE_TYPE
References the repositories in which user profiles can be located.

Column Name

Type

ID

smallint

REPOSITORY_NAME

varchar

Length

40

Null Allowed

Description

No

Identifier; primary
key.

No

Name of the
repository.

ARF_QUERY
Stories queries which are submitted to ATG Search; that is, the end-users question after preliminary
processing has taken place.

93
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

Column Name

Type

ID

smallint

QUERY_DAY_ID

varchar

QUERY_TIME_ID

integer

NQUERY_ID

varchar

EXTERNAL_PROFILE_ID

integer

INTERNAL_PROFILE_ID

varchar

PROFILE_TYPE_ID

Length

Null
Allowed

Description

No

Identifier; primary key.

No

Foreign key to
ARF_TIME_DAY.ID

No

Foreign key to
ARF_TIME_TOD.ID

No

Natural ID of the query.

No

Foreign key to ARF_USER.ID

No

Foreign key to ARF_IU_USER.ID

smallint

No

Foreign key to
ARF_PROFILE_TYPE.ID

SEARCH_SITE_ID

smallint

No

Foreign key to
ARF_SEARCH_SITE.ID

SEARCH_ENVIRONMENT_ID

smallint

No

Foreign key to
ARF_SEARCH_ENVIRONMENT.ID

LANGUAGE_ID

smallint

No

Foreign key to
ARF_LANGUAGE.ID

QUERY_TYPE_ID

tinyint

No

Foreign key to
ARF_QUERY_TYPE.ID

QUESTION_ID

integer

No

Foreign key to
ARF_QUESTION.ID

SEGCLSTR_ID

integer

No

Foreign key to
ARF_SEGCLSTR.ID

DEMOGRAPHIC_ID

smallint

No

Foreign key to
ARF_DEMOGRAPHIC.ID

SITE_VISIT_ID

bigint

No

Foreign key to
ARF_SITE_VISIT.ID

WORD_GROUP_ID

integer

No

Foreign key to
ARF_WORD_GROUP.ID

TOPIC_GROUP_ID

integer

No

Foreign key to
ARF_TOPIC_GROUP.ID,
identifies a question topic.

SELECTED_TOPIC_GROUP_ID

integer

No

Foreign key to
ARF_TOPIC_GROUP.ID,
identifies a constraint topic.

40

40

40

94
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

RESPONSE_TIME

integer

No

Response time of Search engine


in ms.

TOP_SCORE

integer

No

Top score of returned results.

RESULTS_COUNT

integer

No

Count of results for this query.

LAST_SELECTED

onedigit

No

Indicates whether this is the


final query in the session.
0 = No
1 = Yes

SESSION_ID

varchar

128

Yes

ID of the user session.

ARF_VIEW_CONTENT
Stores view content activities that are submitted to ATG Search. A view content activity occurs when a
user performs a query and clicks on a link for any result to see its details.

Column Name

Type

ID

smallint

VIEW_DAY_ID

varchar

VIEW_TIME_ID

Length

Null Allowed

Description

No

Identifier; primary key.

No

Foreign key to
ARF_TIME_DAY.ID

integer

No

Foreign key to
ARF_TIME_TOD.ID

SEARCH_SITE_ID

smallint

No

Foreign key to
ARF_SEARCH_SITE.ID

SEARCH_ENVIRONMENT_ID

smallint

No

Foreign key to
ARF_SEARCH_ENVIRONMENT.ID

LANGUAGE_ID

smallint

No

Foreign key to
ARF_LANGUAGE.ID

CONTENT_ID

integer

No

Foreign key to
ARF_CONTENT.ID

QUERY_ID

integer

No

Foreign key to ARF_QUERY.ID

EXTERNAL_PROFILE_ID

integer

No

Foreign key to ARF_USER.ID

INTERNAL_PROFILE_ID

varchar

No

Foreign key to ARF_IU_USER.ID

40

40

95
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

PROFILE_TYPE_ID

smallint

No

Foreign key to
ARF_PROFILE_TYPE.ID

SEGCLSTR_ID

integer

No

Foreign key to
ARF_SEGCLSTR.ID

DEMOGRAPHIC_ID

smallint

No

Foreign key to
ARF_DEMOGRAPHIC.ID

SITE_VISIT_ID

bigint

No

Foreign key to
ARF_SITE_VISIT.ID

TOPIC_GROUP_ID

integer

No

Foreign key to
ARF_TOPIC_GROUP.ID

LAST_VIEWED

onedigit

No

Indicates whether this content


item is the last item viewed by
the user.

SESSION_ID

varchar

Yes

ID of the user session in which


the content was viewed.

128

ARF_SEARCH_SITE_VISIT
Stores information about Search site visits. These activities are fired when users perform any search
against a particular environment.

Column Name

Type

ID

smallint

SSV_DAY_ID

varchar

SSV_TIME_ID

Length

Null Allowed

Description

No

Identifier; primary key.

No

Foreign key to
ARF_TIME_DAY.ID

integer

No

Foreign key to
ARF_TIME_TOD.ID

SEARCH_SITE_ID

smallint

No

Foreign key to
ARF_SEARCH_SITE.ID

SEARCH_ENVIRONMENT_ID

smallint

No

Foreign key to
ARF_SEARCH_ENVIRONMENT.ID

EXTERNAL_PROFILE_ID

integer

No

Foreign key to ARF_USER.ID

INTERNAL_PROFILE_ID

varchar

No

Foreign key to ARF_IU_USER.ID

40

40

96
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

PROFILE_TYPE_ID

smallint

No

Foreign key to
ARF_PROFILE_TYPE.ID

SEGCLSTR_ID

integer

No

Foreign key to
ARF_SEGCLSTR.ID

DEMOGRAPHIC_ID

smallint

No

Foreign key to
ARF_DEMOGRAPHIC.ID

SITE_VISIT_ID

bigint

No

Foreign key to
ARF_SITE_VISIT.ID

LANGUAGE_ID

smallint

No

Foreign key to
ARF_LANGUAGE.ID

SESSION_ID

varchar

Yes

Session ID of the site visit.

128

Search ERD

97
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

98
7 - Search Database Tables

ATG Customer Intelligence Data Warehouse Guide

8 Platform Metadata Model

This chapter describes the metadata model for the ATG platform. This metadata is available to be used
with any application. Each section of this chapter includes the model and dimensional views for each part
of the platform metadata. Because this guide already provides detailed information on the database
structure, the database view of the metadata model has been omitted. You can use the Framework
Manager to access this view (see the Framework Manager User Guide). The Framework Manager project for
this model is located at:
<ATG2007.1Dir>/ARF/DW/base/cpf/ATG.cpf

This chapter includes the following sections:


Platform Action Logs
Time Metadata
Gender Metadata
Age Group Metadata
Language Metadata
Marital Status Metadata
Currency Metadata
Country and Region Metadata
Segment Metadata
Stimulus Metadata
User Metadata
Site Visit Metadata

Platform Action Logs


The following action logs are available to construct the model using the BmtScriptPlayer tool. See the
Framework Manager User Guide for more information.
The action logs should be executed in the order specified:

<ATG2007.1dir>/ARF/DW/base/cpf/01InitializeModel.xml

99
8 - Platform Metadata Model

ATG Customer Intelligence Data Warehouse Guide

<ATG2007.1dir>/ARF/DW/base/cpf/02DatabaseView.xml

<ATG2007.1dir>/ARF/DW/base/cpf/03ModelView.xml

<ATG2007.1dir>/ARF/DW/base/cpf/04DimensionalView.xml

Time Metadata
Modeling time-series data is an import part of any data warehouse. The following section outlines the
implementation of time-series data in the ATG data warehouse.
The time-series model view is shown in the figure below. It contains model query subjects based on the
database tables described in the Time Tables section of the Platform Database Tables chapter. The model
query subjects represent the components of an instant in time.

The time series data is represented by a single dimension called Time. The Time dimension contains four
hierarchies, which traverse the month, the quarter, the week, and the hour.

100
8 - Platform Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Gender Metadata
The gender query subject includes the following query items:

IdUnique identifier

GenderLocalized based on your locale if you have created columns in the database
to support this; if there is no such column for your locale it uses the information in the
default language.

Gender (default language)The name of the gender in your sites default language.

The Gender regular dimension has one hierarchy, which has two levels: Gender and Gender (All).

Age Group Metadata


The age group query subject includes the following query items:

IdUnique identifier

101
8 - Platform Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Age GroupLocalized age group name based on your locale if you have created
columns in the database to support this; if there is no such column for your locale it
uses the information in the default language.

Age Group (default language)The name of the age group in your sites default
language.

Age MinMinimum bound for the age group.

Age MaxMaximum bound for the age group.

The Age Group regular dimension has one hierarchy, which has two levels: Age Group and Age Group
(All).

Language Metadata
The Language query subject includes the following query items:

IdUnique identifier

LanguageLanguage name, localized based on your locale if you have created


columns in the database to support this; if there is no such column for your locale it
uses the information in the default language.

Language (default language)The name of the language in your sites default


language.

ISO 639-1 ALPHA 2Two-letter ISO code for language.

ISO 639-2 ALPHA 3Three-letter ISO code for language.

102
8 - Platform Metadata Model

ATG Customer Intelligence Data Warehouse Guide

The Language regular dimension has one hierarchy, which has two levels: Language and Language (All).

Marital Status Metadata


The Marital Status query subject includes the following:

IdUnique identifier

Marital StatusLocalized marital status name based on your locale if you have created
columns in the database to support this; if there is no such column for your locale it
uses the information in the default language.

Marital Status (default language)The name of the marital status in your sites default
language.

The default options are married, unspecified, and single.

The Marital Status regular dimension has one hierarchy, which has two levels: Marital Status and Marital
Status (All).

103
8 - Platform Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Demographic Metadata
The Demographic query subject collects demographic information together for easy reference. It refers to
other query subjects for data.

There is no regular dimension for demographic.

Currency Metadata
The Currency query subject includes the following:

IdUnique identifier

CurrencyCurrency name, localized based on your locale if you have created columns
in the database to support this; if there is no such column for your locale it uses the
information in the default language.

Currency(default language)The name of the currency in your sites default language.

ISO 4217 ALPHA3 CODEThree-letter ISO code for language.

ISO 4217 NUM3 CODEThree-number ISO code for language.

104
8 - Platform Metadata Model

ATG Customer Intelligence Data Warehouse Guide

The Currency regular dimension has one hierarchy, which has two levels: Currency and Currency (All).

Country and Region Metadata


The Country query subject includes the following:

IdUnique identifier

CountryCountry name, localized based on your locale if you have created columns
in the database to support this; if there is no such column for your locale it uses the
information in the default language.

Country (default language)The name of the country in your sites default language.

ISO 3166-1 ALPHA 2 CodeTwo-letter ISO code for country.

ISO 3166-1 ALPHA 3 CodeThree-letter ISO code for country.

ISO 3166-1 NUM3 CodeThree-number ISO code for country.

FIPS 10-4 Country CodeFIPS code for country.

The Region query subject includes the following:

105
8 - Platform Metadata Model

ATG Customer Intelligence Data Warehouse Guide

IdUnique identifier

Country IdID of country in which region is.

RegionRegion name, localized based on your locale if you have created columns in
the database to support this; if there is no such column for your locale it uses the
information in the default language.

Region (default language)The name of the region in your sites default language.

ISO 3166-2 ALPHA 2 CodeTwo-letter ISO code for region.

FIPS 10-4 Region CodeFIPS code for region.

The Geography regular dimension combines country and region. It consists of one hierarchy with the
following levels: Region, Country, and Country-Region (All).

Segment Metadata
Segments are subsets of users, who are assigned to segments based on rules. Since any person can
belong to multiple segments, reporting on sales by segment can result in the appearance of inflated
revenue; segment clusters provide a more precise view of how people group themselves.
Three query subjects are related to segments. The Segment query subject lists segments. The Segment
Cluster query subject identifies all possible combinations of segments. The Segment Cluster Members
query subject identifies segments with the clusters of which they are members.

106
8 - Platform Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Size refers to the number of segments in the cluster.


The Segment regular dimension includes two hierarchies, one of which includes the segment cluster data,
the other only the Segment and Segment (All).

Stimulus Metadata
The stimulus is the identified reason for which a customer places an order. Since there can be multiple
stimuli, the ATG data warehouse allows for stimulus groups.
The Stimulus query subject lists stimuli. The Stimulus Group query subject identifies all possible
combinations of stimuli. The Stimulus Group Members query subject identifies stimuli with the groups of
which they are members.

107
8 - Platform Metadata Model

ATG Customer Intelligence Data Warehouse Guide

The Stimulus regular dimension includes two hierarchies, one of which includes the stimulus group data,
the other only the Stimulus and Stimulus (All).

User Metadata
The User query subject contains information from the users profile, in both localized and default
languages where applicable. The Home Region and Home Country are the region and country of the
users home address.

108
8 - Platform Metadata Model

ATG Customer Intelligence Data Warehouse Guide

The User regular dimension has one hierarchy, which has two levels: User and User (All).

Site Visit Metadata


The Site Visit and Site Visit Facts query subjects provide information about visits to your site.

The Site Visit regular dimension has one hierarchy, which has two levels: Site Visit and Site Visit (All).

109
8 - Platform Metadata Model

ATG Customer Intelligence Data Warehouse Guide

110
8 - Platform Metadata Model

ATG Customer Intelligence Data Warehouse Guide

9 Internal User Directory Metadata

This chapter describes the metadata model for the Internal User Directory. This metadata is available to be
used with any application. This chapter includes the model and dimensional views for each part of the
internal user metadata. Because this guide already provides detailed information on the database
structure, the database view of the metadata model has been omitted. You can use the Framework
Manager to access this view (see the Framework Manager User Guide). The Framework Manager project for
this model is located at:
The Framework Manager project for this model is located at:
<ATG2007.1Dir>/ARF/DW/InternalUsers/cpf/ATG.cpf

This chapter includes the following sections:


Internal User Action Logs
Internal User Directory Model View
Internal User Directory Dimensional View

Internal User Action Logs


The following action logs are available to construct the model using the BmtScriptPlayer tool. See the
Framework Manager User Guide for more information.
The action logs should be executed in the order specified:

<ATG2007.1dir>/ARF/DW/InternalUsers/cpf/01InitializeModel.xml

<ATG2007.1dir>/ARF/DW/InternalUsers/cpf/02DatabaseView.xml

<ATG2007.1dir>/ARF/DW/base/InternalUsers/cpf/03ModelView.xml

<ATG2007.1dir>/ARF/DW/base/InternalUsers/cpf/04DimensionalView.xml

111
9 - Internal User Directory Metadata

ATG Customer Intelligence Data Warehouse Guide

Internal User Directory Model View


The internal user directory model allows independent access to each level of the internal user directory.
The model view is shown in the figure that follows:

Internal User Directory Dimensional View


The Internal User Directory regular dimension has two hierarchies, one of which allows a user to travel
down the entire hierarchy, the other of which reaches a given user by way of the organization with which
they are associated.

112
9 - Internal User Directory Metadata

ATG Customer Intelligence Data Warehouse Guide

113
9 - Internal User Directory Metadata

ATG Customer Intelligence Data Warehouse Guide

114
9 - Internal User Directory Metadata

ATG Customer Intelligence Data Warehouse Guide

10 Commerce Metadata Model

This chapter describes the metadata model for ATG Commerce. This chapter includes the model and
dimensional views for each part of the metadata. Because this guide already provides detailed
information on the database structure, the database view of the metadata model has been omitted. You
can use the Framework Manager to access this view (see the Framework Manager User Guide).
Note: In addition to its own metadata, ATG Commerce also makes use of the platform metadata models
described previously in this guide.
The Framework Manager project for this model is located at:
<ATG2007.1Dir>/DCS/DW/cpf/ATG.cpf

This chapter includes the following sections:


Catalog Metadata
Order Metadata
Affinity Metadata
Note: ATG Commerce uses some platform metadata under different names. The Commerce Customer
and Site Visitor entities are essentially the same as the platform User; see the User Metadata section of this
guide. Commerce includes a Billing Region and Country and a Shipping Region and Country, which
provide region and country data; see the Country and Region Metadata section of this guide.

Catalog Metadata
The Category query subject provides information about the category of a purchased item.

115
10 - Commerce Metadata Model

ATG Customer Intelligence Data Warehouse Guide

The Product query subject provides information about a product.

The Sku query subject provides information about an individual SKU.

116
10 - Commerce Metadata Model

ATG Customer Intelligence Data Warehouse Guide

The Catalog regular dimension includes one dimension, which allows you to traverse from Sku up to the
Category.

Order Metadata
The Order query subject includes provides the IDs of the order itself and the site visit during which it took
place.

The Line Item query subject provides the IDs of individual line items and the orders in which they were
included.

117
10 - Commerce Metadata Model

ATG Customer Intelligence Data Warehouse Guide

The Line Item Facts query subject provides information about an individual line item. Important items to
note in this query subject are:

Net SalesRevenue after adjustments due to discounts, taxes, and shipping, in the
reporting currency.

UnitsQuantity of this line item ordered.

DiscountsSum of order-level discounts allocated to this line item + any discounts


applied to the specific line item.

Average Selling PriceAverage of unit prices across your data set.

The Order regular dimension has one hierarchy, with levels for the order and for line items within that
order.

118
10 - Commerce Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Affinity Metadata
Affinity metadata is divided into two namespaces, Aggregate Affinity Facts and Personal Affinity Facts.
These divisions are intended to help you create effective reports. For information about affinity, see the
Implementing Affinity Selling chapter of the ATG Commerce Guide to Setting Up a Store.

Aggregate Affinity Facts


The Aggregate Affinity Facts namespace includes query subjects dealing with affinity between products
and catalogs.

Aggregate Affinity Model View


The Product Affinity query subject provides access to affinity information about product pairs. It includes
the affinity score, the number of times the product pair occurs, and the total spread.
Spread is defined as the number of days between purchases for each product in a product pair. For
example, if Product 1 is purchased on April 1, and Product 2 is purchased on April 5, the spread is 4. The
Purchase to Purchase Total Spread represents the sum of the spreads for all product pairs. Total Spread
can be divided by Occurrences to give the average number of days separating products in a product pair.

The Category Affinity query subject provides the same information as Product Affinity, but with regard to
categories.

119
10 - Commerce Metadata Model

ATG Customer Intelligence Data Warehouse Guide

The Product Affinity by Segment query subject allows you to break down product affinity data by the
users segment.

The Category Affinity by Segment query subject allows you to break down category affinity data by the
users segment.

The Product1, Product2, Category1, and Category2 query subjects provide information about the
products and categories involved in the purchases. Products and categories are described in the Catalog
Metadata section; two query subjects are needed for each in order to make comparisons. Segment and
Date query subjects are described in the Platform Metadata Model chapter.

All Affinities by Product or Category


The Aggregate Affinity Facts namespace includes a folder called All Affinities by Product or Category. This
folder contains two additional query subjects, Product Affinity by Product and Category Affinity by
Category. These query subjects are designed to make it easier to create reports that provide data in
relationship to a fixed product or category.
The intent of affinity selling is to measure relationships between pairs of products or categories. Each pair
has a designated Product1 and Product2. In order to eliminate duplicate data in the warehouse, products
in the pair lists are ordered by a sort. For example, one pair may consist of Pants and Belts, while another
pair consists of Shirts and Pants. Both pairs include Pants, but in one pair, Pants is Product1, and in

120
10 - Commerce Metadata Model

ATG Customer Intelligence Data Warehouse Guide

another is Product2. This means that if you want to see all products paired with Pants, you must
remember to include all pairs where Product1=Pants and where Product2=Pants. The resulting report will
be difficult to interpret, since Pants could be in either position.
The Product Affinity by Product and Category Affinity by Category query subjects represent unions of the
pairing tables. The union selects all rows from the table, then swaps Product 1 and Product 2 and again
returns all of the rows. This means that the number of rows in the new query subject is exactly double the
original table. It also means if a report requires all Products associated with Pants, the filter is simply on
Product 1, and all associated products are in the Product 2 column. In this case, there will not be duplicate
data.
For example, the original table might include the following data:

Product 1

Product 2

Affinity

Belts

Pants

2.3

Pants

Shirts

1.7

Pants

Toothbrushes

0.2

The union would look like the following table:

Product 1

Product 2

Affinity

Belts

Pants

2.3

Pants

Shirts

1.7

Pants

Toothbrushes

0.2

Pants

Belts

2.3

Shirts

Pants

1.7

Toothbrushes

Pants

0.2

In the union query subject, you can see that Pants are associated with Shirts, Toothbrushes and Belts by
looking solely at Product 1.

Aggregate Affinity Dimensional View


The Aggregate Affinity dimensional view includes Date, Segment, Catalog1 and Catalog2 dimensions
found in the platform metadata model. The Affinity-specific dimensions contain only measures, and do
not use hierarchies. The dimensional view is shown in the diagram that follows.

121
10 - Commerce Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Personal Affinity Facts


The Personal Affinity Facts namespace is a collection of query subjects that have to do with how
individual users make purchases. This namespace is not included in ATGs published model and is not
used in any provided reports. However, you can publish this model yourself if you want to build reports
based on this data.

Personal Affinity Facts Model View


The Personal Affinity Facts namespace includes the Customer (same as User), and Date query subjects
from the Platform Metadata Model, and the Product and Category query subjects described in the
Catalog Metadata section of this chapter. In addition, the Personal Affinity Facts namespace includes the
Customer to Product, Customer to Category, and Customer Price query subjects.
The Customer to Product query subject provides information about an individual customer purchase at
the product level.

122
10 - Commerce Metadata Model

ATG Customer Intelligence Data Warehouse Guide

The Customer to Category query subject provides information about an individual customer purchase at
the category level.

The Customer Price query subject provides information about the prices contained in an individual
customers purchase. The Maximum Item Price represents the highest-priced item in a given purchase,
the Minimum Item Price the lowest-priced item, etc.

Personal Affinity Dimensional View


The Personal Affinity dimensional view includes Date, Customer, and Catalog dimensions found in the
platform metadata model, which include hierarchies. The Affinity-specific Customer Price, Customer to
Category, and Customer to Product dimensions contain only measures. The dimensional view is shown in
the diagram that follows.

123
10 - Commerce Metadata Model

ATG Customer Intelligence Data Warehouse Guide

124
10 - Commerce Metadata Model

ATG Customer Intelligence Data Warehouse Guide

11 Knowledge Metadata Model

This chapter describes the metadata model used for ATG Knowledge.
Note: In addition to its own metadata, ATG Knowledge also makes use of the platform metadata models
described in this guide.
The Framework Manager project for this model is located at:
<ATG2007.1dir>/Service2007.1/Service/KnowledgeDataWarehouse/cpf/
Knowledge.cpf

This chapter includes the following sections:


Knowledge Action Logs
Knowledge Model View
Knowledge Dimensional View

Knowledge Action Logs


The following action logs are available to construct the model using the BmtScriptPlayer tool. See the
Framework Manager User Guide for more information.

<ATG2007.1dir>/Service2007.1/Service/KnowledgeDataWarehouse/cpf/02D
atabaseView.xml

<ATG2007.1dir>/Service2007.1/Service/KnowledgeDataWarehouse/cpf/03M
odelView.xml

<ATG2007.1dir>/Service2007.1/Service/KnowledgeDataWarehouse/cpf/04D
imensionalView.xml

Knowledge Model View


The diagram that follows shows the model view for Knowledge-specific metadata.

125
11 - Knowledge Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Knowledge Dimensional View


The dimensional views for the Knowledge metadata include the following:

Solution Information

126
11 - Knowledge Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Solution Activity

Internal User Activity

127
11 - Knowledge Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Session Activity

128
11 - Knowledge Metadata Model

ATG Customer Intelligence Data Warehouse Guide

12 Response Management Metadata


Model

This section describes the metadata model that is specific to ATG Response Management. For database
information, see the Response Management Database Tables chapter.
The Framework Manager project for this model is located at:
<ATG2007.1dir>\ARM2007.1\ARM\DataWarehouse\cpf\ResponseManagement.cpf

This chapter includes the following sections:


Response Management Action Logs
Response Management Model View
Response Management Dimensional View

Response Management Action Logs


The following action logs are available to construct the model using the BmtScriptPlayer tool. See the
Framework Manager User Guide for more information.
<ATG2007.1dir>\ARM2007.1\ARM\DataWarehouse\cpf\02DatabaseView.xml
<ATG2007.1dir>\ARM2007.1\ARM\DataWarehouse\cpf\03ModelView.xml
<ATG2007.1dir>\ARM2007.1\ARM\DataWarehouse\cpf\04DimensionalView.xml

Response Management Model View


The model view for Response Management metadata is shown below.
It contains ten model query subjects, representing the Ticket Queue, Channel, User Open Tickets,
Customer Open Tickets, Classified Inbound Message, Unclassified Inbound Messages, Internal User
Outbound Messages, Automatic Outbound Messages, User Ticket Actions, and Target.

129
12 - Response Management Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Response Management Dimensional View


The following diagram shows the Response Management metadata components that use Time data. The
diagram is simplified due to the great many interconnections between the Response Management
dimensions.

130
12 - Response Management Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Response Management Dimensions Using Time Data (Simplified)

Response Management Dimensions Using Internal User Directory

131
12 - Response Management Metadata Model

ATG Customer Intelligence Data Warehouse Guide

The remaining diagrams in this chapter show a detailed view of each of the Response Managementspecific models.
Metrics used in the Response Management metadata are:

Classified Inbound Message Count and Unclassified Inbound Message Count. The only
difference between these metrics is that the classified inbound message metric
includes the Response Management target to which the message was classified. The
message count refers to the number of messages successfully received by the
Response Management system.

User Response Count. The number of messages successfully sent out through
Response Management processes.

Automatic Acknowledgement Count. The number of automatic acknowledgements


sent out. As in we have received your message and will reply shortly.

The Automatic Response count is the number of automatic responses that have been
sent out (this uses the classification process to determine the auto response).

The dimensional view for the Response Management metadata includes the following:

Customer Opened Tickets

User Ticket Actions

132
12 - Response Management Metadata Model

ATG Customer Intelligence Data Warehouse Guide

User Opened Tickets.

133
12 - Response Management Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Automatic Outbound Message.

User Outbound Message

134
12 - Response Management Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Unclassified Inbound Message.

Classified Inbound Message.

135
12 - Response Management Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Ticket Queue.

Target. When a message comes in and gets classified to a Target with an associated
Ticket Queue, then sent to the appropriate user with the classification content.

Channel.

136
12 - Response Management Metadata Model

ATG Customer Intelligence Data Warehouse Guide

13 Outreach Metadata Model

This section describes the metadata model that is specific to ATG Outreach. For database information, see
the Outreach Database Tables chapter.
The Framework Manager project for this model is located at:
<ATG2007.1dir>\ACO2007.1\DataWarehouse\cpf\ATG.cpf

This chapter includes the following sections:


Outreach Model View
Outreach Dimensional View

Outreach Model View


The Outreach metadata model view is divided into four main areas:

Email Recipient Lists

Audit Trail Facts

Email Facts

Participation Facts

Email Recipient Lists


The Email Recipient List metadata allows you to collect information about particular emails within an
Outreach campaign.

137
13 - Outreach Metadata Model

ATG Customer Intelligence Data Warehouse Guide

It also includes the Participant (User), Segment Cluster, Time, and Date platform query subjects, shown
collapsed in the diagram above. Platform metadata is shown collapsed; see the Platform Metadata Model
chapter for information.

Audit Trail Facts


The Audit Trail Fact metadata model collects information about a campaign, its stages, actions, and
events.

138
13 - Outreach Metadata Model

ATG Customer Intelligence Data Warehouse Guide

It includes Participant (User), Segment Cluster, Time, and Date platform query subjects, shown collapsed
in the diagram above. See the Platform Metadata Model chapter for information.

Email Facts
The Email Facts metadata includes a number of EmailFact query subjects, which represent different
filters applied to a single database table. For simplicity, these query subjects are all represented by the
Email Count Fact, shown highlighted in the diagram that follows:

139
13 - Outreach Metadata Model

ATG Customer Intelligence Data Warehouse Guide

The Email Facts metadata also uses the Participant (User), Time, and Date query subjects from the
platform metadata.
All EmailFact query subjects have the same relationships to the other query subjects in the model. The
query subjects are:

Email Count Fact

Email Sent Fact

Email Failed Fact

Email Opened Fact

Email Hard Bounce Fact

Email Soft Bounce Fact

Email Opt Out Fact

Email Clicked Fact

The EmailFact query subjects include the following query items:

140
13 - Outreach Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Participation Facts
The Participation Facts part of the metadata model links a campaign entered event with its who, what,
where, and when.
It uses the Date, Participant (User), Segment Cluster, and Time from the platform metadata model (shown
collapsed).

Outreach Dimensional View


All regular dimensions in the Outreach metadata model have only one hierarchy.

141
13 - Outreach Metadata Model

ATG Customer Intelligence Data Warehouse Guide

The Date, Time, Segment, and Participant (User) are from the platform metadata. See the Platform
Metadata Model chapter for information.

142
13 - Outreach Metadata Model

ATG Customer Intelligence Data Warehouse Guide

14 Search Metadata Model

This section describes the metadata model that is specific to ATG Search. For database information, see
the Search Database Tables chapter.
The Framework Manager project for this model is located at:
<ATG2007.1dir>\Search2007.1\SearchAdmin\datawarehouse\cpf\Search.cpf

This chapter includes the following sections:


Search Model View
Search Dimensional View

Search Model View


The central component of the Search model metadata is the Query Facts query subject.

Query Facts uses the following platform query subjects: External User (see User Metadata), Time, Date,
Language, and Demographic, which in turn uses Region, Country, Marital Status, Age Group, Segment

143
14 - Search Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Cluster, and Gender (see the Platform Metadata Model chapter for information on these query subjects). It
also uses the Internal User and Internal Organization query subjects (see the Internal User Directory
Metadata chapter).
Additional Search query subjects are shown in the diagram that follows.

Search Dimensional View


Dimensional metadata for search is divided into Query, Viewed Content, and Site Visit, as shown in the
diagrams that follow.
To conserve space, platform measures in the Query dimension are shown collapsed.

144
14 - Search Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Query Dimension

Viewed Content Dimension

145
14 - Search Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Site Visit Dimension

146
14 - Search Metadata Model

ATG Customer Intelligence Data Warehouse Guide

Glossary

Item

Definition

access permissions

Rules defining the access rights to resources. Access permissions


can be granted to any combination of namespaces, groups, or
users. Examples of resources are reports and folders.

agent

The object type created and edited by Event Studio. An agent


contains the event condition and the associated tasks to perform.
Once defined, an agent can be scheduled to check for instances
of the event.

authentication

The process of verifying the identity of users when they log on.
Users must be authenticated before they can be authorized to
use any secured resources.

burst

To create many report results by running a single report once. For


example, you can create a report that shows sales for each
employee, and run it once, sending different results to regional
managers by bursting on region. You set up bursting in Report
Studio and enable it in the portal.

contact

A named email address to which reports and agent emails can be


sent. Contacts are never authenticated.

content locale

A code that is used to set the language or dialect used for


browsers, report text, and so on; and the regional preferences,
such as formats for time, date, money, money expressions, and
time of day. You can specify a locale for the product interface
(product locale) and for the data in the report (content locale).

credentials

Information stored about the identity of a user, usually a user


name and password. You can assign your credentials to someone
else so that they can use resources that you are authorized to
use. Credentials are created for components. If a user schedules
or programs an action, then credentials must be stored in the
content store.

147
Glossary

ATG Customer Intelligence Data Warehouse Guide

deployment

The process of moving a Reporting application (reports, models,


and so on) to a different instance of Reporting. For example, you
often create reports in a test environment and then deploy them
to production. When you deploy an application, you export,
transfer, and import it.

event

An exceptional item of data, defined by specifying a query


expression against items in a package. When data is detected
matching the event condition, it causes an agent to perform
tasks.

group

In security, a list of users or other groups that can be used to


assign access permissions and capabilities. Groups can be
referenced from third-party authentication sources or can be
local to Reporting. Local groups are managed from the
administration portal. The list of groups that an authentication
user is a member of is part of the users passport for a Reporting
session. In reporting, grouping is the action of organizing
common values of query item together and only displaying the
value once. Headers and footers often appear after each instance
of a common value in a grouped column

job

A group of objects, such as reports, agents, and other jobs that


you run and schedule as a batch.

locale

A code that is used to set the language or dialect used for


browsers, report text, and so on; and the regional preferences,
such as formats for time, date, money, money expressions, and
time of day. You can specify a locale for the product interface
(product locale) and for the data in the report (content locale).

metric

A measurement of performance in key areas of a business that


compares current results to planned values.

metric package

A Reporting Center representation of a Metric Studio application.


A metric package contains connection information, reports, and
metric management tasks for that application.

model

A physical or business representation of the structure of the data


from one or more data sources. A model describes data objects,
structure, and grouping, as well as relationships and security. A
model, called a design model, is created and maintained in
Framework Manager. The design model or a subset of the design
model must be published to the Reporting server as a package
for users to create and run reports.

148
Glossary

ATG Customer Intelligence Data Warehouse Guide

namespace

For authentication and access control, a configured instance of


an authentication provider. Allows access to user and group
information. In XML, a collection of names, identified by a URI
reference, which are used in XML documents as element types
and attribute names. In Framework Manager, namespaces
uniquely identify query items, query subjects, and so on. You
import different databases into separate namespaces to avoid
duplicate names.

package

A subset of a model, which can be the whole model, to be made


available to the Reporting server. For Metric Studio users, see
metric package.

portlet

A mechanism for displaying Web content as part of a portal page.

product locale

The code or setting that specifies what language, regional


settings, or both to use for parts of the product interface, such as
menu commands.

publish

To expose all or part of a Framework Manager model via a


package to the Reporting server, so that users can use it to create
reports and other content.

report

A set of data deliberately laid out to communicate business


information. Depending on the context, report may refer to
report specification or report output. Report (more precisely,
report specification) is the generic term for the objects created by
edited by Query Studio, Report Studio, and Analysis Studio.

report output

A report output combines data at the point in time when the


report was run with a report specification. It is a document that
can be displayed, printed or emailed. Reporting can produce
report outputs in HTML, PDF, Excel, or CSV formats.

report specification

The definition of queries, prompts, layouts, and styles that make


up a report. A report specification is combined with data by a run
operation to create report outputs. You create report
specifications by using Report Studio, Query Studio, Analysis
Studio, or through the Software Development Kit.

report view

A reference to another report that has its own properties, such as


prompt values, schedules, and results. You use report views to
share a report specification instead of making copies of it.

really simple syndication

See rich site summary.

rich site summary

An industry standard format for displaying transient data, such as


breaking news, in a web page or standalone viewer. Reporting
Center includes a portlet type for displaying RSS format data. This
can be used to display data from a public RSS service or to display
news items generated by agents detecting events. A synonym for
Really Simple Syndication.

149
Glossary

ATG Customer Intelligence Data Warehouse Guide

session

The time during which an authenticated user is logged on to


Reporting.

user

A person accessing a Reporting application. Authenticated user


definitions and information, such as first and last names,
passwords, IDs, locales, and email addresses, are maintained in
third-party authentication sources. Other user information, such
as the location of personal folders or preferred formats for
viewing reports, is stored in Reporting.

Web Services for Remote


Portlets

A standard for creating presentation-oriented Web services so


that they can be easily integrated within other applications, such
as Web portals.

150
Glossary