Database Schema Guide

Transcription

NICE Incentive Compensation Management
Version 4.2
Copyright © 2013 NICE Systems Ltd. All rights reserved.
Information in this document is subject to change without notice and does not represent a commitment on the part of NICE
Systems Ltd. The systems described in this document are furnished under a license agreement or nondisclosure agreement.
All information included in this document, such as text, graphics, photos, logos and images, is the exclusive property of NICE
Systems Ltd. and protected by United States and international copyright laws.
Permission is granted to view and photocopy (or print) materials from this document for personal, non-commercial use only. Any
other copying, distribution, retransmission or modification of the information in this document, whether in electronic or hard copy
form, without the express prior written permission of NICE Systems Ltd., is strictly prohibited. In the event of any permitted
copying, redistribution or publication of copyrighted material, no changes in, or deletion of, author attribution, trademark legend
or copyright notice shall be made.
This product is covered by one or more of the US patents listed at www.nice.com/Patents
ACTIMIZE, Actimize logo, Alpha, Customer Feedback, eGlue Interact, FAST, FAST alpha Silver, Fortent, Fortent Logo, IEX, Insight
from Interactions, Intent. Insight. Impact., Interaction Capture Unit, Know More, Risk Less, Last Message Replay, Mass Detection,
Center, Mirra, My Universe, NICE, NICE Analyzer, NICE Inform, NICE Logo, NICE Perform, NICE Situator, NICE SmartCenter, NICE
Storage Center, NICE Systems, NiceCall, NiceCall Focus, NiceLog, NiceTrack, NiceTrack IP Probe, NiceTrack Location Tracking,
NiceTrack Mass Detection Center, NiceTrack Monitoring Center, NiceTrack Pattern Analyzer, NiceTrack Traffic Analysis, NiceVision,
NiceVision Alto, NiceVision Analytics, NiceVision ControlCenter, NiceVision Digital, NiceVision Net, NiceVision NVSAT, NiceVision
Pro, Open Situation Management, Playback Organizer, POWERCOACH, Scenario Replay, Searchspace, Syfact, Syfact Investigator,
TotalView are trademarks and/or registered trademarks of NICE Systems Ltd.
Adobe® and Adobe Acrobat® are registered trademarks of Adobe Systems Incorporated in the United States.
Microsoft® and Microsoft Excel® are registered trademarks of Microsoft Corporation.
Highcharts® is a registered trademark of Highsoft Solutions AS.
Mule ESB® is a registered trademark of MuleSoft, Inc.
Apache Tomcat® and Tomcat® are registered trademarks of Apache Software Foundation.
All other trademarks are the property of their respective owners.
Applications to register certain of these marks have been filed in certain countries, including Australia, Brazil, the European Union,
Israel, Japan, Mexico, Argentina and the United States. Some of such registrations have matured to registrations.
January 25, 2013 (ICM schema 3.2.129, 4.0.80, 4.1.16, 4.2.115)
Contents
Chapter 1
Introduction to the NICE ICM Schemas . . . . . . . . . . . . . . . . . . . . . 13
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Portal schema overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Policy profile and profile criteria tables . . . . . . . . . . . . . . . . . . . .
Workflow and Inquiry Management features . . . . . . . . . . . . . . . .
Portal configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NICE PM core login and execution . . . . . . . . . . . . . . . . . . . . . . . .
ICM database schema overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data flow in NICE ICM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Load data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calculate data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create statement data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Release payments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Authorize payments. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Create payment file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Related tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
User management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Authorization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Data ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Reference data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Financial calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Payee financial data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Payee queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Payee selection filters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Plans . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Model definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calculator definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Calculation dependency . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Statement batches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Payments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Payment batches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Report execution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Process Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Auditing and logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Localization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Miscellaneous system tables . . . . . . . . . . . . . . . . . . . . . . . . . .
iii
13
14
14
14
15
15
15
16
16
17
20
22
24
26
27
27
30
31
32
33
34
35
35
36
37
41
42
43
44
45
46
47
48
49
50
51
52
53
53
Contents
Data encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Schema updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Oracle settings for the ICM database. . . . . . . . . . . . . . . . . . . . . . .
ICM database file system partitions . . . . . . . . . . . . . . . . . . . .
Table spaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Optimizing the ICM database . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Service platform schema overview . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SCA database schema overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Getting additional assistance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 2
Portal Schema Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
JBPM_ .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_CBEAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_EXECUTION. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_EXECUTIONMESSAGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_EXECUTIONMESSAGETYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_EXECUTIONSTATUSSUMMARY . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_ICM... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_INQUIRY... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_GROUPTYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_LOGINRECORD. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_LOGINTICKET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_METABEANREFERENCE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_MGROUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_MUSER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_PERSON . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_TITLETYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_USERGROUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
M_WORKFLOW... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 3
55
55
56
56
57
57
58
59
59
61
62
62
63
64
65
66
66
66
67
67
68
69
70
71
72
73
74
75
ICM Schema Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
ACCESS_LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ACTIVITY_AUDIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ACTUAL_PAYMENTS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ACTUAL_PLAN_PAYMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ACTUAL_TRAN_PAYMENTS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
API_PARAMETERS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ASSIGNED_TRANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ASSIGNED_TRANS_CLOSED_DELTA . . . . . . . . . . . . . . . . . . . . . . . . .
ASSIGNED_TRANS_CLOSED_ID. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ASSIGNED_TRANS_CLOSED_LEG . . . . . . . . . . . . . . . . . . . . . . . . . . .
ASSIGNED_TRANS_HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ASSIGNED_TRANS_MANAGED_DELTA . . . . . . . . . . . . . . . . . . . . . . .
ASSIGNED_TRANS_MANAGED_ID . . . . . . . . . . . . . . . . . . . . . . . . . .
ASSIGNED_TRANS_MANAGED_LEG . . . . . . . . . . . . . . . . . . . . . . . . .
AT_CLOSED_ACTUAL_PAID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AT_CLOSED_DELTA_ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
AT_MANAGED_ACTUAL_PAID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
iv
77
78
79
80
81
82
82
83
83
84
84
86
87
87
88
88
89
Contents
AT_MANAGED_DELTA_ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
AUDIT_TRAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
AUTH_BUFFER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
AUTH_BUFFER_DELETE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
AUTH_BUFFER_NOTE_ATTACHMENTS . . . . . . . . . . . . . . . . . . . . . . . 92
AUTH_BUFFER_NOTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
AUTH_REQUEST_USERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
AUTH_REQUESTS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
AUTH_RULES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
AUTH_RULES_DELETED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
AUTH_WORKSHEET. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
AUTH_WORKSHEET_JOBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
AUTH_WORKSHEET_REMOVED . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
BASE_DATA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
BASE_SALARIES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
BATCH_RECALCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
BOOKMARK_ENTRIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
BOOKMARKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
BUFFER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
BUFFER_AUTH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
BUFFER_DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
BUFFER_NOTE_ATTACHMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
BUFFER_NOTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
BULK_DATA_FAILURE_UPDATE_FLDS. . . . . . . . . . . . . . . . . . . . . . . 107
BULK_DATA_FAILURE_UPDATES . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
BULLETIN_ACKNOWLEDGED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
BULLETIN_SETTINGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
BULLETINS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110
CALC_DEP_BATCHES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
CALC_DEP_BATCHES_ITEMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
CALC_DEP_PLAN_LOOPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
CALC_JOB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
CALCULATION_BATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
CALCULATION_BATCH_JOBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
CALCULATION_DEPENDENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
CALCULATOR_CELL_FORMAT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
CALCULATOR_CELLS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
CALCULATOR_COLUMN_DETAILS . . . . . . . . . . . . . . . . . . . . . . . . . 119
CALCULATOR_FILTERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
CALCULATOR_NAMED_STYLES . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
CALCULATOR_REFERENCES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
CALCULATOR_SETTINGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
CALCULATOR_TEST_VALUES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
CALCULATORS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
CLAWBACK_BANDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
CLAWBACKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
CLEAN_AT_CALC_JOB_ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
COMPILED_QUERY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
v
Contents
CONTACTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONTENT_ITEMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONVERSION_LIST_HEADER. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CONVERSION_LIST_ITEMS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
COPY_PLANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CORP_TARGET_CASCADE_VALUES . . . . . . . . . . . . . . . . . . . . . . . . .
CORP_TARGET_CASCADES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CORP_TARGET_PLANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CORP_TARGET_VALUES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CORP_TARGETS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CUBE_ ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CURRENCIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CURRENT_ASSIGNED_TRANSn . . . . . . . . . . . . . . . . . . . . . . . . . .
CURRENT_LEDGER_PLAN_ARCHIVEn . . . . . . . . . . . . . . . . . . . . .
CURRENT_LEDGER_PLANn . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CURRENT_LEDGER_TRAN_ARCHIVEn. . . . . . . . . . . . . . . . . . . . .
CURRENT_LEDGER_TRANn . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CUSTOMERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DATA_SOURCE_SETTINGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DATA_SOURCES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DATABASE_ERRORS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DBMS_STATS_OBJECTTAB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DELETE_EMPLOYEES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DELETE_PLANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DELETED_EMPLOYEES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_CUSTOM_LIST_VALUES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_CUSTOM_LISTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_FIELD_ALIAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_LOOKUP_ALIAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_PIVOT_STATE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_REPORT_ACCESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_REPORT_ALIAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_REPORT_EMAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_REPORT_HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_REPORT_PARAMETERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_REPORT_SETTINGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_REPORT_USER_INPUT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_REPORTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_SOURCES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DRN_VALUE_ALIAS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ELEMENT_GROUPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ELEMENT_ITEMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EMP_CURRENCIES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EMPLOYEE_CALC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EMPLOYEE_DRAW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EMPLOYEE_DRAW_AMOUNTS. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EMPLOYEE_HIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EMPLOYEE_RESULTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
vi
127
129
129
130
131
132
133
133
134
135
135
136
136
138
139
140
141
143
144
144
148
148
148
149
149
150
150
151
152
152
153
153
154
155
156
157
157
158
163
164
165
165
166
167
168
170
170
171
Contents
EMPLOYEE_RESULTS_CLOSED. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EMPLOYEE_RESULTS_MANAGED . . . . . . . . . . . . . . . . . . . . . . . . . .
EMPLOYEE_YEAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EMPLOYEES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
EXCHANGE_RATES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FAVOURITE_REPORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FILTER_CRITERIA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FILTER_VALUES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FIN_DAYS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FIN_PERIODS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FIN_YEARS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FLAT_FILES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FORECAST_ACHIEVEMENT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FORECAST_TEMPLATES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FORECAST_VALUES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IMPORT_FILES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
IMPORT_MAPPING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
INCENTIVES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
JOB_DEPENDENTS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
JOB_MEASUREMENT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
JOB_TYPES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
JOBS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_EMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_EMP_ARCHIVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_EMP_CALC_JOB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_PLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_PLAN_ARCHIVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_PLAN_ARCHIVE_HISTORY . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_PLAN_CALC_JOB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_PLAN_HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_TRAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_TRAN_ARCHIVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_TRAN_ARCHIVE_HISTORY . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_TRAN_CALC_JOB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_TRAN_CLOSED. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_TRAN_HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LEDGER_TRAN_MANAGED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LOCKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LOG_FILES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MANAGEMENT_STATEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MANAGER_APPROVALS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MANUAL_PLAN_RESULTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MI_ ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MIGRATION_LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MODEL_ ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MOST_RECENTLY_USED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
MRU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
NON_WORKING_DAYS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
vii
173
174
174
175
180
180
180
182
183
183
184
185
186
186
187
188
189
190
190
191
192
193
195
196
197
198
199
199
200
201
202
202
203
204
204
205
206
206
206
206
207
207
207
208
208
208
209
209
Contents
NOT_AGAIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .210
NOTE_ATTACHMENTS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .210
NOTES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
OPTIMISER_ ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
OTE_WORKSHEET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .211
PAL_COUNTER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
PARAMETER_LANGUAGES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
PAY_ADJUST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
PAY_RECOVERY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
PAYMENT_BATCH_AUTH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
PAYMENT_BATCH_EMP_PREVIEW . . . . . . . . . . . . . . . . . . . . . . . . . . 215
PAYMENT_BATCH_EMPLOYEES . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
PAYMENT_BATCH_PLANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
PAYMENT_BATCH_PLANS_PREVIEW . . . . . . . . . . . . . . . . . . . . . . . . 217
PAYMENT_BATCH_TRANSACTIONS. . . . . . . . . . . . . . . . . . . . . . . . . 218
PAYMENT_BATCHES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
PAYROLL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
PLAN_CALC_INPUTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
PLAN_ELEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
PLAN_GROUP_ORDER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
PLAN_GROUPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
PLAN_ORDER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
PLAN_RELATIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
PLAN_RESULTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
PLAN_RESULTS_CLOSED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
PLAN_RESULTS_MANAGED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
PLAN_TABLE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
PLAN_TRANSACTION_MATCH. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
PLAN_TRANSACTION_UPDATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
PLANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
PLANS_CLOSED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
PLANS_MANAGED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
PLATFORM_TO_DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
PLN_GUESTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
POSTING_PLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
POSTING_PLAN_CLOSED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
POSTING_PLAN_MANAGED. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
POSTING_TRAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
POSTING_TRAN_CLOSED. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
POSTING_TRAN_MANAGED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
PRICE_LIST_ITEMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
PRICE_LIST_PREVIOUS_ITEMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
PRICE_LISTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
PROCESS_SEMAPHORES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
PROCESS_SEMAPHORES_ACTIVITY. . . . . . . . . . . . . . . . . . . . . . . . . 246
PRODUCT_SPIF . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246
PRODUCT_SPIF_PRODUCTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
PRODUCTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
viii
Contents
PROF_FLD_TIDY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PROFILE_DEFINITION. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QDE_ITEMS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QDE_PROFILES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QRY_ACTIVITIES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QRY_ATTACHMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QRY_HEADER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
QRY_UPLOADS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RANK_PLANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RECEIVE_EMAIL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
REGIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
REJECTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RELEASED_STATEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RENAMABLE_RESULTFIELD_ALIAS . . . . . . . . . . . . . . . . . . . . . . . . .
REPORT_HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SALES_STRUCTURE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SCHEMA_DOC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SCREEN_FIELDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SEL_DESCRIPTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SEL_FILTERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SEND_EMAIL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SEND_EMAIL_ATTACHMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SERVER_CONSOLE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SERVER_CONSOLE_LOG. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SERVER_CONSOLE_PARAMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SERVER_STATUS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SKETCH_AUDIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SKETCH_INSTANCES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SKETCH_STEPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SKETCHES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SQL_HISTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SS_MAPPING_D . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STANDARD_CONNECTOR_CONFIG . . . . . . . . . . . . . . . . . . . . . . . .
STAT_COMMENT_HEADER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STAT_COMMENT_VALUES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STAT_PLANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STAT_SECT_FIELDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STAT_ZOOM_FIELDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STATEMENT_BATCH_AUTH. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STATEMENT_BATCH_EMPLOYEES . . . . . . . . . . . . . . . . . . . . . . . . . .
STATEMENT_BATCHES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STATEMENT_GRAPH_ITEMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STATEMENT_GRAPHS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STATEMENT_ITEMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STATEMENT_PLAN_SPECIFIC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STATEMENT_TITLES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STATEMENT_TYPES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STATEMENTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ix
248
249
249
250
250
251
252
254
254
255
255
256
257
257
257
258
259
259
260
261
262
263
263
265
266
267
267
268
269
269
270
271
272
273
273
273
273
273
273
274
275
277
277
277
277
277
277
277
Contents
SYSTEM_PARAMETERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TAB_STATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TABLES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TARGET_WORKSHEET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TARGETS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TASK_MANAGER. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TAX_BANDS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TAX_GROUPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TAX_RATES. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TEMP_EMP_LIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TEMPLATE_OTC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TEMPLATE_TARGETS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRAN_BULK_UPDATE_FILTER_FLDS . . . . . . . . . . . . . . . . . . . . . . . .
TRAN_BULK_UPDATE_PREVIEW_CFG. . . . . . . . . . . . . . . . . . . . . . .
TRAN_BULK_UPDATE_SET_TO_FLDS . . . . . . . . . . . . . . . . . . . . . . .
TRAN_BULK_UPDATES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRAN_EXT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRAN_EXT_MATCH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRAN_RECALC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRAN_SUM_ITEMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRAN_SUMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRANSACTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRANSACTIONS_CLOSED_LEG . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRANSACTIONS_MANAGED_LEG . . . . . . . . . . . . . . . . . . . . . . . . . .
TRANSACTIONS_PENDING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRANSACTIONS_S_CLOSED . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRANSACTIONS_S_MANAGED. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
TRN_S_MANAGED_ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UP_DRAW_AMOUNTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UPD_EMPLOYEE_DRAW_AMOUNTS. . . . . . . . . . . . . . . . . . . . . . . .
UPDATE_EMPLOYEE_DRAW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UPDATE_PLAN_CALC_INPUTS. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UPDATE_PLAN_ITEMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UPDATE_PLANS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UPDATE_TARGETS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
USER_ACCESS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
USER_OPTIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
USER_SETTINGS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
USER_SETTINGS_COL_ORDER. . . . . . . . . . . . . . . . . . . . . . . . . . . . .
USER_WIDGETS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
USER_WIDGETS_SETTINGS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
USERS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VAT_RATES_HEADER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
VAT_RATES_ITEMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WIZ_ .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WIZARD_NAMES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Appendix 4
277
279
279
280
281
281
282
282
283
284
284
285
285
286
287
287
288
289
289
289
290
291
293
294
294
294
294
294
294
294
295
296
297
297
298
298
299
299
301
301
303
303
306
306
306
306
Service Platform Schema Reference. . . . . . . . . . . . . . . . . . . . . . .307
x
Contents
P_NOTIFICATION_LOG. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
P_SLAVE_APP_USER_TO_DELETE. . . . . . . . . . . . . . . . . . . . . . . . . . . 308
P_SCHEDULED_NOTIFICATION . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
PLATFORM_FIELD_DEFINITION . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
PLATFORM_FIELD_VALUE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .310
PLATFORM_SERVICE_CONFIG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .311
PLATFORM_SLAVE_APPLICATION . . . . . . . . . . . . . . . . . . . . . . . . . . .311
PLATFORM_TO_DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
PLATFORM_USER . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
PLATFORM_USER_PASSWORD_HIST. . . . . . . . . . . . . . . . . . . . . . . . 313
PLATFORM_USER_SLAVE_APPS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .315
xi
Contents
xii
1
Introduction to the NICE ICM Schemas
NICE Incentive Compensation Management (NICE ICM) uses several relational
database schemas to support its features.This chapter provides an introduction
to each of the database schemas. The remaining chapters in the document
provide detailed reference information about the schemas provided by NICE.
The document assumes its readers are familiar with using NICE ICM features.
For detailed information on the features, see the online help or the User Guide.
Overview
NICE ICM uses several database schemas to support its features as outlined
below. The schemas can be created in separate tablespaces, or can share
tablespaces. They are normally all created under the same database server. For
details about creating the schemas and the relational database software
supported by NICE ICM, see the Installation Guide.
NICE ICM uses several schemas as follows:
•
Portal schema - this schema holds the user account details needed for
controlling access to portal pages and data provided by the NICE PM core
component of the system. It also holds the cbeans used to configure the
portal application.
•
ICM schema - this schema holds the business data required to calculate
compensation. It includes details of the payee, contact, and user accounts,
plans, calculators, and ICM reports.
•
Service platform schema - this schema contains configuration information
for the service platform, and includes a master copy of all the information
about the user accounts defined to NICE ICM.
•
SCA schema - this schema holds analytics metadata information needed by
the SCA (sales compensation analytics) component of NICE ICM. This
schema is described in the appendix about the Intelligence Server statistics
data dictionary in MicroStrategy’s System Administration Guide, Vol 1. The
SCA schema is not described any further in this document.
13
1
Portal schema overview
Portal schema overview
This section provides an overview of the portal database schema. Although the
portal schema contains a large number of tables, only a few of these are used by
NICE ICM. Most of the tables are only used by the NICE PM product.
For detailed reference information about the tables used by NICE ICM, see
Chapter 2, “Portal Schema Reference.”
The section contains the following topics:
•
•
•
•
“Policy profile and profile criteria tables” on page 14
“Workflow and Inquiry Management features” on page 14
“Portal configuration” on page 15
“NICE PM core login and execution” on page 15
Policy profile and profile criteria tables
The following tables are used to hold information used when defining policy
profiles and profile criteria in order to control access to the portal pages.
•
M_GROUPTYPE - Defines types of portal user groups.
•
M_MGROUP - Contains the available access groups.
•
M_MUSER - Contains an entry for each ICM payee, ICM user, and ICM
contact account.Used during login.
•
M_PERSON - Contains an entry for each ICM payee and ICM user. Used when
defining profile criteria.
•
M_TITLETYPE - Contains a list of the available Titles for use in defining policy
profiles.
•
M_USERGROUP - Contains a list of the available User Groups for use in
defining policy profiles.
Workflow and Inquiry Management features
The following tables are used to support the workflow and inquiry management
features of NICE ICM.
•
•
M_ICM ,,,- Tables beginning M_ICM support the Inquiry Management feature.
M_INQUIRY ...- Tables beginning M_INQUIRY support the Inquiry Management
feature.
•
M_WORKFLOW ...- Tables beginning M_WORKFLOW support the workflow
feature.
14
1
ICM database schema overview
Portal configuration
The following tables support the internal configuration of the NICE PM core
server.
•
M_CBEAN - Contains the cbean configurations currently being used by the
NICE PM core server.
•
M_METABEANREFERENCE - Contains references to any defined metabean.
NICE PM core login and execution
•
M_EXECUTION - Stores information about the execution of the NICE PM
core.
•
M_EXECUTIONMESSAGE - Contains messages produced by the NICE PM core.
•
M_EXECUTIONMESSAGETYPE - Stores a list of the types of NICE PM core
execution messages.
•
M_EXECUTIONSTATUSSUMMARY - Defines the possible NICE PM core
execution statuses.
•
M_LOGINRECORD - Tracks user logins to the NICE PM core server.
•
M_LOGINTICKET - Tracks user login and session status.
This section provides an overview of how the ICM database schema supports
the main ICM features of NICE ICM. The section contains the following topics:
•
•
•
•
•
•
“Data flow in NICE ICM” on page 16
“Related tables” on page 27
“Data encryption” on page 55
“Schema updates” on page 55
“Oracle settings for the ICM database” on page 56
“Getting additional assistance” on page 59
15
1
Data flow in NICE ICM
NICE ICM processes data in several stages as illustrated below:
Create
statement
data
Load data
Calculate
data
Authorize
payments
Create
payment file
Release
payments
Each stage in this data flow, including the database tables involved, is described
in more detail in the following sections.
NOTE: The Create statement data stage can occur anytime after the Calculate data
stage. For example, it can occur at the position shown if you want payees
to review their payments before you actually release the payments. It can
also occur at the same time as or after the payment release.
Load data
Create
statement
data
Load data
Calculate
data
Authorize
payments
Release
payments
Create
payment file
Data can be loaded into the ICM database in a number of ways, but the easiest
way is through data ports. Each data port loads a specific type of data, such as
payees or events, from a specific source, such as a delimited text file or an Oracle
database. A data port runs as a job of type 40 (Datasource Load) at the ICM
server. You can schedule a data port to run at a specific time, for example every
day between 1am and 3am. Alternatively you can queue the data port manually.
For more information on the datasource load job, see “Job type 40 - Datasource
load” in the System Administration Guide.
When the data loads, it can actually update several tables in the database. NICE
ICM ensures that any relational links between the data in those tables are
maintained. For example, when a data port loads payee data, the data is actually
written to the EMPLOYEE, EMPLOYEE_HIST, EMPLOYEE_YEAR, and EMPLOYEE_CALC
tables as required. For more information, see “Payees” on page 27.
16
1
A data port also reads information about financial years, periods, and days from
the FIN_ tables in the ICM database to ensure historical data is stored correctly.
Data ports
Source data
ICM database
Reads from ICM
database tables such
as:
FIN_YEARS
FIN_PERIODS
FIN_DAYS
Writes to destination
tables such as:
EMPLOYEES
EMPLOYEE_HIST
EMPLOYEE_YEAR
EMPLOYEE_CALC
BASE_DATA
TRANSACTIONS
Events
BASE_DATA
Reference
data
Stage 1: Load Data
Payees
SALES_STRUCTURES
For more information on data ports, see the Data Ports Guide.
Calculate data
Create
statement
data
Load data
Calculate
data
Authorize
payments
Release
payments
Create
payment file
After a data port has run to load events or a user edits an event through ICM
Admin, a Set Calculations server job is automatically run to mark all data that
needs to be calculated. This job calls further jobs (job types 71, 72, and 73) to
perform this processing.
For other types of data loaded by data ports or modified through ICM Admin,
NICE ICM first creates a calculation dependency batch containing records for
the items that might need to be marked for recalculation. This batch is stored in
the CALC_DEP_BATCHES and CALC_DEP_BATCHES_ITEMS tables. NICE ICM then
calls a Calculation Dependency job (job type 78) instead of Set Calculations to
do the marking for the batch. This job uses the calculation dependency map
stored in the CALCULATION_DEPENDENTS table to ensure that any dependent
payees and plans in addition to the ones in the calculation dependency batch
are also marked.
If the job detects any loops in the calculation dependencies, it writes details of
these to the CALC_DEP_PLAN_LOOPS table. Loops indicate inconsistent plan
definitions and you must resolve any problems detected.
17
1
The Set Calculations and Calculation Dependency jobs sets the following flags:
Table
Flag
EMPLOYEE_CALC
NEEDS_PROCESSING
PLANS
PLN_NEEDS_PROCESSING
PLN_PROC_START_FPSQ
PLN_PROC_START_FYID
NICE ICM calls a Do Calculations job (job type 75) to start the actual
calculation whenever one of the following occurs:
•
A data port is run that is configured with the Follow with field set to Run
Automatic Calculation.
•
A data port of type Calculation is run.
•
A user chooses the Processing > Calculate menu option within ICM Admin.
•
A payee, plan, or calculator is updated and the auto-calculation setting is
enabled.
The Do Calculations job scans the EMPLOYEE_CALC and PLANS tables to see if
the flags have been set. For each payee affected by the flags, the job creates a
Calculate job (job type 80), unless there is already a job queued for this payee.
The Do Calculate job uses the dependency map stored in the
CALCULATION_DEPENDENTS table to schedule the Calculate jobs in an order that
minimizes any repeated calculation of the same payee. The job writes a list of
the jobs and their dependencies to the JOB_DEPENDENTS table.
The Calculate job calculates each payee and plan per period for each financial
year and writes the results of the calculation to the following tables and views:
•
ASSIGNED_TRANS. NICE ICM adds details of the events record to the results
of the calculation and writes a record to the tables behind this view. Each
record is per plan, payee, and event. If a record already exists for the plan,
payee, and event, NICE ICM updates that record with the new results. NICE
ICM deletes records that are not relevant to the current plan and payee filter.
For example, if a user removes a payee from a plan, NICE ICM deletes the
related ASSIGNED_TRANS records.
•
EMPLOYEE_RESULTS. For each payee, NICE ICM sums up all plan results per
period and financial year, including payee level adjustments and draws, and
writes a single record for the payee to this table.
•
RESULTS. For each payee, NICE ICM sums up all events and other plan level
components such as SPIFs and adjustments for the same plan per period
and financial year. NICE ICM then writes a single record for the payee to this
table.
•
LEDGER_TRAN. For each event, NICE ICM adds an Earning credit record to
this view. The LEDGER_TRAN view is used by NICE ICM to define what is due
to be paid (the earnings) at a transaction level.
18
1
•
LEDGER_PLAN. For each payee and plan combination, NICE ICM rolls up the
earnings for all events into a single record per day and add it to this view.
•
LEDGER_EMP. At the end of each period, NICE ICM rolls up the earnings and
payee level adjustments and draws for each payee and writes a single
summary record for the payee to this table.
Each Calculate job writes some statistical information about its processing to
the JOB_MEASUREMENT table. After all the Calculate jobs have completed, the
Do Calculations job calls a Process Calculation Batch Summary job (job type
81) to write summary information about the batch to the CALCULATION_BATCH
and CALCULATION_BATCH_JOBS tables. Users can view this information from
ICM Admin.
For details on these job types, see the System Administration Guide.
Stage 2: Calculate
Reads from ICM database
tables:
EMPLOYEES
EMPLOYEE_HIST
EMPLOYEE_YEAR
Writes to destination tables
such as:
ASSIGNED_TRANS view
RESULTS
EMPLOYEE_RESULTS
TRANSACTIONS
LEDGER_TRAN view
LEDGER_PLAN view
LEDGER_EMP
PLANS
EMPLOYEE_CALC
CALCULATION_BATCH
CALCULATION_BATCH_JOBS
JOB_MEASUREMENT
SEL_FILTERS
CALCULATION_DEPENDENTS
19
1
Create statement data
Create
statement
data
Load data
Calculate
data
Authorize
payments
Release
payments
Create
payment file
Statements provide payees with information on commissions earned. Payees
view statement data by running a suitable statement report. The information
can include both paid and unpaid commissions that are earned per event, plan,
and payee.
NICE ICM can operate in one of two modes for producing statements:
•
Real-time statements. When a payee views a real-time statement, the
statement is built using the latest calculation information at the time the
statement is viewed.
•
Released statements. When a payee views a released statement, the
statement is built using the calculation information that was current when
the last statement batch was released and approved.
Only one type of statement operation is permitted in a NICE ICM system, and
the type required is selected using the Should employees have access to the
real-time statements system parameter.
Real-time statements
Real-time statements are built on-demand using the latest calculation
information at the time a payee views a statement. This type of statement is
available if the Should statements be built in real-time system parameter is set to
Yes.
An advantage of real-time statements is that they reflect the very latest event and
calculation information held in NICE ICM. A disadvantage is that they display
results that have not undergone any official approval.
Stage 2: Create real-time
statements
Reads from ICM
database tables:
ASSIGNED_TRANS
RESULTS
EMPLOYEE_RESULTS
Output to report
DRN_REPORTS
20
1
When a user selects to view a real-time statement, NICE ICM first reads details
of the associated report from the DRN_REPORTS table and then the actual
financial information for the statement direct from the other tables shown
above.
Released statements
Released statements are built using the results of the last released statement
batch. This type of statement is available if the Should statements be built in
real-time system parameter is set to No.
Although released statements do not reflect the most recent results of
calculations, they do have several advantages, including:
•
The statements only show information that has been reviewed and
approved as part of the statement release process.
•
The statements use information that has been built as a result of the batch
statement release job. They have a lower real-time performance overhead in
NICE ICM.
Stage 2: Create released
statements
Reads from ICM
database tables:
ASSIGNED_TRANS
RESULTS
EMPLOYEE_RESULTS
DRN_REPORTS
When statement batch released,
writes to:
STATEMENT_BATCH
STATEMENT_BATCH_EMPLOYEES
When statement batch has been
authorized, writes to:
TRANSACTION_CLOSED (view)
TRANSACTION_MANAGED
RESULTS_CLOSED
RESULTS_MANAGED
EMPLOYEE_RESULTS_CLOSED
EMPLOYEE_RESULTS_MANAGED
Before a payee can view a released statement, a statement batch must be released
and authorized:
1. A statement batch must be released for a specific period and financial year
and for a specific group of payees. When the statement batch is released,
NICE ICM writes a single record to the STATEMENT_BATCH table with a
unique statement batch ID in the SB_ID column. NICE ICM also writes a
21
1
record for each payee in the statement batch to the
STATEMENT_BATCH_EMPLOYEES table. An authorization process is also
started for the statement batch.
2. Once a statement batch has been released, it must be approved by one or
more defined users. After the statement batch has been checked and
approved by the required users, NICE ICM physically releases the
statements. After the statement batch has been authorized, NICE ICM copies
the following information to the tables used to display the released
statements:
•
The associated information from ASSIGNED_TRANS is copied to
TRANSACTION_CLOSED. The summed events per plan from RESULTS to
RESULTS_CLOSED and RESULTS_MANAGED.
•
The summed events per payee from EMPLOYEE_RESULTS to
EMPLOYEE_RESULTS_CLOSED and EMPLOYEE_RESULTS_MANAGED.
•
Information is also copied to TRANSACTION_MANAGED,
RESULTS_MANAGED, and EMPLOYEE_RESULTS_MANAGED if the Enable
subordinate statements be released to managers system parameter is
selected, and the payee is a manager according to the hierarchy specified
in the The sales structure to use for the management hierarchy system
parameter. The names of these parameters in the SYSTEM_PARAMETERS
table are RELEASE_MANAGERS and SS_MULTI_MANAGEMENT.
The _MANAGED tables enable a manager to have advance visibility of
subordinate statements even when the statements have not been
released to the subordinates directly.
The _CLOSED tables ensure a snapshot of the released statements continue to
be available even if the data changes in the original tables.
Release payments
Create
statement
data
Load data
Calculate
data
Authorize
payments
Release
payments
Create
payment file
The start of the payment process begins with the release of a payment batch. The
payment batch then goes through an authorization process. If the batch is
approved, the output from the payment process is a file that can be used by a
payroll or HR system to actually make the payments.
A payment batch defines the payees, plans, financial year, and period for which
payments are to be made. When a payment batch is released, NICE ICM:
1. Writes a single record to the PAYMENT_BATCHES table containing summary
details of the payment batch.
22
1
2. Uses information from LEDGER_TRAN, LEDGER_PLAN, and LEDGER_EMP to
write detailed payment records to the following tables:
Table
Description
PAYMENT_BATCH_TRANSACTIONS
Contains the amount to pay for each payee in the
payment batch per event.
PAYMENT_BATCH_PLANS
Contains the amount to pay for each payee in the
payment batch against each plan.
PAYMENT_BATCH_EMPLOYEES
Contains the total amount to pay for each payee in the
payment batch summed across all plans and events.
3. Writes a debit record of type PENDING to the LEDGER_PLAN view for earnings
and plan level draws and adjustments for each transaction in the payment
batch to offset each entry in the batch.
4. Writes a debit record of type PENDING to the LEDGER_EMP table for payee
level draws and adjustments for each transaction in the payment batch.
Stage 3: Release payments
Reads from ICM
database tables:
LEDGER_TRAN
23
Writes to:
LEDGER_PLAN view
LEDGER_EMP
PAYMENT_BATCHES
PAYMENT_BATCH_PLANS
1
Authorize payments
Load data
Authorize
payments
Create
statements
Calculate
data
Release
payments
Create
payment file
Once a payment batch has been released, it must be checked and authorized.
The actions taken by NICE ICM depend on whether the batch is accepted or
declined.
Payment batch accepted
If the batch is accepted, NICE ICM then:
•
Moves the PENDING record to the LEDGER_ARCHIVE view.
•
Adds a debit record of type PAYMENT to the LEDGER_PLAN view and
LEDGER_EMP table for each transaction in the payment batch to offset each
earning entry in the batch so that the earning entry cannot be used in future
batches.
•
Updates the record in PAYMENT_BATCHES to show the batch is approved.
•
Uses information from PAYMENT_BATCH_TRANSACTIONS,
PAYMENT_BATCH_PLANS and PAYMENT_BATCH_EMPLOYEES to write records to
the following tables:
Table
Description
ACTUAL_TRAN_PAYMENTS
Contains the amount to pay for each payee in the payment
batch per event.
ACTUAL_PAYMENTS
Contains the amount to pay for each payee in the payment
batch against each plan.
ACTUAL_PAYMENTS
Contains the total amount to pay for each payee in the
payment batch summed across all plans and events.
24
1
Stage 4: Authorize payments
(when batch is accepted)
Writes to:
Reads from:
PAYMENT_BATCHES
PAYMENT_BATCH_PLANS
PAYMENT_BATCH_EMPLOYEE
LEDGER_ARCHIVE view
LEDGER_PLAN view
LEDGER_EMP
ACTUAL_PAYMENTS
ACTUAL_PAYMENTS
Payment batch declined
If the batch is declined, NICE ICM then:
•
Moves the PENDING record to the LEDGER_ARCHIVE view. This enables the
original earning record to be used in another payment batch.
•
Marks the PAYMENT_BATCHES tables to show the batch has been declined.
Stage 4: Authorize payments
(when batch is declined)
Writes to:
Reads from:
PAYMENT_BATCHES
PAYMENT_BATCH_PLANS
25
LEDGER_ARCHIVE view
PAYMENT_BATCHES
1
Create payment file
Load data
Create
statements
Calculate
data
Authorize
payments
Create
payment file
Release
payments
After a payment batch has been authorized and run successfully, NICE ICM can
automatically create payment files containing details of the payee payments.
These files can then be sent to the appropriate customer application to generate
the payments.
You define how NICE ICM is to create the payment file by creating one or more
payment systems by choosing Administration > Payment System.
A payment system defines:
•
The format of the payment file - text, Microsoft Word, or Microsoft Excel file,
or a report. For a report, the report must be created with Source of Data set to
Payee Payments.
•
Where the payment file is to be sent - one or more email addresses or an FTP
server.
NICE ICM creates a single payment file for each payment system. The file
contains the payments for all payees associated with that system.
Stage 5: Create payment file
Writes to:
Reads from:
PAYMENT_BATCH_PLANS
Payment files
PAYROLL
26
1
Related tables
This section describes the ICM database tables that NICE ICM uses to support
each of its main features, and includes the main links between tables that are
maintained by NICE ICM.
NOTE: NICE ICM maintains the links between tables rather than using
relationships in the actual database.
User management
This section describes the ICM database tables that support the three user types:
payees, users, and contacts.
Payees
NICE ICM uses the following tables to store information about payees:
EMPLOYEE_YEAR
EMPLOYEES
EMPLOYEE_HIST
MRU
TAB_STATE
DELETED_EMPLOYEES
NOT_AGAIN
BULLETINS
BULLETIN_ACKNOWLEDGED
BULLETIN_SETTINGS
QDE_PROFILES
QDE_ITEMS
SALES_STRUCTURE
PLATFORM_TO_DELETE
FAVOURITE_REPORT
•
EMPLOYEES - holds static information about a payee, such as the payee
name, email address, and telephone.
•
BULLETINS, BULLETIN_ACKNOWLEDGED, BULLETIN_SETTINGS - holds
information about bulletins.
•
DELETED_EMPLOYEES - holds summary details of every payee that has been
deleted from NICE ICM.
27
1
•
PLATFORM_TO_DELETE - temporarily holds a list of each user, contact, or
payee that has been deleted from the ICM database until the corresponding
M_Person and M_MUser entries are deleted from the portal application’s
database.
•
EMPLOYEE_HIST - holds information about a payee that might change over
time, such as job role. This information is termed historical. Historical fields
are defined via the Payees and Shared Profile system configuration tabs. To
access the tabs, choose Administration > System Configuration > Payees or
Shared Profile.
•
EMPLOYEE_YEAR - holds information about a payee related to a particular
financial year, such as currency and whether the payee needs to be
recalculated.
•
FAVOURITE_REPORT - holds a list of reports that have been marked as
favorites in the NICE application.
•
QDE_PROFILES, QDE_ITEMS - holds definitions for payee quick data entry
(QDE) screens.
•
SALES_STRUCTURE, SS_MAPPING_D - holds definitions for sales structures.
Users
The following ICM database tables store information about users:
USER_ACCESS
USER_WIDGETS
USER_WIDGETS_SETTINGS
MRU
TAB_STATE
PLATFORM_TO_DELETE
USERS
SEL_FILTERS
•
USERS - holds information about user accounts and user templates such as
the user name, user account, user group and email address.
•
MRU - holds information about the most recently used commands for each
user. NICE ICM uses this information to populate the Most Recently Used
area in the ICM Admin user interface.
28
1
•
SEL_FILTERS - holds data access restrictions for Editor and Reviewer users.
This table holds a number of different types of restrictions. The data access
restrictions have a FILTER_SOURCE value of 14.
A friendly version of this table that is suitable for reporting is
SEL_DESCRIPTIONS.
•
TAB_STATE - holds information about the user interface tabs that are
currently open by each user. NICE ICM uses this information to reopen the
tabs from the previous session when a user next accesses ICM Admin.
•
M_Person and M_User entries are deleted from the portal application’s
database.
•
USER_ACCESS - holds the user interface options that can be accessed by each
user. Every user has entries in this table, but the information in the table is
only used for Editor and Reviewer users that have had been defined as
having restricted user access options.
•
USER_OPTIONS - holds a list of all possible user options for which access can
be granted. It does not define the options available to a specific user.
•
USER_WIDGETS, USER_WIDGETS_SETTINGS - holds information about the
widgets that are to be displayed on the user landing page of each user and
payee.
Contacts
Contacts are used to provide alternative login account details for payees. The
following ICM database tables store information about a contact:
EMPLOYEES
PLATFORM_TO_DELETE
CONTACTS
•
CONTACTS - holds information about contact such as the contact account
name and email address.
•
M_Person and M_User entries are deleted from the portal application’s
database.
29
1
Authorization
The following ICM database tables store authorization rules, the status of an
authorization request, and the proposed change until it is authorized and
written to the database.
AUTH_RULES
AUTH_REQUESTS
USER_ACCESS
AUTH_BUFFER
AUTH_BUFFER_DELETE
AUTH_BUFFER_NOTES
AUTH_BUFFER_NOTE_
ATTACHMENTS
AUTH_REQUEST_USERS
AUTH_WORKSJHEET
AUTH_WORKSHEET_
REMOVED
BUFFER_AUTH
AUTH_RULES_DELETED
•
AUTH_RULES- Each record in this table defines an authorization rule.
•
AUTH_REQUESTS - Contains a single record for each change that requires
authorization.
•
AUTH_BUFFER - Contains a record for each field of every changed data item
involved in an authorization process.
•
AUTH_BUFFER_DELETE - Contains a record for the data item if it is to be
deleted.
•
AUTH_BUFFER_NOTES - Contains a record for each note attached to the data
item being edited.
•
AUTH_BUFFER_NOTE_ATTACHMENTS - Contains a record for each note
attachment for the data item being edited.
•
AUTH_REQUEST_USERS - Contains a record for each user action that has
taken place during every authorization process.
•
AUTH_RULES_DELETED - Contains an summary entry for each authorization
rule that has been deleted for use in reporting.
•
AUTH_WORKSHEET - contains the top level settings by user of the
authorization worksheet filter.
•
AUTH_WORKSHEET_REMOVED - contains the specific request IDs that are
excluded by the user from the worksheet.
•
BUFFER_AUTH - Contains transient data used to link users and authorization
requests during the authorization process.
30
1
•
USER_ACCESS - Holds multiple records for each user that define the access
options for that user.
Data ports
The following ICM database tables store information about data ports:
STANDARD_CONNECTOR_CONFIG
DATA_SOURCE_SETTINGS
CONVERSION_LIST_HEADER
CONVERSION_LIST_ITEMS
DATA_SOURCES
BULK_DATA_FAILURE_UPDATES
BULK_DATA_FAILURE_UPDATE_FLDS
IMPORT_MAPPING
FLAT_FILES
•
DATA_SOURCES - holds the detailed definition of each data port.
•
DATA_SOURCE_SETTINGS - holds additional settings for data sources that are
files.
•
BULK_DATA_FAILURE_UPDATES, BULK_DATA_FAILURE_UPDATE_FLDS - holds
information about bulk data updates for interactive data ports.
•
CONVERSION_LIST_HEADER, CONVERSION_LIST_ITEMS - holds definitions of
converters used in data ports.
•
FLAT_FILES - holds the data being loaded from a text file by a data port until
the data has been loaded.
•
IMPORT_MAPPING - holds the field mapping information for each data port.
•
STANDARD_CONNECTOR_CONFIG - holds the definition of each connector.
31
1
Reference data
The following tables store reference data:
TAX_GROUPS
TAX_BANDS
TAX_RATES
PRICE_LISTS
PRICE_LIST_ITEMS
PRICE_LIST_PREVIOUS_ITEMS
PRODUCT_SPIF
PRODUCT_SPIF_
PRODUCTS
PRODUCTS
CUSTOMERS
BASE_DATA
•
BASE_DATA - contains the majority of the reference data information. Each
type of reference data is identified as a logical table by the DS_SYSFUNCT field.
•
CUSTOMERS - contains customer reference data.
•
PRICE_LISTS, PRICE_LIST_ITEMS, PRICE_LIST_PREVIOUS_ITEMS - hold
information about price lists.
•
PRODUCT_SPIF, PRODUCT_SPIF_PRODUCTS - hold information about SPIFs.
•
PRODUCTS - contains product reference information.
•
TAX_GROUPS, TAX_BANDS, TAX_RATES - hold information about the tax rates
to use in calculations.
32
1
Financial calendar
Financial years, quarters, and periods enable event data to be divided up so that
reports and payments can be made at intervals.
The following ICM database tables store information about the financial
calendar:
FIN_PERIODS
FIN_DAYS
FIN_YEARS
NON_WORKING_DAYS
•
FIN_DAYS - Holds a definition of each day within each financial year.
•
FIN_PERIODS - Holds definitions of each period within each financial year.
•
FIN_YEARS - Holds definitions of each financial year.
•
NON_WORKING_DAYS - Holds definitions of each day that is not a working
day and so should not be included in date duration calculations.
33
1
Payee financial data
The following tables store payee financial data
EMPLOYEE_YEAR
BASE_SALARIES
EMPLOYEE_DRAW
EMPLOYEE_DRAW_AMOUNTS
EMPLOYEES
EMP_CURRENCIES
EMPLOYEE_RESULTS
PAYROLL
INCENTIVES
•
BASE_SALARIES - holds the basic salary settings for payees.
•
EMP_CURRENCIES - holds information about the payment currency of payees.
•
EMPLOYEE_DRAW - holds information about draws against payees and plans.
•
EMPLOYEE_DRAW_AMOUNTS - holds detailed information about a specific
draw amount.
•
EMPLOYEE_RESULTS - holds payee level calculation results.
•
EMPLOYEE_YEAR - holds financial year related data associated with a payee.
•
INCENTIVES - holds information about payee incentives. PAYROLL - Holds
definitions of payment systems and associated payment file formats.
34
1
Payee queries
The payee query feature used in earlier releases has been replaced by the Inquiry
Management feature of NICE ICM. If you have upgraded from version 3.2 of
NICE ICM and were previously using the payee query feature, the ICM database
contains the tables described below. These tables contain historical information
about the payee queries and enable you to run reports on past queries. No new
data is written to these tables by NICE ICM.
QRY_UPLOADS
QRY_ACTIVITIES
QRY_ATTACHMENTS
QRY_HEADER
•
QRY_HEADER - holds entries for each payee query.
•
QRY_ACTIVITIES - holds detailed activity information associated with a payee
query.
•
QRY_ATTACHMENTS - holds reference to the files attached to a query, if any.
•
QRY_UPLOADS - holds information about each file uploaded to a payee
query, if any.
Payee selection filters
A number of objects in NICE ICM can be filtered to apply to particular payees,
including payment and statement batches, data ports, and plan templates. NICE
ICM uses the following ICM database tables to store information about these
payee selection filters:
EMPLOYEES
SEL_DESCRIPTIONS
SEL_FILTERS
35
1
•
SEL_FILTERS - stores all payee and user filters as used by various areas of the
application functionality. The type of functionality that a filter applies to is
defined by the FILTER_SOURCE field.
•
SEL_DESCRIPTIONS - holds a friendly version of the contents of the
SEL_FILTERS table that can be used for reporting and display purposes.
Events
The following ICM database tables store information about events:
REJECTIONS
ASSIGNED_TRANS
CLAWBACKS
CLAWBACK_BANDS
LEDGER_TRAN
LEDGER_PLAN
LEDGER_EMP
LEDGER_TRAN_ARCHIVE
LEDGER_ARCHIVE
LEDGER_EMP_ARCHIVE
TRANSACTIONS
TRAN_EXT
TRAN_EXT_MATCH
TRAN_SUMS
TRAN_SUM_ITEMS
•
TRAN_BULK_UPDATES
TRAN_BULK_UPDATE_FILTER_FLDS
TRAN_BULK_UPDATE_PREVIEW_CFG
TRAN_BULK_UPDATE_SET_TO_FLDS
FLAT_FILES
TRANSACTIONS, TRANSACTIONS_S_CLOSED, TRANSACTIONS_S_MANAGED -
contains all events.
•
ACTUAL_TRAN_PAYMENTS - holds all released payments against adjustments.
•
ASSIGNED_TRANS - view contains the results of calculations per plan, payee,
and event. The view joins several underlying internal tables to provide this
information. For a list of these tables, see “ASSIGNED_TRANS” on page 82.
•
•
CLAWBACKS - holds definitions of all clawback templates.
CLAWBACK_BANDS - holds the band records associated with clawback
templates.
•
FLAT_FILES - used by flat file data ports to load incoming data for custom
formatting.
36
1
•
LEDGER_EMP - holds all payee level ledger entries.
•
LEDGER_PLAN - view holds the plan level ledger for the current year. Entries
older than a year are held in the LEDGER_TRAN_HISTORY table. The view
joins several underlying internal tables to provide this information. For a list
of these tables, see “LEDGER_PLAN” on page 198.
•
LEDGER_TRAN - view contains the NICE ICM ledger, holding event level
postings relating to earnings and payments for the current year.Entries older
than a year are held in the LEDGER_TRAN_HISTORY table. The view joins
several underlying internal tables to provide this information. For a list of
these tables, see “LEDGER_TRAN” on page 202.
•
LEDGER_EMP_ARCHIVE, LEDGER_ARCHIVE, LEDGER_TRAN_ARCHIVE - contain
archived entries from the corresponding ledger.
•
REJECTIONS - holds details of all payment rejections.
•
TRAN_BULK_UPDATES, TRAN_BULK_UPDATE_FILTER_FLDS,
TRAN_BULK_UPDATE_PREVIEW_CFG, TRAN_BULK_UPDATE_SET_TO_FLDS -
holds definitions of all event bulk updates.
•
TRAN_EXT, TRAN_EXT_MATCH - contains definitions of events.
•
TRAN_SUMS, TRAN_SUM_ITEMS - contains definitions of value definitions.
Plans
This section describes the ICM database tables used to store information about
plans. The tables are grouped into the following topics:
•
•
•
•
“Plan contents” on page 38
“Plan management” on page 39
“Targets” on page 40
“Plan results” on page 41
37
1
Plan contents
The following ICM database tables store information about the contents of
plans and plan templates:
ELEMENTS
GROUPS
GROUP_ORDER
FILTER_CRITERIA
FILTER_VALUES
ELEMENT_GROUPS
ELEMENT_ITEMS
FLOATING_OTC
PLANS
PLANS_CLOSED
PLANS_MANAGED
STATEMENT_BATCHES
PLN_GUESTS
TEMPLATE_OTC
RELATIONS
EMPLOYEES
CALC_INPUTS
•
PLANS - holds detailed definitions of each plan template, and each plan
instance for each payee.
•
ELEMENT_GROUPS, ELEMENT_ITEMS - Holds definitions of each calculator
series.
•
FILTER_CRITERIA, FILTER_VALUES - holds definitions of filter data used against
events in plan queries and other areas.
•
FLOATING_OTC - holds the assignment of OTC values within a floating plan.
•
CALC_INPUTS - holds the values entered against ASK functions in calculators
at the plan level.
•
•
ELEMENTS - holds the additional elements assigned to plans.
GROUP_ORDER - holds the sequence in which plan groups are displayed by
ICM Admin.
•
GROUPS - holds definitions of calculators, SPIFs, and clawbacks for each
plan group.
38
1
•
RELATIONS - defines which payees have a plan instance for a each plan
template for a financial year.
•
PLN_GUESTS - defines the plan guests for each plan template.
•
TEMPLATE_OTC - holds the assignment of OTC values within a plan template.
Plan management
The following ICM database tables temporarily store information when plans
are being managed:
COPY_PLANS
PLANS
UPDATE_PLANS
UP_DRAW_AMOUNTS
UPD_EMPLOYEE_DRAW_
AMOUNTS
UPDATE_EMPLOYEE_DRAW
UPDATE_CALC_INPUT
UPDATE_ITEMS
UPDATE_OTC
UPDATE_TARGETS
COMPILED_QUERY
•
COMPILED_QUERY - Holds compiled queries, which are coded
representations of plan filters defined against all active plans. The table is
populated every time a new plan query is entered into the system that does
not already exist.
•
UPDATE_PLANS, UP_DRAW_AMOUNTS, UPD_EMPLOYEE_DRAW_AMOUNTS,
UPDATE_EMPLOYEE_DRAW, UPDATE_CALC_INPUT, UPDATE_ITEMS,
UPDATE_OTC, UPDATE_TARGETS - contains information used by the NICE
ICM modeling feature.
39
1
Targets
The following ICM database tables store information about targets:
TRAN_SUMS
TRAN_SUM_ITEMS
VARIATION_HEADERS
VARIATION_VALUES
TARGETS
TEMPLATE_TARGETS
PLANS
TARGET_WORKSHEET
CORP_TARGET_VALUES
CORP_TARGETS
CORP_TARGET_CASCADES
CORP_TARGET_CASCADE_VALUES
CORP_TARGET_PLANS
PLANS
•
CORP_TARGETS - holds the basic definitions for corporate targets.
•
CORP_TARGET_CASCADES, CORP_TARGET_CASCADE_VALUES - contains
information about how a corporate target that has been assigned to a plan is
cascaded down to a lower level.
•
CORP_TARGET_PLANS - defines which plan templates use which corporate
targets.
•
CORP_TARGET_VALUES - contains the actual values stored against the
corporate target definitions set up in NICE ICM.
•
TARGET_WORKSHEET - holds the current year that each user is working on in
the target worksheet.
•
TARGETS - holds the targets set against each plan.
40
1
•
TEMPLATE_TARGETS - the assignment of target values within a plan template.
•
TRAN_SUMS, TRAN_SUM_ITEMS -holds details of value definitions.
•
VARIATION_HEADERS, VARIATION_VALUES - holds definitions of variations.
Plan results
The following ICM database tables store information about plan results:
Calculation job
RESULTS
Manager
MANUAL_RESULTS
•
MANUAL_RESULTS - Holds all manual plan results entered by managers.
•
RESULTS - Holds all calculation results summarized by model, payee, plan
and period.
Model definitions
The following ICM database tables store information about models:
FORECAST_TEMPLATES
FORECAST_ACHIEVEMENT
•
•
FORECAST_VALUES
FORECAST_ACHIEVEMENT - Holds the achievement values in a model.
FORECAST_TEMPLATES - Holds the values of the Model Details section of
each model.
•
FORECAST_VALUES - Holds a definition of each section in a model. A section
specifies a set of payees, plans and changes to be modelled.
41
1
Calculator definition
The following ICM database tables store information about calculators:
TEMPLATE_TARGETS
ELEMENT_GROUPS
ELEMENT_ITEMS
TARGET_WORKSHEET
CALCULATOR_TEST_VALUES
CALCULATORS
POSTING_PLAN
POSTING_TRAN
CALCULATOR_REFERENCES
CALCULATOR_CELLS
CALCULATOR_COLUMN_DETAILS
CALCULATOR_CELL_FORMAT
CALCULATOR_NAMED_STYLES
•
CALCULATORS - Holds definitions of all calculators including table
calculators.
•
CALCULATOR_CELL_FORMAT - Holds details of cell formatting that has been
explicitly set by users.
•
•
CALCULATOR_CELLS - Holds details of each cell within a calculator and its
associated formula or value.
CALCULATOR_COLUMN_DETAILS - Holds details of column widths that have
been explicitly set by users.
•
CALCULATOR_NAMED_STYLES - Defines a style that can be applied to
calculator cells.
•
CALCULATOR_REFERENCES - Holds references between calculators. An
example of a reference is a reference to a table calculator from an event
calculator.
•
CALCULATOR_SETTINGS - Holds the dimension settings associated with table
calculators.
42
1
•
CALCULATOR_TEST_VALUES - Stores the values last used by users to test
calculators.
•
ELEMENT_GROUPS, ELEMENT_ITEMS - Holds definitions of each calculator
series.
•
POSTING_PLAN, POSTING_TRAN - holds plan and event level postings
generated by calculators.
Calculation dependency
The following ICM database tables store information concerning calculation
dependency:
CALC_DEP_PLAN_LOOPS
CALC_DEP_BATCHES
CALC_DEP_BATCHES_ITEMS
EMPLOYEE_CALC
•
CALC_DEP_BATCHES, CALC_DEP_BATCHES_ITEMS - hold information about
which items might need recalculation in each calculation dependency
batch.
•
CALC_DEP_PLAN_LOOPS - holds information about loops in calculation
dependencies.
•
CALCULATION_DEPENDENTS - holds the calculation dependency map used by
NICE ICM to schedule calculation jobs in the order that keeps recalculations
to a minimum.
•
EMPLOYEE_CALC - holds a record for each payee that is marked for
recalculation.
43
1
Statement batches
The following ICM database tables store information about statement batches:
STATEMENT_BATCH_AUTH
PLANS_CLOSED
PLANS_MANAGED
RESULTS_CLOSED
RESULTS_MANAGED
STATEMENT_BATCHES
ASSIGNED_TRANS_CLOSED_LEG
ASSIGNED_TRANS_MANAGED_LEG
ASSIGNED_TRANS_CLOSED_DELTA
ASSIGNED_TRANS_MANAGED_DELTA
ASSIGNED_TRANS_CLOSED_ID
•
POSTINGS_CLOSED
POSTINGS_MANAGED
STATEMENT_BATCHES - Holds details of all statement batches, including
whether they have been approved or declined.
•
STATEMENT_BATCH_AUTH - Holds details of all authorizations for each
statement batch.
•
STATEMENT_BATCH_EMPLOYEES - Defines which payees are in each statement
batch.
44
1
The following tables are populated when a statement batch is authorized and
released. The _CLOSED tables, such as PLANS_CLOSED, contain the payee released
version of the corresponding master table data, such as PLANS. The _MANAGED
tables, such as PLANS_MANAGED, contain the manager released version of the
master table.
•
ASSIGNED_TRANS_CLOSED_LEG, ASSIGNED_TRANS_MANAGED_LEG,
ASSIGNED_TRANS_CLOSED_DELTA, ASSIGNED_TRANS_MANAGED_DELTA,
ASSIGNED_TRANS_CLOSED_ID, ASSIGNED_TRANS_MANAGED_ID - Hold the
results of calculations per plan, payee, and event.
•
EMPLOYEE_RESULTS_CLOSED, EMPLOYEE_RESULTS_MANAGED - Hold payee
level calculation results.
•
RESULTS_CLOSED, RESULTS_MANAGED - Hold all calculation results
summarized by model, payee, plan and period.
•
PLANS_CLOSED, PLANS_MANAGED - Hold detailed definitions of each plan
template, and each plan instance for each payee.
•
POSTINGS_CLOSED, POSTINGS_MANAGED - Hold postings generated by
calculators.
Payments
The following ICM database tables store information about payee payments:
REJECTIONS
ACTUAL_PAYMENTS
•
ACTUAL_PAYMENTS
ACTUAL_PAYMENTS - Holds all released payments against payments at the
payee level.
•
ACTUAL_PAYMENTS - Holds all released payments against plans.
•
ACTUAL_TRAN_PAYMENTS - Holds all released payments against adjustments.
•
- Holds all adjustments and adjustment templates.
•
REJECTIONS - Holds details of all payment rejections.
45
1
Payment batches
The following ICM database tables store information about payment batches:
REJECTIONS
PAYMENT_BATCH_EMP_PREVIEW
PAYMENT_BATCH_PLANS_PREVIEW
PAYMENT_BATCH_PLANS
PAYMENT_BATCHES
PAYMENT_BATCH_AUTH
BOOKMARKS
BOOKMARK_ENTRIES
•
PAYMENT_BATCH_EMP_PREVIEW, PAYMENT_BATCH_PLANS_PREVIEW - contain
values at payee and plan levels within a previewed payment batch. These are
temporary values used for preview only.
•
PAYMENT_BATCHES - Holds details of all payment batches, including whether
they have been approved or declined.
•
BOOKMARKS - Holds a definition of each bookmark.
•
BOOKMARK_ENTRIES - Holds the payee and plan combinations for each
bookmark.
•
PAYMENT_BATCH_AUTH - Holds details of all authorizations for each
payment batch.
•
PAYMENT_BATCH_EMPLOYEES - Holds the amounts to pay to each payee
within each payment batch.
•
PAYMENT_BATCH_PLANS - Holds the amount to pay to each payee for a plan
within each payment batch.
•
PAYMENT_BATCH_TRANSACTIONS - Holds the amount to pay each payee for
each event in a plan within each payment batches.
46
1
•
REJECTIONS - Holds details of all payment rejections.
Report definition
The following ICM database tables store information about report definitions:
DRN_REPORT_ALIAS
DRN_REPORT_ACCESS
DRN_REPORT_EMAIL
DRN_REPORTS
DRN_REPORT_SETTINGS
DRN_REPORT_SOURCE
USERS
EMPLOYEES
DRN_REPORT_PARAMETERS
DRN_FIELD_ALIAS
DRN_LOOKUP_ALIAS
DRN_CUSTOM_LISTS
DRN_CUSTOM_LIST_VALUES
•
DRN_REPORTS - Holds definitions of all reports.
•
DRN_CUSTOM_LIST_VALUES - contains the contents of lists.
•
DRN_CUSTOM_LISTS - contains custom lists.
•
DRN_FIELD_ALIAS - contains the fields available in reporting sources.
•
DRN_LOOKUP_ALIAS - makes friendly versions on reporting source field
values available to the user for the purposes of look up lists.
•
DRN_REPORT_ACCESS - Holds details of the access rights for users and payees
to reports.
•
DRN_REPORT_ALIAS - Holds friendly versions of the report definitions. for
use when reporting on reports.
•
DRN_REPORT_EMAIL - Holds report definitions that have been queued for
sending by email.
47
1
•
DRN_REPORT_PARAMETERS - Holds hard coded parameter values for reports.
•
DRN_REPORT_SETTINGS - Holds the graph style settings for reports with a
graphical output type.
•
DRN_SOURCES - Holds definitions of reporting sources.
•
DRN_VALUE_ALIAS - Holds friendly versions of ICM database field values to
be used in reporting.
Report execution
The following ICM database tables store report information during report
execution:
DRN_PIVOT_STATE
DRN_REPORT_USER_INPUT
DRN_REPORTS
DRN_REPORT_HISTORY
REPORT_HISTORY
•
DRN_REPORTS - Holds definitions of all reports.
•
DRN_PIVOT_STATE - Holds the current state of selected fields and filters on
pivot reports.
•
DRN_REPORT_HISTORY - Holds the output from previous runs of reports.
•
DRN_REPORT_USER_INPUT - Holds the last known input criteria by user/
payee and report.
•
REPORT_HISTORY - Holds a history of report executions by users and payees.
48
1
Jobs
The following ICM database tables store information about ICM server jobs:
JOB_DEPENDENTS
JOB_MEASUREMENT
TASK_MANAGER
CALCULATION_BATCH
JOBS
DELETE_EMPLOYEES
JOB_TYPES
SERVER_CONSOLE_LOG
SERVER_CONSOLE
•
CALCULATION_BATCH, CALCULATION_BATCH_JOBS - hold historical summary
statistics about each calculation job.
•
JOBS - Holds the queue of jobs that are awaiting processing by the NICE
ICM server.
•
DELETE_EMPLOYEES - Holds information about jobs submitted to delete
payees.
•
JOB_DEPENDENTS - Holds records showing dependencies between server
jobs.
•
JOB_MEASUREMENTS - Holds statistical information about each Calculate
job (job type 80) that has been run.
•
JOB_TYPES - Holds a description of each known job type.
•
SERVER_CONSOLE - contains a snapshot of the current server activity.
•
SERVER_CONSOLE_LOG - contains historical information about server
activity.
•
TASK_MANAGER - Holds information about the currently running server
tasks.
49
1
Process Manager
The following ICM database tables store information about the process
manager
SKETCH_STEPS
SKETCH_AUDIT
SKETCH_INSTANCES
SKETCHES
•
CONTENT_ITEMS - holds items that have been uploaded to the ICM database
An example of a content item is a graphic file for use by the Process Manager
feature.
•
SKETCH_AUDIT - holds audit information about each step that has been
executed in process manager instances.
•
SKETCH_INSTANCES - holds summary information about each process
manager instance that has been started.
•
SKETCH_STEPS - holds information about each step that has been executed
in process manager instances.
•
SKETCHES - holds detailed definitions of each process manager template,
instance, and launcher.
50
1
Auditing and logging
The following ICM database tables store audit and log information:
AUDIT_TRAIL
DRN_REPORT_HISTORY
ACTIVITY_AUDIT
Auditing
REPORT_HISTORY
Report logging
ACCESS_LOG
DATABASE_ERRORS
SQL_HISTORY
LOG_FILES
MIGRATION_LOG
Security logging
SERVER_CONSOLE
SERVER_CONSOLE_LOG
Miscellaneous
Server and job logging
TASK_MANAGER
•
ACCESS_LOG - holds information about user and payee login attempts to
NICE ICM.
•
AUDIT_TRAIL - holds a history of all changes made through ICM Admin user
interface or by the ICM server to data held in the ICM database.
•
ACTIVITY_AUDIT - holds information about NICE ICM activities within NICE
ICM.
•
DATABASE_ERRORS - holds definitions of any customized ICM database error
messages.
•
DRN_REPORT_HISTORY - holds the results of previous runs of reports. The
output from a report is held in the REPORT_HIST_DATA column in XML
format.
51
1
•
LOG_FILES - contains a definition of each type of application log files that is
available.
•
MIGRATION_LOG - holds historical information about the usage of the NICE
ICM migration feature.
•
REPORT_HISTORY - contains a history of the running of reports by users and
payees.
•
•
SERVER_CONSOLE - contains a snapshot of the current ICM server activity.
SERVER_CONSOLE_LOG - contains historical information about ICM server
activity.
•
SQL_HISTORY - contains historical information about SQL statement run via
the ICM Admin SQL worksheet feature.
•
TASK_MANAGER - contains information about the currently running ICM
server tasks.
Localization
The following tables store information about regional settings:
CURRENCIES
EMP_CURRENCIES
EXCHANGE_RATES
EMPLOYEES
REGIONS
USERS
•
CURRENCIES - Holds definitions of the currencies such as the currency code
and name.
•
EMP_CURRENCIES - Holds definitions of the currencies to use for payment for
each payee.
•
EXCHANGE_RATES - Holds the actual and plan exchange rate for each
currency.
•
REGIONS - Holds definitions of each region supported in NICE ICM. Region
information includes language code, date format and decimal point
character.
52
1
Customization
The following tables to store customization information:
API_PARAMETERS
SYSTEM_PARAMETERS
PARAMETER_LANGUAGES
•
API_PARAMETERS - Holds details of the contents of the latest API file.
•
SYSTEM_PARAMETERS - Holds the current settings of the system
configuration parameters that control the application behavior and
appearance.
•
PARAMETER_LANGUAGES - Contains the singular and plural text strings in
various languages that NICE ICM is to use in order to provide multilingual
support for system parameters.
Miscellaneous system tables
The following tables store miscellaneous information:
•
BATCH_RECALCS - Holds the job ID of the current batch recalculation job if
this feature has been enabled.
•
BUFFER - Holds the state of data being edited, until it is committed to the
main data tables.
•
BUFFER_DELETE - Holds identifiers for records that need to be deleted when
a user change is committed.
•
BUFFER_NOTE_ATTACHMENTS - Holds note attachment files uploaded against
a record whilst it is being edited by users.
•
BUFFER_NOTES - Holds notes associated with a data record whilst it is being
edited by a user.
•
IMPORT_FILES - Holds information about the files in each defined manage
files directory.
•
MODEL... - Contain information used by the modeling feature.
•
NOTES, NOTE_ATTACHMENTS - Holds private and public notes and note
attachment files entered by users. Notes can be entered against records in a
number of tables, including DRN_REPORTS for report definitions,
AUTH_REQUESTS for authorization requests, and PAYMENT_BATCHES for
payment batches.
53
1
•
PAL_COUNTER - Holds the next available ID against any NICE ICM tables
requiring an internally generated ID.
•
RECEIVE_EMAIL - Holds a record of all incoming emails.
•
RECEIVE_EMAIL_ATTACHMENTS - Holds all the file attachments for incoming
emails.
•
SEND_EMAIL - Holds output emails that need to be sent by NICE ICM.
•
SEND_EMAIL_ATTACHMENTS - Holds all the file attachments for outgoing
emails.
•
SERVER_CONSOLE_PARAMS - used internally by NICE ICM to store
parameters needed to look up the dictionary in order to build server console
messages.
•
SERVER_STATUS - contains parameters regularly updated by the server that
are used to trigger frequency based housekeeping activities.
•
TABLES - Holds the names of all core and temporary work tables in NICE
ICM.
•
USER_SETTINGS, USER_SETTINGS_COL_ORDER - Hold settings for each user for
the ordering of the columns on the Payees, Events, and custom screens in
ICM Admin.
•
WIZ_ - Tables beginning WIZ hold unique IDs for the system parameter
groups.
•
WIZARD_NAMES - Holds the names of the system parameter groups.
54
1
Data encryption
NICE ICM can optionally encrypt the following ICM database columns:
ICM database table
name
Encrypted column
EMPLOYEES
EMP_BANK_SORT_CODE
EMP_BANK_ACCOUNT_NO
EMP_BANK_ACCOUNT_NAME
EMP_PAYROLL_ID
ACTUAL_PAYMENTS
BANK_SORT_CODE
BANK_ACCOUNT_CO
BANK_ACCOUNT_NAME
TRANSACTIONS
TRN_PROFILE_9
TRN_PROFILE_10
DATA_SOURCES
DS_USER
DS_PASSWORD
NOTE: You do not need to index the encrypted columns. The information in
the columns is sensitive, and so few users access it on a regular basis.
There is usually no performance gain in applying an index to the
columns.
For more about encryption, see the System Administration Guide.
Schema updates
New and patch releases of NICE ICM often require changes to the underlying
ICM database schema. The required schema changes are built-in to the new
NICE ICM software and are automatically applied when the server is first started
after upgrading the software.
The schema is versioned against each major NICE ICM release number. You can
view the schema version numbers by choosing Administration > Schema Info. For
example:
55
1
Oracle settings for the ICM database
This section describes recommended settings for the ICM database. The section
describes the following settings:
•
•
“ICM database file system partitions” on page 56
“Table spaces” on page 57
For more information on creating the database, see the Installation Guide.
ICM database file system partitions
Name
Typical Size
Notes
SYSTEM
2GB
SYSTEM tablespace should not grow
much more than 500MB.
SYSMAN
2GB
SYSMAN tablespace should not grow
much more than 500MB.
UNDO
32GB
Allows for a single UNDO data file to
grow to the max file size that Oracle
supports. The size is related to the
number of calculation threads, the
complexity of the calculators, and the
amount of data processed by each.
TEMP
32GB
Allows for a single TEMP data file to
grow to the max file size that Oracle
supports.The size is related to the
number of calculation threads, the
complexity of the calculators, and the
amount of data processed by each.
REDO1
2GB
REDO2
2GB
Redo logs are sized according to the
database.
REDO3
2GB
REDO4
2GB
DATA
100GB
Totally dependent on the application.
INDEX
100GB
Totally dependent on the application.
ICM database indexes often match the
size of the tables.
BACKUP
50GB
Destination for logical backups.
ARCHIVE
100GB
Destination for archive logs if archive
logging is used. This is dependent on
the amount of data being processed by
the system and the time between
backups.
56
1
Table spaces
Name
Size
Notes
ICM_DATA_SMALL
256K
Contains smaller ICM database tables.
Mostly static data.
ICM_DATA_MED
1M
Contains tables that refer to payees,
plans, targets, and sales structures.
ICM_DATA_BIGn
4M
One or more tablespaces, depending
on table partitions, which contain the
larger ICM database tables.
ICM_INDEX_SMALL
64K
Indexes corresponding to the smaller
ICM database tables.
ICM_INDEX_MED
128K
Indexes corresponding to tables that
refer to payees, plans, targets, and sales
structures.
ICM_INDEX_BIGn
1M
One or more tablespaces, depending
on table partitions, which contain the
indexes for the larger tables.
ICM_DATA_AUDIT
1M
The audit tables.
ICM_INDEX_AUDIT
156K
Indexes for the audit tables.
ICM_DATA_WRK
192K
The working data tablespace as
defined in the configuration file
configuration.properties. For details
of this file, see the Installation Guide.
ICM_INDEX_WRK
64K
The working index tablespace as
defined in the configuration file
configuration.properties. For details
of this file, see the Installation Guide.
Optimizing the ICM database
NICE ICM can regularly gather database statistics to enable Oracle to optimize
the database performance.
You can also gather statistics on selected tables at any time. This option is useful
when you think some tables have recently changed significantly and you want
Oracle to optimize them immediately.
In both the above situations, NICE ICM runs a server job (Analyze Database, job
type 105) in order to gather the statistics. For details on this job type, see the
System Administration Guide.

To schedule the regular database optimization:
1. In ICM Admin, choose Administration > System Configuration > Tuning.
2. In Analyzing database, select how often the statistics are to be gathered
(daily, weekly, monthly, or never).
57
1
Service platform schema overview
3. Click Save.

To gather statistics for selected tables:
1. In ICM Admin, choose Administration > System Configuration > Tuning.
2. At Gather table stats, click Configure.
The Gather table stats dialog then appears listing the tables that have
changed since the last time statistics were gathered. For each table, the list
shows:
•
•
•
The table name.
When the table was last analyzed.
An indication (Stale %) of how much the table has changed since it was
last analyzed (the larger the value, the more the table has changed).
3. At Sample Size %, you are recommended to use the default value of Auto.
Otherwise select the sample size to use when gathering statistics.
4. At Select, select the check box next to the tables for which you want to gather
statistics.
5. Click OK.
NICE ICM then submits a server job to gather statistics and optimize the
selected tables.
Service platform schema overview
This section provides an overview of the platform application database schema.
For detailed reference information about the tables, see Chapter , “.”
The schema contains the following tables:
•
PLATFORM_FIELD_DEFINITION - This table defines the custom fields that are
associated with user objects. The actual values of the fields are held in the
PLATFORM_FIELD_VALUE table.
•
PLATFORM_SERVICE_CONFIG - This table contains the configuration
information for the platform services.
•
PLATFORM_FIELD_VALUE - This table contains the values for the user object
custom fields.
•
PLATFORM_SLAVE_APPLICATION - This table defines each slave application
that is to use the platform.
•
PLATFORM_USER - This table contains a record for each user object known to
the platform. The table defines a standard set of attributes for the user
objects. Additional attributes can also be associated with users and this
additional information is held in the PLATFORM_FIELD_VALUE table.
58
1
•
SCA database schema overview
PLATFORM_USER_PASSWORD_HIST - This table a history of the password
changes for each user.
•
PLATFORM_USER_SLAVE_APPS - This table defines which slave applications
are used by each user. A user has a record in this table for each slave
application they are associated with and so there can be more than one
record for each user.
SCA database schema overview
For details of the SCA database schema, see the appendix about the Intelligence
Server statistics data dictionary in MicroStrategy’s System Administration Guide,
Vol 1.
Getting additional assistance
There are several ways to get additional assistance with the database schemas,
including user forums, technical support, business consulting, and more. For
details, visit www.mercedsystems.com.
59
1
Getting additional assistance
60
2
Portal Schema Reference
This chapter provides the following information about the main tables in the
standard portal schema that are used by NICE ICM:
•
Information about each column, its data type, any associated label in the
user interface, and a brief description of its use. The data type shown in this
chapter is the one used to define the table in the portal application. For
details, see “Data types” on page 61.
•
The primary key fields.
•
Any foreign keys that identify relationships with other entities.
There are a large number of other tables in the portal database that are used
internally by NICE ICM and these are not described in this chapter. All the
names of the tables in the portal database schema begin with the characters M_.
Data types
The tables in this chapter indicate the data type for each column. The list shows
the data type as defined by the portal application. The following table shows the
common data types and the corresponding Oracle data type.
Data type
Oracle data type
Description
BigString
CLOB
A large text string.
Boolean
Number(1)
A true or false value.
Date
Date
A date field.
Integer
Number(10) or
Number(19) for IDs
An integer number.
Long
Number(19)
A long number.
Pointer
Number(19)
A pointer to an ID in another table.
Service
VarChar2(256)
Text containing a component name.
String
VarChar2(256) or
CLOB
A text string.
Timestamp
Date
A date including the hour and minute.
61
2
JBPM_ ...
JBPM_ ...
Tables beginning JBPM_ are internal system tables used to support the workflow
feature of NICE ICM.
M_CBEAN
Contains the cbean configurations currently being used by the portal
application.
Table columns
The table contains the following columns:
Column
Data Type
Description
CBEANNAME
String
Short name that identifies this cbean.
CBEANTYPE
String
Template cbean from which this cbean inherits
properties.
CBEANCONTEXT
String
Primary context for this cbean. Equal to the first
value in the cbean’s “context” property.
The globally unique ID (GUID) is a concatenation
of cbeanname and cbeancontext.
M_VALUE
String
The cbean’s complete configuration.
CREATEDDATE
Date
Timestamp indicating row creation.
ID
Integer
Unique row identifier.
MODIFIEDDATE
Date
Timestamp indicating last modification.
ISINACTIVE
Integer
Integer indicating whether row is active:
0 - active
1 - inactive
SICOMPONENTNAME
String
Indicates the component name if the row is loaded
as a static instance (seed data). Usually null.
VERSIONID
Integer
Integer indicating row version. NICE ICM
increments the value each time it modifies the row.
Primary key
id
Foreign keys
None.
62
2
M_EXECUTION
M_EXECUTION
Stores information about the execution of the portal application. M_EXECUTION
can be joined with the M_MAINSERVICEEXECUTION table to provide more specific
information about an execution.
Table columns
Column
Data Type
Description
EXECUTABLE
Service
Name of an executable component.
PARENTEXECUTION
Pointer
Executable run that launched this executable.
Runs not launched by an executable, contain
a NULL value.
STARTTIME
Timestamp
Time that this executable run started.
ENDTIME
Timestamp
Time that this executable run finished. Runs
not completed contain a NULL value.
STATUSSUMMARY
Pointer
Status of this executable run.
CREATEDDATE
Date
ID
Integer
Unique row identifier (a run of an
executable).
MODIFIEDDATE
Date
ISINACTIVE
Integer
0 - active
1 - inactive
SICOMPONENTNAME
String
Indicates component name if row loaded as a
static instance (seed data).
VERSIONID
Integer
Integer indicating row version. Incremented
each time system modifies row.
Primary key
ID
Foreign keys
PARENTEXECUTION = M_EXECUTION.ID
STATUSSUMMARY = M_EXECUTIONSTATUSSUMMARY.ID
63
2
M_EXECUTIONMESSAGE
M_EXECUTIONMESSAGE
Stores messages produced by audited portal job executions.
Table columns
Column
Data Type
Description
EXECUTION
Pointer
Associated execution run.
MESSAGETYPE
Pointer
Type of message.
M_TIMESTAMP
Timestamp
Time message was written.
ORDINALITY
Long
Number that indicates the relative order of the
message, compared to other messages generated
during the same execution.
BODY
BigString
Text containing message.
CREATEDDATE
Date
ID
Integer
MODIFIEDDATE
Date
ISINACTIVE
Integer
0 - active
1 - inactive
SICOMPONENTNAME
String
VERSIONID
Integer
Integer indicating row version. Incremented each
time system modifies row.
Primary key
ID
Foreign keys
EXECUTION = M_EXECUTION.ID
MESSAGETYPE = M_EXECUTIONMESSAGETYPE.ID
64
2
M_EXECUTIONMESSAGETYPE
M_EXECUTIONMESSAGETYPE
Defines types of portal execution messages.
Table columns
Column
Data Type
Description
DISPLAYNAME
String
Name indicating message type. There are three
default types:
Error
Warning
Info
CREATEDDATE
Date
ID
Integer
MODIFIEDDATE
Date
ISINACTIVE
Integer
0 - active
1 - inactive
SICOMPONENTNAME
String
Indicates component name if row loaded as a static
instance (seed data).
VERSIONID
Integer
Primary key
ID
Foreign keys
None.
65
2
M_EXECUTIONSTATUSSUMMARY
M_EXECUTIONSTATUSSUMMARY
Defines possible portal execution statuses.
Table columns
Column
Data Type
Description
DISPLAYNAME
String
Name summarizing status of an execution.
There are five default statuses:
Initializing
Running
Failed
Cancelled
Completed
CREATEDDATE
Date
ID
Integer
MODIFIEDDATE
Date
ISINACTIVE
Integer
0 - active
1 - inactive
SICOMPONENTNAME
String
VERSIONID
Integer
Primary key
ID
Foreign keys
None.
M_ICM...
Tables beginning with M_ICM are used internally to support the Inquiry
Management feature of NICE ICM.
M_INQUIRY...
Tables beginning with M_INQUIRY are used internally to support the Inquiry
Management feature of NICE ICM.
66
2
M_GROUPTYPE
M_GROUPTYPE
Defines types of portal user groups.
Table columns
Column
Data Type
Description
M_NAME
String
Name of this group type.
HASPEOPLE
Boolean
Indicates whether this is a group of people.
SUBGROUPOF
Pointer
Parent group type in the group hierarchy.
CREATEDDATE
Date
ID
Integer
MODIFIEDDATE
Date
ISINACTIVE
Integer
0 - active
1 - inactive
SICOMPONENTNAME
String
VERSIONID
Integer
Primary key
ID
Foreign key
SUBGROUPOF = M_GROUPTYPE.ID
M_LOGINRECORD
Tracks login attempts to the portal application. Each user login creates a row in
this table.
Table columns
Column
Data Type
Description
MUSER
Pointer
User who logged in.
LOGINTIME
Timestamp
Time user logged in.
CREATEDDATE
Date
ID
Integer
MODIFIEDDATE
Date
67
2
M_LOGINTICKET
Column
Data Type
Description
ISINACTIVE
Integer
0 - active
1 - inactive
SICOMPONENTNAME
String
Indicates component name if row loaded as
a static instance (seed data).
VERSIONID
Integer
Primary key
ID
Foreign key
MUSER = M_MUSER.ID
M_LOGINTICKET
Tracks account login and session status.
Table columns
Column
Data Type
Description
M_USER
Pointer
User who logged in.
IMPERSONATOR
Pointer
User assuming identity of the current user.
SESSIONKEY
String
Key that identifies session.
LASTACCESSTIME
Timestamp
Time user last accessed session.
LOGINTIME
Timestamp
Time user logged in.
FAILOVERTICKET
Integer
Ticket used during failover from one application
server to another.
CREATEDDATE
Date
ID
Integer
MODIFIEDDATE
Date
ISINACTIVE
Integer
0 - active
1 - inactive
SICOMPONENTNAME
String
VERSIONID
Integer
68
2
M_METABEANREFERENCE
Primary key
ID
Foreign key
M_USER = M_MUSER.ID
M_METABEANREFERENCE
Stores references to any defined metabean. By referencing rows in this table,
another column can possibly reference one of multiple tables rather than always
referencing single tables. For example, if a column references a person, you can
create a foreign key to the M_PERSON table. However, if a column sometimes
references a person but sometimes references a group, you can create a reference
to this table, which can store references to rows in both M_PERSON and M_MGROUP.
Table columns
Column
Data Type
Description
REFERENCETYPE
String
Name of metabean type referenced, such as
Person or MGroup.
REFERENCEID
Long
ID of the referenced row, such as the ID in
M_PERSON or M_MGROUP.
CREATEDDATE
Date
ID
Integer
MODIFIEDDATE
Date
ISINACTIVE
Integer
0 - active
1 - inactive
SICOMPONENTNAME
String
VERSIONID
Integer
Primary key
ID
Foreign key
REFERENCEID = M_PERSON.ID
REFERENCEID = M_MGROUP.ID
69
2
M_MGROUP
M_MGROUP
Defines the list of access groups that can be used when defining policy profiles
in NICE ICM. By default, there are two access groups defined in this table:
•
•
ADMIN
ICM Payee (Default group for all ICM payees)
Table columns
Column
Data Type
Description
M_NAME
String
Name that identifies group.
GROUPTYPE
Pointer
Type of this group.
PARENTGROUP
Pointer
Identifier of this group’s parent group.
ACTIVESTATUS
Pointer
Attribute associated with this group.
CREATEDDATE
Date
ID
Integer
MODIFIEDDATE
Date
ISINACTIVE
Integer
0 - active
1 - inactive
SICOMPONENTNAME
String
VERSIONID
Integer
Primary key
ID
Foreign key
GROUPTYPE = M_GROUPTYPE.ID
PARENTGROUP = M_MGROUP.ID
70
2
M_MUSER
M_MUSER
Contains an entry for each ICM payee, user, and contact. Used to control access
to portal pages.
NOTE: Several of the fields in this table are no longer used because in NICE
ICM user management is performed by the service platform, which
maintains account information in its own database. For more on the
platform service database tables, see Chapter , “.”
Table columns
Column
Data Type
Description
ENTITYID
String
The entity ID of the account.
USERNAME
String
User name for log in.
PASSWORD
String
Login password in hashed form.
ENCRYPTEDPASSWORD
String
Temporary storage for user’s password in
encrypted form.
PERSON
Pointer
Person associated with this login name.
PRIMARYUSER
Boolean
Not user.
M_LOCALE
String
Sets the default language for this user
ALTQUESTION
String
ID of the security question set for this account.
Set to customQuestion if the user has set a
custom question.
CUSTOMQUESTION
String
The custom security question set by the user, if
any.
ALTANSWER
String
The encrypted answer to the security question.
MUSTCHANGEPASSWD
Boolean
Flag indicating whether the user must change
the password the next time the account is used
to log in to NICE ICM.
LASTPASSWSCHGDATE
Date
The date when the password was last changed.
LOGINATTEMPTS
Integer
The number of unsuccessful login attempts
since the last successful login (primarily
tracked by the service platform).
EMAILADDRESS
String
User’s email address.
MOBILEACCESS
Boolean
Flag indicating whether the user can access the
mobile SCA feature.
UPGRADEFROMICM
Boolean
Flag indicating whether this user was created as
a result of upgrading from ICM.
UNIQUEDISPLAY
String
The unique display name for the user.
NEEDSSYNC
Boolean
Whether the user needs to be synchronized to
the service platform.
NEEDSDELONPLTFRM
Boolean
Whether the user is marked for deletion by the
service platform.
71
2
M_PERSON
Column
Data Type
Description
UPGRADEFROMMPS
Boolean
Whether the user is upgrading from earlier
version of MPS.
CREATEDDATE
Date
ID
Integer
MODIFIEDDATE
Date
ISINACTIVE
Integer
0 - active
1 - inactive
SICOMPONENTNAME
String
VERSIONID
Integer
Primary key
ID
Foreign key
PERSON = M_PERSON.ID
M_PERSON
Contains entries for each NICE ICM user and payee account. The columns are
used when defining profile criteria to control access to portal pages and
commands.
Table columns
Column
Data Type
Description
ENTITYID
String
Entity ID.
FIRSTNAME
String
First name.
MIDDLENAME
String
Middle name.
LASTNAME
String
Last name.
STARTDATE
Date
First date of employment.
ENDDATE
Date
Last date of employment.
PARENTGROUP
Pointer
ID of the account’s parent group.
TITLE
Pointer
Account title type.
EMAILADDRESS
String
Account email address.
USERGROUP
Pointer
ID of the group (from M_MGROUP) to which
this account belongs.
72
2
M_TITLETYPE
Column
Data Type
Description
ACTIVESTATUS
Integer
Integer indicating whether the status is active:
0 - active
1 - inactive
CREATEDDATE
Date
ID
Integer
MODIFIEDDATE
Date
ISINACTIVE
Integer
0 - active
1 - inactive
2 - phantom
3 - inactive phantom
SICOMPONENTNAME
String
VERSIONID
Integer
Primary key
id
Foreign key
PARENTGROUP=M_MGROUP.ID
TITLE=M_TITLETYPE.ID
M_TITLETYPE
Contains a list of the available titles for use in defining policy profiles to control
access to portal pages and commands.
By default, the following titles are defined in this table:
•
•
•
•
•
•
Administrator
ICM User Only (Default title for ICM users only)
MercedAdministrator
Not Applicable
Region Sales Manager
Sales Person
73
2
M_USERGROUP
Table columns
Column
Data Type
Description
M_NAME
String
Name that identifies this title type (employee
role).
BOSSWITHIN
Pointer
Primary group type of employees with this title
type.
VIEWANYGROUPTYPE
Boolean
Defines whether a person can be associated with
any group type.
CATEGORY
Integer
ID of employee category, if any.
CREATEDDATE
Date
ID
Integer
MODIFIEDDATE
Date
ISINACTIVE
Integer
0 - active
1 - inactive
SICOMPONENTNAME
String
VERSIONID
Integer
Primary key
ID
Foreign key
BOSSWITHIN=M_GROUPTYPE.ID
M_USERGROUP
Contains a list of the available User Groups for use in defining policy profiles to
control access to portal pages and commands.
By default, the following user group is defined in this table:
•
Administrators
74
2
M_WORKFLOW...
Table columns
Column
Data Type
Description
M_NAME
String
Name that identifies this title type.
CREATEDDATE
Date
ID
Integer
MODIFIEDDATE
Date
ISINACTIVE
Integer
0 - active
1 - inactive
SICOMPONENTNAME
String
VERSIONID
Integer
Primary key
ID
Foreign key
None.
M_WORKFLOW...
Tables beginning with M_WORKFLOW are used internally to support the workflow
feature of NICE ICM.
75
2
M_WORKFLOW...
76
3
ICM Schema Reference
This chapter provides the following information about each table in the
standard ICM database schema:
•
user interface, and a brief description of its use.
•
•
NOTE: The ICM database schema for your implementation might also contain
additional custom tables required for your specific application.
ACCESS_LOG
This table stores a history of all attempts to log in to NICE ICM. The table is
populated by every time a user submits the login page with a specified user
name. Each record represents a single attempt to log in to the application.
Table columns
Column name
Data type
Description
AL_DATE
Timestamp(6)
The date and time of the access attempt.
AL_ACCOUNT
VarChar2(100)
The account name used in the access attempt.
AL_LOCKED
Number(1)
Flag to indicate whether the access attempt resulted in the account being
locked.
AL_SUCCESS
Number()
Flag to indicate whether the access attempt was successful.
AL_ENVNAME
VarChar2(255)
The environment name.
Primary key
None.
Foreign keys
AL_ACCOUNT=EMPLOYEES.EMP_ACCOUNT_NAME
77
3
ACTIVITY_AUDIT
ACTIVITY_AUDIT
This table contains a record of activities performed by users through the ICM
Admin application, as well as activity of the ICM server, including:
•
Initialise report start/finish/aborted
•
Data port start/finish/aborted
•
Calculation start/finish/aborted
The system purges the ACTIVITY_AUDIT table at the same time as the
AUDIT_TABLE.
Table columns
Column name
Data type
Description
AUDIT_TIMESTAMP
Timestamp(6)
The Date and Time the activity audit record got created and therefore the
date and time when the activity occurred.
USR_ID
Number(11,0)
The ID of the user who triggered the activity audit record. This is null, if it
was a server instantiated record.
EMP_ID
Number(11,0)
No longer used.
SERVER_ID
Number(11,0)
The ID of the server from the configuration settings.
SERVER_NAME
VarChar2(75)
The name of the server from the configuration settings.
THREAD_NAME
VarChar2(75)
The friendly name of the thread processing this request.
COMPONENT
VarChar2(75)
The system component requesting the audit record, such as DataPort or
Calculation.
DESCRIPTION
VarChar2(75)
A description of what is being audited.
Primary key
There is no primary key. An index is built from the AUDIT_TIMESTAMP field.
Foreign key
EMP_ID = EMPLOYEES.EMP_ID
USR_ID = USERS.USR_ID
78
3
ACTUAL_PAYMENTS
ACTUAL_PAYMENTS
This table stores all released payments against payments, at the payee level. The
table is populated when payments are released and each record represents an
overall payment made to a payee. This includes the total of all subordinate
levels: plans, events, adjustments and draws.
Table columns
Column name
Data type
Description
PB_ID
Number(11,0)
The ID of the payment batch.
EMP_ID
Number(11,0)
The ID of the payee.
FIN_YEAR_ID
Number(11,0)
The ID of the year of the payment.
FP_PERIOD_SEQ
Number(11,0)
The ID of the period of the payment.
BASIC_PAID
Number(15,2)
The amount of basic salary paid.
INCENTIVE_PAID
Number(15,2)
The variable amount paid. That is, the non-basic amount.
SENT
Date
The time the payment batch was created.
SENT_BY
Number(11,0)
No longer used.
CUR_ID
Number(11,0)
The ID of the payment currency.
LAST_MODIFIED
Date
The date and time that the record was last modified.
LAST_MODIFIED_BY
Number(11,0)
The ID of the user who last modified the record.
TAX_PAID
Number(15,2)
The amount of tax paid.
PAYMENT_REFERENCE
VarChar2(50)
Any payment reference used to update the payment batch.
PAYMENT_ID
Number(11,0)
A unique generated ID for this payment against the payee.
BANK_ACCOUNT_NO
VarChar2(75)
The payee bank account number as at the time of the payment.
BANK_SORT_CODE
VarChar2(50)
The payee bank sort code as at the time of the payment.
BANK_ACCOUNT_NAME
VarChar2(250)
The payee bank account name as at the time of the payment.
PAYMENT_REFERENCE_
DATE
Date
Any payment reference date used to update the payment batch.
PAY_PERIOD_START
Date
The first date of the payee payment period.
PAY_PERIOD_END
Date
The last date of the payee payment period.
PAYMENT_NUMBER
Number(11,0)
The incremental number of the payment against the payee.
REJ_ID
Number(11,0)
The ID of the rejection, if this is a rejection record.
TAX_BAND
Number(11,0)
The ID of the tax band associated with this payment.
Primary key
PB_ID + EMP_ID + TAX_BAND + REJ_ID
Foreign key
PB_ID = PAYMENT_BATCHES.PB_ID
79
3
ACTUAL_PLAN_PAYMENTS
CUR_ID = CURRENCIES.CUR_ID
REJ_ID = REJECTIONS.REJ_ID
FIN_YEAR_ID + FP_PERIOD_SEQ = FIN_PERIODS.[FIN_YEAR_ID +
FP_PERIOD_SEQ]
TAX_BAND = TAX_BANDS.TAX_ID
ACTUAL_PLAN_PAYMENTS
This table stores all released payments against plans. The table is populated
when payments are released and each record represents a payment made to a
payee against a specific plan. This includes the total of all subordinate levels:
events, plan and event adjustments, and draws.
Table columns
Column name
Data type
Description
PB_ID
Number(11,0)
EMP_ID
Number(11,0)
PLN_ID
Number(11,0)
The ID of the plan.
FIN_YEAR_ID
Number(11,0)
FP_PERIOD_SEQ
Number(11,0)
AMOUNT_PAID
Number(15,2)
The amount paid against the plan.
CUR_ID
Number(11,0)
TAX_PAID
Number(15,2)
TAX_RATE
Number(20,8)
The tax rate %. The value is a number between 0 and 1.
REJ_ID
Number(11,0)
The ID of the rejection, if this is a rejection record.
TAX_BAND
Number(11,0)
Primary key
PB_ID + EMP_ID + PLN_ID + TAX_BAND + REJ_ID
Foreign key
PLN_ID = PLANS.PLN_ID
FP_PERIOD_SEQ]
80
3
This table stores all released payments against adjustments. The table is
populated when payments are released and each record represents a payment
made to a payee against a specific plan and event. This table also includes any
differences between the total event level payments and the higher plan and
payee levels. In these cases the TRN_ID and/or PLN_ID column is set to -1.
Table columns
Column name
Data type
Description
PB_ID
Number(11,0)
EMP_ID
Number(11,0)
PLN_ID
Number(11,0)
The ID of the plan, or -1 if a payee level adjustment.
TRN_ID
Number(11,0)
The ID of the event, or -1 if not an event level adjustment.
FIN_YEAR_ID
Number(11,0)
FP_PERIOD_SEQ
Number(11,0)
AMOUNT_PAID
Number(15,2)
The amount actually paid against the adjustment.
CUR_ID
Number(11,0)
REJ_ID
Number(11,0)
The ID of the rejection, or 0 if this is not a rejection record.
PA_ID
Number(11,0)
The ID of the adjustment.
DRAW_ID
Number(11,0)
The ID of the draw related to this payment, if any.
TAX_BAND
Number(11,0)
TAX_PAID
Number(15,2)
TAX_RATE
Number(20,8)
ENTRY_TYPE
Number(11,0)
No longer used.
Primary key
PB_ID + EMP_ID + PLN_ID + TRN_ID + PA_ID + DRAW_ID + REJ_ID + TAX_BAND
+ ENTRY_TYPE
Foreign key
TRN_ID = TRANSACTIONS.TRN_ID
PA_ID = PAY_ADJUST.PA_ID
FP_PERIOD_SEQ]
81
3
API_PARAMETERS
API_PARAMETERS
This table contains a replica of the current API file as defined in the API.XML file.
It is re-populated every time the API file changes. It is then used by the system
whenever reference to the API file is required.
Table columns
Column
name
Data type
Description
TAG
VarChar2(50)
The first level node tag name.
SUBTAG
VarChar2(50)
The second level node tag name.
ATTRIBUTE
VarChar2(50)
The name of the node attribute, or blank if representing content.
CONTENTS
VarChar2(4000)
The value of the attribute or node content.
SEQ
Number(11,0)
A sequential identifier for the first level node.
SUBSEQ
Number(11,0)
A sequential identifier for the second or third level node within the first level.
Whether second or third level is indicated by the PARENT column.
PARENT
Number(11,0)
For second level nodes, this column is always 0.
For third level nodes, the column contains the sequential identifier for the parent
second level node.
Primary key
SEQ + SUBSEQ + ATTRIBUTE
Foreign key
None.
ASSIGNED_TRANS
From version 4.2 onwards, ASSIGNED_TRANS is a view rather than a table. The
view is made up of an SQL query on the following tables:
•
CURRENT_ASSIGNED_TRANSn (holds records less than a year old)
•
ASSIGNED_TRANS_HISTORY (holds records over a year old)
This view provides the relationship between plans and events and can be used
for reporting purposes. The underlying tables are populated and updated by the
calculation process. Each record in the view represents an event allocated to a
plan as a result of the plan query being applied. It also contains all output from
the plan event calculator and data associated with any SPIFs and clawbacks in
operation against the plan.
82
3
This table contains entries from the ASSIGNED_TRANS view that have changed
between statement batches. The entries appropriate for each statement batch are
identified using entries in the ASSIGNED_TRANS_CLOSED_ID table.
Table columns
This table is identical in column structure to the ASSIGNED_TRANS table, with the
addition of the following column:
Column name
Data type
Description
LAST_MODIFIED
Date
Date and time the record was last modified.
Primary key
TRN_ID + PLN_ID + FCST_ID + AT_PA_ID + AT_CALC_JOB_ID + FCST_SEQUENCE
Foreign key
AT_PA_ID = PAY_ADJUST.PA_ID
SPIF_ID = PRODUCT_SPIF.SPIF_ID
CB_ID = CLAWBACKS.CB_ID
ASSIGNED_TRANS_CLOSED_ID
This table contains records that identify the entries from the
ASSIGNED_TRANS_CLOSED_DELTA table that are included in each released
statement batch.
Table columns
The table has the following columns:
Column name
Data type
Description
SB_ID
Number(11,0)
The ID of the statement batch.
TRN_ID
Number(11,0)
The ID of the event.
PLN_ID
Number(11,0)
The ID of the plan.
AT_PA_ID
Number(11,0)
The ID of the event level adjustment, if any.
AT_CALC_JOB_ID
Number(11,0)
The ID of the server job that calculated this event and created the
corresponding record in ASSIGNED_TRANS.
Primary key
SB_ID + TRN_ID + PLN_ID + FCST_ID + AT_PA_ID
83
3
Foreign key
None.
This table contains data from the ASSIGNED_TRANS view that has been released by
statement batches to payees in older versions of NICE ICM. In NICE ICM, data
that is released is not stored in this table, but in ASSIGNED_TRANS_CLOSED_DELTA
and ASSIGNED_TRANS_CLOSED_ID. NICE ICM uses a view called
ASSIGNED_TRANS_CLOSED to access the released data across all these tables.
Table columns
addition of the following columns:
Column name
Data type
Description
SB_ID
Number(11,0)
The ID of the statement batch that released the data.
LAST_MODIFIED
Date
Primary key
SB_ID + FCST_ID + PLN_ID+ TRN_ID + AT_PA_ID + FCST_SEQUENCE
Foreign key
SB_ID = STATEMENT_BATCHES.SB_ID
ASSIGNED_TRANS_HISTORY
This table stores historical records from the CURRENT_ASSIGNED_TRANSn
tables. The table holds records that are older than a year.
Table columns
This table has the following columns:
Column name
Data type
Description
TRN_ID
Number(11,0)
PLN_ID
Number(11,0)
The ID of the plan.
COMM_VALUE
Number(32,15)
The commissionable value of the event against the plan, in base
currency.
COMM_PCNT
Number(20,8)
No longer used.
COMM_ORDER_VALUE
Number(32,15)
No longer used.
COMM_PARTNER_VALUE
Number(32,15)
No longer used.
84
3
ASSIGNED_TRANS_HISTORY
Column name
Data type
Description
COMMISSION_PAID
Number(32,15)
The amount of commission earned against the event in payment
currency.
COMM_QTY
Number(15,2)
The commissionable quantity of the event against the plan.
COMM_VALUE_TARGET
Number(32,15)
The commissionable value of the event against the plan, in target
currency.
COMMISSION_PAID_BASE
Number(32,15)
The amount of commission earned against the event in base
currency.
DATA_SET
Number(11,0)
The ID of the event data set. Normally only one data set is used
which has an ID of 1.
SPIF_ID
Number(11,0)
The ID of any unique SPIF associated with the event and plan.
AT_RRP
Number(32,15)
The price list RRP, if any.
AT_SELL_PRICE
Number(32,15)
The price list sell price, if any.
AT_BUY_PRICE
Number(32,15)
The price list buy price, if any.
AT_VAT_RATE
Number(20,8)
The tax rate, if any.
AT_CLAWED_BACK
Number(32,15)
The amount retrieved from a clawback, if any.
AT_ORIGINAL_VALUE
Number(32,15)
The original event value.
AT_ORIGINAL_VALUE_
TARGET
Number(32,15)
The original event value in plan target currency.
AT_ORIGINAL_QTY
Number(11,0)
The original quantity of the event against the plan.
AT_JOB_ID
Number(11,0)
The ID of the job that last loaded or updated this event in the
TRANSACTIONS table.
AT_EMP_ID
Number(11,0)
The ID of the payee that has been assigned to this event.
AT_PG_ID
Number(11,0)
The ID of the associated plan group.
CB_DATE
Date
The clawback date, if any.
CB_ID
Number(11,0)
The ID of the clawback record, if any.
CB_FROM_DATE
Date
The date clawed back from, if any.
CB_TRN_ID
Number(11,0)
The ID of the original clawback event, if any.
AT_ACTUAL_PAID
Number(32,15)
No longer used.
AT_BALANCE
Number(32,15)
No longer used.
AT_DATE
Date
The date from the event record that has been selected as the
effective date. Usually this date is TRN_ORDER_DATE but could
also be TRN_REFERENCE_DATE.
AT_PA_ID
Number(11,0)
RETURN_TRANSCALC_1 to
RETURN_TRANSCALC_15
Number(15,2)
A custom defined event results field, if used.
AT_CALC_JOB_ID
Number(11,0)
The ID of the server job that calculated this event and created
this record in ASSIGNED_TRANS.
RETURN_TRANSTEXT_1 to
RETURN_TRANSTEXT_5
VarChar2(50)
Returns the text of an event.
COMMISSION_RATE
Number(20,8)
No longer used.
Primary key
TRN_ID + PLN_ID + AT_PA_ID + AT_CALC_JOB_ID
85
3
Foreign key
This table contains manager entries from the ASSIGNED_TRANS view that have
changed between statement batches. The entries appropriate for each statement
batch are identified using entries in the ASSIGNED_TRANS_MANAGED_ID table.
Table columns
addition of the following column:
Column name
Data type
Description
LAST_MODIFIED
Date
Primary key
TRN_ID + PLN_ID + FCST_ID + AT_PA_ID + AT_CALC_JOB_ID
Foreign key
86
3
ASSIGNED_TRANS_MANAGED_ID
ASSIGNED_TRANS_MANAGED_ID
This table contains records that identify the manager entries from the
ASSIGNED_TRANS_MANAGED_DELTA table that are included in each released
statement batch.
Table columns
Column name
Data type
Description
SB_ID
Number(11,0)
TRN_ID
Number(11,0)
PLN_ID
Number(11,0)
The ID of the plan.
FCST_ID
Number(11,0)
The ID of the model.
AT_PA_ID
Number(11,0)
AT_CALC_JOB_ID
Number(11,0)
The ID of the server job that calculated this event and created this record in
ASSIGNED_TRANS.
Primary key
Foreign key
None.
ASSIGNED_TRANS_MANAGED_LEG
This table contains data from the ASSIGNED_TRANS view that has been released in
statement batches to managers in older versions of NICE ICM. In NICE ICM,
data that is released is not stored in this table, but in
ASSIGNED_TRANS_MANAGED_DELTA and ASSIGNED_TRANS_MANAGED_ID. NICE ICM
uses a view called ASSIGNED_TRANS_MANAGED to access the released data across all
these tables.
Table columns
addition of the columns shown below:
Column name
Data type
Description
SB_ID
Number(11,0)
LAST_MODIFIED
Date
87
3
AT_CLOSED_ACTUAL_PAID
Primary key
SB_ID + FCST_ID + PLN_ID+ TRN_ID + AT_PA_ID + FCST_SEQUENCE
Foreign key
AT_CLOSED_ACTUAL_PAID
This table is used as part of the statement batch process to record how much a
payee had been paid for an event at the time of statement release.
Table columns
Column name
Data type
Description
SB_ID
Number(11,0)
TRN_ID
Number(11,0)
PLN_ID
Number(11,0)
The ID of the plan.
FCST_ID
Number(11,0)
AT_PA_ID
Number(11,0)
AT_ACTUAL_PAID
Number(32,15)
The amount paid for the event.
Primary key
Foreign key
None.
AT_CLOSED_DELTA_ID
This is an internal table used by the system when populating
ASSIGNED_TRANS_CLOSED_ID.
88
3
AT_MANAGED_ACTUAL_PAID
AT_MANAGED_ACTUAL_PAID
This table is used as part of the statement batch process to record how much a
payee had been paid for an event at the time of statement release to managers.
Table columns
Column name
Data type
Description
SB_ID
Number(11,0)
TRN_ID
Number(11,0)
PLN_ID
Number(11,0)
The ID of the plan.
FCST_ID
Number(11,0)
AT_PA_ID
Number(11,0)
AT_ACTUAL_PAID
Number(32,15)
The amount paid for the event.
Primary key
Foreign key
None.
AT_MANAGED_DELTA_ID
This is an internal table used by the system when populating
ASSIGNED_TRANS_MANAGED_ID.
AUDIT_TRAIL
This table contains a record of all user driven changes made to the data in the
ICM database by the application. Each record represents a change to the value of
a field within a table.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user who initiated the change.
AUDIT_DATE
Date
The date and time of the change.
TABLE_NAME
VarChar2(2000)
The database name of the primary table being changed.
SUB_TABLE_NAME
VarChar2(50)
The database name of the secondary table being changed.
89
3
AUDIT_TRAIL
Column name
Data type
Description
CHANGE_TYPE
Number(11,0)
The type of change:
1- Add
2 - Update
3 - Delete
FIELD_NAME
VarChar2(50)
The database name of the field that was changed.
OLD_VALUE
VarChar2(2000)
The old value of the field being changed, if not an add.
NEW_VALUE
VarChar2(2000)
The new value of the field being changed, if not a delete.
TABLE_DESCRIPTION
VarChar2(100)
A descriptive name of the primary table being changed.
SUB_TABLE_DESCRIPTION
VarChar2(100)
A descriptive name of the secondary table being changed.
FIELD_DESCRIPTION
VarChar2(255)
A descriptive name of the field that was changed.
RECORD_DESCRIPTION
VarChar2(255)
A descriptive name of the record to which the field belongs.
NEEDS_AUTHORITY
VarChar2(50)
No longer used.
AUTHORISOR
Number(11,0)
The ID of the user who authorized the change, if any.
AUTHORISED
Date
The date and time that the change was authorized, if any.
DECLINED
Date
The date and time that the change was declined, if any.
AUTH_COMMENTS
VarChar2(2000)
No longer used.
CHANGE_REASON
VarChar2(255)
No longer used.
AUTH_REQ_ID
Number(11,0)
The ID of the authorization request that initiated the change, if
any.
RECORD_ID
VarChar2(255)
The database ID of the record to which the field belongs.
EMP_ID
Number(11,0)
The ID of the related payee, if any.
PLN_ID
Number(11,0)
The ID of the related plan, if any.
TRN_ID
Number(11,0)
The ID of the related event, if any.
CALC_ID
Number(11,0)
The ID of the related calculator, if any.
RECORD_DESC_LOOKUP
VarChar2(1024)
A lookup of RECORD_DESCRIPTION from the dictionary.
OLD_VALUE_RESOLVED
VarChar2(2000)
A lookup of OLD_VALUE from the dictionary. For example, if
OLD_VALUE is “TRN_PRODUCT_CATEGORY” and the screen
value is “Range”, then the value in this field is “Range”.
NEW_VALUE_RESOLVED
VarChar2(2000)
A lookup of NEW_VALUE from the dictionary. For example, if
OLD_VALUE is “TRN_PRODUCT_GROUP” and the screen value
is “Body Style”, then the value in this field is “Body Style”.
DELEGATE_USER_ID
Number(11,0)
The user ID of the delegate user that actually performed the
change, if any. Has a value of 0 or null if no delegate.
Primary key
USR_ID + AUDIT_DATE + TABLE_NAME + SUB_TABLE_NAME + RECORD_ID +
CHANGE_TYPE + FIELD_NAME
Foreign key
AUTH_REQ_ID = AUTH_REQUESTS.AUTH_REQ_ID
90
3
AUTH_BUFFER
CALC_ID = CALCULATORS.CALC_ID
AUTH_BUFFER
This table contains data submitted through ICM Admin for authorization. Each
record represents a proposed change to a field within a table, and they are
grouped by the AUTH_REQ_ID which represents the request for authorization.
The system copies this record from the standard BUFFER table.
For updates to a data item, the record includes the old value and the new value
of the field. For the deletion of a data item, a flag is set in the record to indicate
the change request is a deletion. There is a record for each field associated with
the data item whether that field value has changed or not.
The records remain in the table when the authorization is complete.
Table columns
Column name
Data type
Description
AUTH_REQ_ID
Number(11,0)
The ID of the authorization request.
BFR_USER_ID
Number(11,0)
The ID of the user requesting the change.
BFR_TABLE_NAME
VarChar2(50)
The name of the table containing the data for which a change is
requested.
BFR_RECORD_ID
VarChar2(100)
The compound ID of the record for which a change is requested.
BFR_FIELD_NAME
VarChar2(75)
The name of the field for which a change is requested.
BFR_FIELD_TYPE
Number(11,0)
The data type of the field.
BFR_ORIGINAL_VALUE
VarChar2(255)
The original value of the field.
BFR_NEW_VALUE
VarChar2(255)
The requested new value of the field.
BFR_TEXT_SIZE
Number(11,0)
The size of the new field value, if text.
BFR_EXTENDED_TEXT
VarChar2(2000)
Full text version of the requested new field value.
BFR_RECORD_ID_FIELDS
VarChar2(100)
The names of the fields that make up the record ID.
BFR_DELETE_RECORD
Number(1)
Flag indicating whether the request is to delete data.
Primary key
AUTH_REQ_ID + BFR_USR_ID + BFR_TABLE_NAME +
BFR_FIELD_NAME
BFR_RECORD_ID +
Foreign key
91
3
AUTH_BUFFER_DELETE
AUTH_BUFFER_DELETE
This table represents records to be deleted as part of a submitted authorization
request. Each record represents a record in the database that is to be deleted
should the change be authorized.
The system copies the record from the standard BUFFER_DELETE table, which
is used for auditing.
Table columns
Column name
Data type
Description
AUTH_REQ_ID
Number(11,0)
ID of the request for authorization.
BFR_USER_ID
Number(11,0)
The ID of the user who requested the delete.
BFR_TABLE_NAME
VarChar2(50)
The name of the table containing the record to be deleted.
BFR_RECORD_ID
VarChar2(100)
The compound ID of the record to be deleted.
VarChar2(100)
The names of the ID fields of the table to be deleted.
Primary key
AUTH_REQ_ID + BFR_USER_ID + BFR_TABLE_NAME + BFR_RECORD_ID +
Foreign key
AUTH_BUFFER_NOTE_ATTACHMENTS
This table contains a record for each note attachment for the data item being
edited. The system copies the records from the standard
BUFFER_NOTE_ATTACHMENTS table.
Table columns
Column name
Data type
Description
AUTH_REQ_ID
Number(11,0)
The ID of the request for authorization.
BFR_RECORD_ID
VarChar2(255)
The compound record ID for the data in the buffer.
BFR_TABLE_NAME
VarChar2(50)
The name of the table to which the data in the buffer belongs.
BFR_USER_ID
Number(11,0)
SEQUENCE_NUMBER
Number(11,0)
The sequence number for this attachment.
FILENAME
VarChar2(255)
The name of the attached file.
92
3
AUTH_BUFFER_NOTES
Column name
Data type
Description
ATTACHMENT
BLOB
The attachment itself.
Primary key
None.
Foreign Key
AUTH_BUFFER_NOTES
This table represents changes to notes submitted as part of an authorization
request. Each record represents a change to the record notes submitted for
authorization as part of a request.
The system copies the records from the standard BUFFER_NOTES table.
Table columns
Column name
Data type
Description
AUTH_REQ_ID
Number(11,0)
The ID of the request for authorization.
BFR_USER_ID
VarChar2(50)
BFR_TABLE_NAME
VarChar2(50)
The table containing the data with which the notes are associated.
BFR_RECORD_ID
VarChar2(100)
The compound ID of the table containing the associated data record.
BFR_RECORD_SEQ
Number(11,0)
The sequence number of the notes section.
BFR_PUBLIC_NOTES
VarChar2(2000)
The public notes associated with the record.
BFR_CHANGED
Number(1)
Flag indicating whether the notes have changed.
Primary key
AUTH_REQ_ID + BFR_USER_ID + BFR_TABLE_NAME + BFR_RECORD_ID +
BFR_RECORD_SEQ
Foreign key
93
3
AUTH_REQUEST_USERS
AUTH_REQUEST_USERS
This table contains data associated with the process of authorization of a
submitted change request. Each record represents an activity by a user during
the authorization process.
The record includes any comment made by the user, but does not indicate
whether the user action was to approve the change or to decline it. The
corresponding request record in AUTH_REQUESTS indicates the user ID if any
that declined the request. All other user actions associated with the request are
assumed to be approvals because the authorization process ends immediately
after a user declines the change.
The records remain in the table when the authorization process ends.
Table columns
Column name
Data type
Description
AUTH_REQ_ID
Number(11,0)
The ID of the authorization request.
AUTH_LEVEL
Number(11,0)
The level in the authorization stack that the user responded
at.
AUTH_USER
Number(11,0)
The ID of the authorizing user.
AUTH_USER_NAME
VarChar2(75)
The full name of the authorizing user.
AUTH_DATE
Date
The date and time that the authorizing user responded.
AUTH_NOTES
VarChar2(255)
The notes entered by the authorizing user.
AUTH_DELEGATE_USER_ID
Number(11,0)
The ID of the delegate user who is performing the
authorization, if any.
AUTH_DELEGATE_USER_NAME
VarChar2(75)
The name of the delegate user who is performing the
authorization, if any.
Primary key
AUTH_REQ_ID + AUTH_LEVEL + AUTH_USER
Foreign key
AUTH_REQ_ID = AUTH_REQUESTS.QUTH_REQ_ID
AUTH_USER = USERS.USR_ID
94
3
AUTH_REQUESTS
AUTH_REQUESTS
This table contains the authorization requests. Each record represents a request
for a change to a record by a user.
The record includes information from the associated authorization rule (such as
how many users must authorize the change at each level). The system updates
this record as the authorization request proceeds so that it contains the current
state including: the authorization level, whether the request is in progress,
declined or authorized, and when it was declined or authorized and by whom.
The record remains in the table when the authorization process finishes.
Table columns
Column name
Data type
Description
AUTH_REQ_ID
Number(11,0)
The internally generated ID of the authorization
request.
AUTH_ID
Number(11,0)
The ID of the authorization rule used to process this
request.
AUTH_CODE
VarChar2(50)
The internal code representing the data area being
submitted for change.
TABLE_NAME
VarChar2(50)
The database name of the table containing the data
RECORD_ID
VarChar2(75)
The compound record ID of the record being submitted
for change.
SUBMITTED_BY
Number(11,0)
The ID of the user who submitted the change for
approval.
SUBMITTED_BY_NAME
VarChar2(75)
The name of the user who submitted the change for
approval.
SUBMITTED_DATE
Date
The date and time at which the change was submitted
for approval.
LEVEL_1_USER_COUNT
Number(11,0)
The number of authorizing users who have approved at
level 1.
LEVEL_2_USER_COUNT
Number(11,0)
level 2.
LEVEL_3_USER_COUNT
Number(11,0)
level 3.
DECLINED_USER
Number(11,0)
The ID of the user who declined the request, if any.
DECLINED_USER_NAME
VarChar2(75)
The name of the user who declined the request, if any.
DECLINED_DATE
Date
Date and time that the request was declined, if any.
DECLINED_NOTES
VarChar2(255)
Notes provided by the declining user, if any.
TABLE_DESCRIPTION
VarChar2(75)
A descriptive name of the table containing the data
LOCATOR_NUMBER
Number(11,0)
Internally generated combination of the rule ID and
current level used to filter against authorizing users.
95
3
AUTH_REQUESTS
Column name
Data type
Description
CURRENT_AUTH_LEVEL
Number(11,0)
The authorization level that the request has reached, if
any.
APPROVED_DATE
Date
Date and time at which the request was approved, if
any.
LEVEL_1_USER_REQUIRED
Number(11,0)
The number of authorizing users required at level 1.
Number(11,0)
Number(11,0)
AUTH_NUM_LEVELS
Number(11,0)
The number of authorization levels in the rule.
APPROVED
Number(1)
Flag indicating whether the request has been approved.
DECLINED
Number(11,0)
Flag indicating whether the request has been declined.
APPROVED_USER
Number(11,0)
The ID of the user who provided the final approval, if
any.
APPROVED_USER_NAME
VarChar2(100)
The name of the user who provided the final approval,
if any.
EMP_ID
Number(11,0)
The payee ID associated with the data area change
submitted, if any.
PLN_ID
Number(11,0)
The ID of the plan associated with the data area
changed, if any.
TRN_ID
Number(11,0)
The ID of the event associated with the data area
changed, if any.
AUTOMATIC
Number(1)
This field will be set to true when an authorization
request is generated by a data port, and false if an
authorization request is generated manually.
ABANDONED
Number(1)
Boolean flag set if an authorization request is
abandoned using the functionality described in this
document.
ABANDONED_DATE
Date
The date and time the authorization request was
abandoned.
ABANDONED_BY
Number(11,0)
The user ID of the user who abandoned the request. Set
to 0 when the request is abandoned as part of the
re-submission process.
CUSTOM_CODE_URL
VarChar2(255)
Used when custom code is used to view a custom screen
record that requires authorization.
ENTITY_NAME
VarChar2(50)
The name of the entity that is under authorization
control, in other words 'Payee' rather than the name of
a particular payee.
AUTH_CHANGE_TYPE
Number(11,0)
The type of change performed by the user that requires
authorization: UPDATE, NEW, or DELETE.
PROC_REQ_STATUS
Number(11,0)
Flag indicating whether the authorisation request is
new or has started:
0 - New, pending
1 - Started, in progress
RELATED_ID1
Number(11,0)
No longer used.
PROC_JOB
Number(11,0)
No longer used.
96
3
AUTH_RULES
Column name
Data type
Description
NUMBER_OF_ROWS
Number(11,0)
Used when bulk edit changes are to be authorised.
Stores the number of rows that to be changed if the
bulk edit request is approved.
SUBMITTED_BY_DELEGATE_ID
Number(11,0)
The ID of the delegate user that submitted the change
for approval, if any.
DECLINED_BY_DELEGATE_ID
Number(11,0)
The ID of the delegate user that declined the change, if
any.
APPROVED_BY_DELEGATE_ID
Number(11,0)
The ID of the delegate user that provided the final
approval, if any.
SUBMITTED_BY_DELEGATE_NAME
VarChar2(75)
The name of the delegate user that submitted the
change for approval, if any.
DECLINED_BY_DELEGATE_NAME
VarChar2(75)
The name of the delegate user that declined the change,
if any.
APPROVED_BY_DELEGATE_NAME
VarChar2(75)
The name of the delegate user that provided the final
approval, if any.
Primary key
AUTH_REQ_ID
Foreign key
AUTH_ID = AUTH_RULES.AUTH_ID
APPROVED_USER = USERS.USR_ID
DECLINED_USER = USERS.USR_ID
AUTH_RULES
This table contains the authorization rules that are used to control changes to
data in the ICM database. Each record represents a rule that can be used as part
of a user security profile.
Table columns
Column name
Data type
Description
AUTH_ID
Number(11,0)
The internally generated unique identifier for the rule. There are two
default rules that must be present with the following IDs:
-100 Default payment batch rule.
-200 Default statement batch rule.
AUTH_NAME
VarChar2(75)
The name of the authorization rule.
AUTH_1_COUNT
Number(11,0)
The number of users required to authorize at level 1.
AUTH_2_COUNT
Number(11,0)
97
3
AUTH_RULES
Column name
Data type
Description
AUTH_3_COUNT
Number(11,0)
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
AUTH_NUM_LEVELS
Number(11,0)
The number of levels (or conditions) contained within the rule.
AUTH_COND_
DEFAULT
Number(11,0)
The ID of the rule to apply if none of the authorization rule conditions
are met.
AUTH_COND_1
Number(11,0)
The ID of the rule to apply if the first authorization rule condition is
met.
AUTH_COND_2
Number(11,0)
The ID of the rule to apply if the second authorization rule condition is
met.
AUTH_COND_3
Number(11,0)
The ID of the rule to apply if the third authorization rule condition is
met, if any.
AUTH_CONDITIONAL
Number(11,0)
Flag indicating the category of authorization rule:
0 - General
1 - Payee
2 - Individual
3 - Overall
4 - Frequency
AUTH_VALUE_1
Number(15,2)
The value involved in the first authorization rule.
AUTH_VALUE_2
Number(15,2)
The value involved in the second authorization rule.
AUTH_VALUE_3
Number(15,2)
The value involved in the third authorization rule.
AUTH_FREQ_1
VarChar2(5)
Frequency rule only: the frequency associated with the first
authorization rule. The values are specified by a number prefixed with a
letter to indicate how the frequency is measured:
N - minutes
H - hours
D - days
W - weeks
M - months
Quarterly is specified as M3 and yearly as M12.
AUTH_FREQ_2
VarChar2(5)
Frequency rule only: the frequency associated with the second
authorization rule.
AUTH_FREQ_3
VarChar2(5)
Frequency rule only: the frequency associated with the third
authorization rule.
Primary key
AUTH_ID
Foreign keys
None.
98
3
AUTH_RULES_DELETED
AUTH_RULES_DELETED
This table contains a record for each authorization rule that has been deleted.
These records are needed to provide the name of the authorization rule for
reports.
Table columns
Column name
Data type
Description
AUTH_ID
Number(11,0)
The unique ID of the authorization rule.
AUTH_NAME
VarChar2(75)
The name of the authorization rule.
AUTH_DATE_DELETED
Date
The date and time that the rule was deleted.
Primary key
None.
Foreign keys
None.
AUTH_WORKSHEET
This table contains the top level settings of the authorization worksheet filter.
Each record contains the settings for a single user.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user.
AW_DATE_FROM
Date
The current state of the Date from filter field.
AW_DATE_TO
Date
The current state of the Date to filter field.
AW_SUBMITTED_BY
Number(11,0)
The current state of the Submitted By filter field.
AW_RULE
Number(11,0)
The current state of the Rule filter field.
AW_LEVEL
Number(11,0)
The current state of the Level filter field.
AW_LINES
Number(11,0)
The current state of the number of lines to show within the list.
AW_DATA_TYPES
VarChar2(100)
The current state of the data type shown within the list.
Primary key
USR_ID
99
3
AUTH_WORKSHEET_JOBS
Foreign keys
None.
AUTH_WORKSHEET_JOBS
This table is not currently used.
AUTH_WORKSHEET_REMOVED
This table contains the specific request IDs that are excluded by users.
Table columns
Column name
Data type
Description
USER_ID
Number(11,0)
The ID of the user.
AUTH_REQ_ID
Number(11,0)
The ID of the submitted request.
Primary key
USER_ID + AUTH_REQ_ID
Foreign keys
None.
BASE_DATA
This table contains the majority of the logical reference data tables. Each logical
table is identified by a field ID held in the DS_SYSFUNCT column. The table is
populated through the ICM Admin user interface or through data ports as
required. The use of the name, group and start and end date fields depends on
the system parameter settings associated with the relevant reference area.
Table columns
Column name
Data type
Description
BD_ID
Number(11,0)
The internally generated unique ID for the reference data item.
DS_SYSFUNCT
Number(11,0)
The field ID of the type of data reflected by this reference data item.
BD_CODE
VarChar2(50)
The reference data item code.
BD_DESC
VarChar2(50)
The reference data item name.
100
3
BASE_SALARIES
Column name
Data type
Description
BD_GROUP
VarChar2(50)
The reference data item group.
BD_TYPE
VarChar2(50)
No longer used.
BD_SYNCH
Date
Used as a time stamp by data ports when synchronizing incoming data.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
BD_CLASS_1 to
BD_CLASS_10
VarChar2(100)
Classification fields 1 to 10.
BD_CLASS_11 to
BD_CLASS_14
Number(15,2)
BD_CLASS_15 to
BD_CLASS_18
Number(1)
BD_CLASS_19 to
BD_CLASS_20
Date
BD_START_DATE
Date
The start date of any base data record.
BD_END_DATE
Date
The end date of any base data records.
Primary key
BD_ID
Foreign keys
BD_YEAR + BD_PERIOD = FIN_PERIODS.[FIN_YEAR_ID + FP_PERIOD_SEQ]
BASE_SALARIES
This table contains the basic salary settings for payees. Each record represents
the start of a basic salary value associated with the payee. The table is populated
via the ICM Admin user interface or via data ports.
Table columns
Column name
Data type
Description
EMP_ID
Number(11,0)
FIN_YEAR_ID
Number(11,0)
The ID of the effective year.
FP_PERIOD_SEQ
Number(11,0)
The ID of the effective period.
BASE_SALARY
Number(15,2)
The basic salary in payment currency.
Primary key
EMP_ID + FIN_YEAR_ID + FP_PERIOD_SEQ
101
3
BATCH_RECALCS
Foreign keys
FP_PERIOD_SEQ]
BATCH_RECALCS
This table stores the job ID of the current batch recalculation job. The table is
only used if the Should manual transaction change recalcs be batched? system
parameter is set to yes. The name of this parameter in the SYSTEM_PARAMETERS
table is BATCH_RECALCS.
The batch recalculation job is run when the next Do Calculations job runs at the
ICM server to queue a Set Calculations job. For details on this job, see “Job type
74 - Set calculations” in the System Administration Guide. A new batch is started
when the Set Calculations job ends.
Table columns
Column name
Data type
Description
CURRENT_RECALC_JOB
Number(11,
0)
The ID of the recalculation job.
Primary key
None.
Foreign keys
None.
BOOKMARK_ENTRIES
This table holds the information about selected payee and plan combinations
for the bookmarks.
Table columns
Column name
Data type
Description
BM_ID
Number(11,0)
The unique ID of the bookmark.
EMP_ID
Number(11,0)
The unique ID of the payee.
102
3
BOOKMARKS
Column name
Data type
Description
PLN_ID
Number(11,0)
The unique ID of the plan.
-1 indicates that payee level details are included in the bookmark.
Primary key
BM_ID + EMP_ID + PLN_ID
Foreign keys
BM_ID = BOOKMARKS.BM_ID
BOOKMARKS
This table holds the bookmark information. A bookmark holds the information
about selected payee and plan combinations within the BOOKMARKS_ENTRIES
table. The payee and plan settings is stored in the SEL_FILTERS table, using the
next available value in the FILTER_SOURCE field. The ID1 field in the SEL_FILTERS
table is the BM_ID value from the BOOKMARKS table.
Table columns
Column name
Data type
Description
BM_ID
Number(11,0)
Internally generated unique identifier for the bookmark.
BM_NAME
VarChar2(100)
The name of the bookmark.
BM_DATE
Date
The timestamp represented by the bookmark.
FIN_YEAR_ID
Number(11,0)
The ID of the financial year that the bookmark relates to.
FP_PERIOD_SEQ
Number(11,0)
The ID of the period that the bookmark relates to.
BM_DESCRIPTION
VarChar2(2000)
The description specified against the bookmark.
BM_PAYMENT
Number(1)
Flag indicating that the bookmark is payment related.
LAST_MODIFIED
Date
Date and time that the record was last modified. The system assigns
this value.
LAST_MODIFIED_BY
Number(11,0)
ID of the user who last modified the record. The system assigns this
value.
Primary key
BM_ID
Foreign keys
None.
103
3
BUFFER
BUFFER
This table holds the state of data being edited, until it is committed to the main
data tables. Each record represents a field within the records being edited.
Table columns
Column name
Data type
Description
BFR_PAGE
VarChar2(50)
The page code of this record contained in the buffer.
BFR_USER_ID
Number(11,0)
The ID of the user to whom the buffered data belongs.
BFR_TABLE_NAME
VarChar2(50)
The database name of the table to which the record contained
within the buffer belongs.
BFR_FIELD_NAME
VarChar2(50)
The database name of the field that this buffer item represents.
BFR_FIELD_TYPE
Number(11,0)
The data type contained in the field.
BFR_TEXT_SIZE
Number(11,0)
The size of the new field contents, for text fields.
BFR_EXTENDED_TEXT
VarChar2(2000)
Full text version of the new value of the buffer item, used for long
text fields.
VarChar2(100)
The field names that comprise the record ID for the record
contained in the buffer.
BFR_DELETE_RECORD
Number(1)
Flag indicating whether the buffer represents a record delete.
BFR_RECORD_ID
VarChar2(255)
The compound record ID of the record contained in the buffer.
BFR_ORIGINAL_VALUE
VarChar2(4000)
The original value of the buffer item.
BFR_NEW_VALUE
VarChar2(4000)
The new value of the buffer item.
Primary key
BFR_USER_ID + BFR_PAGE + BFR_TABLE_NAME + BFR_RECORD_ID +
BFR_FIELD_NAME
Foreign keys
BFR_USER_ID = USERS.USR_ID
104
3
BUFFER_AUTH
BUFFER_AUTH
This table takes receipt of the authorization rule identifier when a user attempts
to commit the contents of a data buffer. Its contents are transitory, and are
removed once the buffer is committed or a new record is loaded for the user and
page combination.
A database table is used to store the ID, so that an installation can implement a
database trigger that could change the rule ID, based on more complex criteria
than is available with standard functionality.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user to whom the buffer data belongs.
AUTH_ID
Number(11,0)
The ID of the authorization rule applied to the data in the buffer.
BFR_PAGE
VarChar2(50)
The page code for the data in the buffer to which the rule is being applied.
Primary key
USR_ID + BFR_PAGE + AUTH_ID
Foreign keys
USR_ID = USERS.UDR_ID
BUFFER_DELETE
This table contains identifiers for records that need to be deleted as a result of
changes made in the buffer by a user. Each record represents a record in a
database table that is to be deleted after the change is committed.
Table columns
Column name
Data type
Description
BFR_PAGE
VarChar2(50)
The page code for the data in the buffer.
BFR_USER_ID
Number(11,0)
The ID of the user to whom the data in the buffer belongs.
BFR_TABLE_NAME
VarChar2(50)
The table name to which the data in the buffer belongs.
VarChar2(100)
The fields names that comprise the record ID for the data in the
buffer.
BFR_RECORD_ID
VarChar2(255)
105
3
BUFFER_NOTE_ATTACHMENTS
Primary key
BFR_PAGE + BFR_USER_ID + BFR_TABLE_NAME + BFR_RECORD_ID_FIELDS +
BFR_RECORD_ID
Foreign keys
BUFFER_NOTE_ATTACHMENTS
This table contains note attachment files uploaded against records being edited
by users in ICM Admin. Each record represents a note attachment file.
Table columns
Column name
Data type
Description
BFR_PAGE
VarChar2(50)
BFR_RECORD_ID
VarChar2(255)
BFR_TABLE_NAME
VarChar2(50)
BFR_USER_ID
Number(11,0)
SEQUENCE_NUMBER
Number(11,0)
The sequence number for this attachment.
FILENAME
VarChar2(255)
ATTACHMENT
BLOB
The attachment itself.
Primary key
None.
Foreign keys
106
3
BUFFER_NOTES
BUFFER_NOTES
This table contains notes associated with a data record whilst it is being edited
by a user in ICM Admin. Each record represents the notes associated with a
record currently in the buffer.
Table columns
Column name
Data type
Description
BFR_PAGE
VarChar2(50)
BFR_USER_ID
Number(11,0)
The ID of the user to whom the data in the buffer belongs.
BFR_TABLE_NAME
VarChar2(50)
BFR_RECORD_SEQ
Number(11,0)
The notes sequence number.
BFR_PUBLIC_NOTES
VarChar2(2000)
The public notes for the data in the buffer.
BFR_CHANGED
Number(1)
Flag indicating whether the notes have changed.
BFR_RECORD_ID
VarChar2(255)
Primary key
BFR_USER_ID + BFR_PAGE + BFR_TABLE_NAME + BFR_RECORD_ID +
BFR_RECORD_SEQ
Foreign keys
BULK_DATA_FAILURE_UPDATE_FLDS
This table temporarily stores any new values that are to be written to fields by a
mass update job, other than changes to the status field. The table is populated
when a user chooses additional fields for updating while defining the mass
update using Data > Data Failures > Mass Update in ICM Admin.
Table columns
Column name
Data type
Description
BDFUF_ID
Number(11,0)
The system generated unique ID of the field to be changed by the mass update
job.
BDFU_ID
Number(11,0)
The ID of the mass update job. This ID refers to a record in the
BULK_DATA_FAILURE_UPDATES table.
FIELD_NAME
VarChar2(1000)
The name of the field in the data records to be changed by the mass update job.
FIELD_VALUE
VarChar2(1000)
The value to be written to the field by the mass update job.
107
3
Primary key
BDFUF_ID
Foreign keys
BDFU_ID = BULK_DATA_FAILURE_UPDATES.BDFU_ID
This table temporary stores the details of a pending mass update job that has
been queued by a user choosing Data > Data Failures > Mass Update in ICM
Admin. The entry in the table is removed when the job completes.
Mass update jobs are used to reset the status field and other fields in source data
records that failed to be loaded by an interactive data port. Any changes to fields
other than the status field are stored in the BULK_DATA_FAILURE_UPDATE_FLDS
table.
Table columns
Column name
Data type
Description
BDFU_ID
Number(11,0)
The system generated unique ID for the mass update request.
LOAD_STATUS_ORIG
VarChar2(255)
The current value in the status field that a record must have to be
included in the mass update.
LOAD_STATUS_NEW
VarChar2(255)
The new value to be written to the status field by the mass update
job.
ERROR
VarChar2(1000)
The value in the error field that a record must have to be included in
the mass update.
Primary key
BDFU_ID
Foreign keys
None.
108
3
This table records when payees has viewed bulletins and requested not to see
the bulletins again when they next log in to NICE ICM. The table contains a
record for each payee for each bulletin that the payee has requested not to see.
Table columns
Column name
Data type
Description
ID
Number(11,0)
A system generated unique identifier for the record.
BUL_ID
Number(11,0)
The ID of the bulletin at is no longer to be popped up when a user logs in.
EMPLOYEE_ID
Number(11,0)
The ID of the payee requesting that the bulletin should no longer pop up
during log in.
ACK_DATE
Timestamp(6)
The date and time at which the payee requested that the bulletin should no
longer pop up.
Primary key
ID
Foreign keys
BUL_ID = BULLETINS.BUL_ID
BULLETIN_SETTINGS
This table contains settings associated with a bulletin. Each record represents a
setting parameter and its associated value.
Table columns
Column name
Data type
Description
BUL_ID
Number(11,0)
The ID of the bulletin.
SETTING_PARAMETER
VarChar2(50)
The name of the bulletin parameter.
SETTING_VALUE
VarChar2(255)
The value of the bulletin parameter.
Primary key
BUL_ID + SETTING_PARAMETER
Foreign keys
BUL_ID = BULLETINS.BUL_ID
109
3
BULLETINS
BULLETINS
This table contains the definition of bulletins. Each record represents a bulletin
definition. The table is populated via the user interface.
Table columns
Column name
Data type
Description
BUL_ID
Number(11,0)
The internally generated unique ID of the bulletin.
BUL_GROUP
VarChar2(75)
The group that the bulletin belongs to.
BUL_NAME
VarChar2(75)
The name of the bulletin.
BUL_TITLE
VarChar2(255)
The title text to be used by the bulletin.
BUL_DATE_FROM
Date
The date from which the bulletin takes effect.
BUL_DATE_TO
Date
The date until which the bulletin takes effect.
BUL_ENABLED
Number(1)
Flag indicating whether the bulletin is enabled.
BUL_GRAPHIC
VarChar2(50)
The name of the graphic file associated with the bulletin, if any.
BUL_URL
VarChar2(255)
The URL to present as the more information option, if any.
BUL_CONTENTS1
VarChar2(2000)
The text for the first section of the bulletin.
BUL_CONTENTS2
VarChar2(2000)
The text for the second section of the bulletin.
BUL_CONTENTS3
VarChar2(2000)
The text for the third section of the bulletin.
BUL_REPORT
Number(11,0)
The ID of a report associated with the bulletin, if any.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
BUL_POP
Number(1)
Flag indicating whether the bulletin should pop up on entry by a
payee.
BUL_THUMBNAIL
VarChar2(255)
The name of the graphic file to be displayed as a thumbnail for this
bulletin. The system displays the thumbnail as an image 80 pixels
wide and 52 pixels high, and resizes the specified graphic to fit these
dimensions.
Primary key
BUL_ID
Foreign keys
BUL_REPORT = DRN_REPORTS.REPORT_ID
LAST_MODIFIED_BY = USERS.USR_ID
110
3
CALC_DEP_BATCHES
CALC_DEP_BATCHES
This table contains a record for each calculation dependency batch created by
NICE ICM when data changes are made that might mean recalculations. For
example, a user might change an object using ICM Admin or run a data port.
The plans and payees in the batch that need to be marked for recalculation are
written to CALC_DEP_BATCHES_ITEMS.
NICE ICM runs a Calculation Dependency job (job type 78) to perform the
actual marking of payees and plans. After completing the marking, the job
deletes the batch from this table. For details on the job, see the System
Administration Guide.
Table columns
Column name
Data type
Description
BATCH_ID
Number(11,0)
Unique identifier for the batch.
CREATED_ON_DATE
Date
Date on which the batch was created.
REBUILD_REQ
Number(1,0)
Flag indicating whether a rebuild of the calculation dependency map is
required before any of the specific batch items are processed.
-1 - Rebuild required
0 or null - No rebuild required
MODEL_UPDATE
Number(1,0)
Flag indicating whether a model is also affected by the changes.
-1 - Model affected
REASON
Number(11,0)
Code indicating the reason for the recalculation. Can be one of the
following:
0 - No reason (for example, after a system upgrade)
1 - New event
2 - Payee edit
3 - Draw edit
4 - SPIF edit
5 - Target edit
6 - OTC edit
7 - Clawback edit
8 - Payment adjustment edit
9 - Corporate target edit
10 - Model edit
11 - Salary edit
12 - Exchange rate edit
13 - MBO edit
14 - List edit
15 - Financial year edit
16 - Payment batch deletion
111
3
Column name
Data type
Description
17 - Statement batch deletion
18 - Plan edit
19 - Sales structure edit
20- Calculator edit
21- Calculator series edits
Reasons have a priority used to determine the order in which
recalculations are performed. Priorities are as follows (1 is top priority):
1 - Code 1 (New events)
2 - Codes 2 to 17 (Everything else except priority 3)
3 - Code 18 to 21 (Plan edits, sales structure edits, calculator edits,
calculator series edits)
Primary key
BATCH_ID
Foreign key
None.
This table contains a record for each item that might require recalculation in a
calculation dependency batch.
The possible values for TYPE, MAIN_ID, and SUB_ID1 are shown in the
following table.
TYPE
MAIN_ID
SUB_ID1
Description
0
ID of the slave
plan
ID of payee the
plan belongs to
Mark slave plan. For the specified slave plan,
mark it and the payee, and all depending plans
and payees, as needing processing.
1
ID of the payee
whose plans
need marking
ID of financial
year (optional)
Mark all slave plans. Mark all the slave plans for
the specified payee, and all depending plans
and payees, as needing processing.
2
ID of the payee
Not used
Mark payee. Mark the specified payee as
needing processing. None of the payee’s plans
are marked.
3
ID of
calculator
Not used
Mark calculator users. Find all plans using the
specified calculator and mark them, and all
depending plans and payees, as needing
processing.
4
Not used
Not used
No specific action. Used in cases where no
specific marking operations are required, such
as sales structure edits.
112
3
CALC_DEP_PLAN_LOOPS
NICE ICM runs a Calculation Dependency job (job type 78) to perform the
actual marking of payees and plans. After completing the marking, the job
deletes the batch from this table. For details on this job, see the System
Table columns
Column name
Data type
Description
BATCH_ID
Number(11)
The ID of the calculation batch.
SEQ_NUM
Number(11)
Number indicating the sequence in which the items were added to the
batch.
TYPE
Number(11)
Number indicating the specific operation to be carried out. See above
table.
MAIN_ID
Number(11)
Additional code used by the operation specified at TYPE. See above
table.
SUB_ID1
Number(11)
Additional code used by the operation specified at TYPE. See above
table.
SUB_ID2
Number(11)
Not currently used.
Primary key
BATCH_ID + SEQ_NUM
Foreign key
BATCH_ID = CALC_DEP_BATCHES.BATCH_ID
CALC_DEP_PLAN_LOOPS
This table contains records defining any loops detected by the Calculation
Dependency job. You can use the reporting source called Plan Loops to view the
loops. The presence of a loop normally indicates an inconsistency in the plan
definitions.
Table columns
Column name
Data type
Description
LOOP_ID
Number(24,0)
The ID of the calculation loop.
SEQ
Number(24,0)
Number indicating the sequence in which the items were added to the
loop.
PLN_ID
Number(24,0)
The ID of a plan involved in the loop.
113
3
CALC_JOB
Primary key
LOOP_ID + SEQ
Foreign key
CALC_JOB
CALCULATION_BATCH
This table contains a summary information record for the calculation jobs (job
type 80) run as part of a Do Calculations job (job type 75). This information is
written to the table by the Process calculation batch summary job (job type 81).
The calculation jobs contained in each calculation batch are stored in
CALCULATION_BATCH_JOBS.
For details on the server job types, see the System Administration Guide.
Table columns
Column name
Data type
Description
CB_ID
Number(11,0)
The ID of the calculation batch.
PAYEES
Number(11,0)
The total number of payees calculated.
PLANS
Number(11,0)
The total number of plans calculated
TRANSACTIONS
Number(11,0)
The total number of events calculated
AVG_PAYEE_TM
Number(20,8)
The average calculation time per payee.
MIN_PAYEE_TM
Number(20,8)
The minimum payee calculation time.
MAX_PAYEE_TM
Number(20,8)
The maximum payee calculation time.
START_DATE
Date
The date that the first calculation job started.
BATCH_END_DATE
Date
The date that the Process calculation batch summary job finished
writing values to the table.
PROCESSED_FG
Number(1,0)
Flag indicating whether the Process calculation batch summary job
has finished writing values to the table.
CALC_END_DATE
Date
The date that the last calculation job ended.
ABORTED_CALC_JOBS
Number(11,0)
The number of calculation jobs that did not complete.
Primary key
CB_ID
114
3
Foreign key
None.
This table contains records showing the calculation jobs (job type 80)
belonging to each calculation batch. For details on the server job types, see the
Table columns
Column name
Data type
Description
CB_ID
Number(11,0)
A unique identified for the calculation batch.
JOB_ID
Number(11,0)
The ID of a calculation job that was run as part of the calculation batch.
Primary key
CB_ID + JOB_ID
Foreign key
CB_ID = CALCULATION_BATCH.CB_ID
JOB_ID = JOBS.JOB_ID
This table contains records defining the calculation dependency map used by
NICE ICM to schedule calculation jobs in the order that keeps recalculations to
a minimum.
When NICE ICM runs a Do Calculations job (job type 75) to perform
calculations, the job uses the dependency map to ensure it calculates the payees
in the order that will minimize any repeated calculations of the same payee.
The table is populated by the Calculation Dependency job (job type 78).
115
3
The records specify which plan and payee combination is dependent on
another:
•
If there are values in both PLN_ID and DEPENDENT_PLN_ID, then this
means that the plan with PLN_ID depends on the plan with
DEPENDENT_PLN_ID. If DEPENDENT_PLN_ID is marked for
recalculation, then PLN_ID must also be marked.
•
If there is a value only in PLN_ID and not in DEPENDENT_PLN_ID, then
this means that DEPENDENT_PLN_ID is a leaf node in the dependency tree.
This plan does not depend on any other plans.
•
If there is a value in DEPENDENT_PLN_ID but not in PLN_ID, then this
means that it is a root node in the dependency tree. No other plans depend
on this plan.
The EMP_ID and DEPENDENT_EMP_ID fields are also included in the table to
make it easier for NICE ICM to use the map at a payee level, but the actual
dependencies are always between plans rather than between payees.
For example in the following dependency tree, there would be records shown in
the table below.
Plan ID 100
Plan ID 300
Plan ID 200
PLN_ID
DEPENDENT_PLN_ID
null
100
100
200
100
300
200
null
300
null
Table columns
Column name
Data type
Description
CD_ID
Number(11,0)
Unique identifier for the record.
EMP_ID
Number(11,0)
The ID of a payee belonging to the plan specified at PLN_ID.
PLN_ID
Number(11,0)
The ID of a plan. If DEPENDENT_PLN_ID has a value, then PLN_ID
must be recalculated if DEPENDENT_PLN_ID is marked for
recalculation. If DEPENDENT_PLN_ID is null, then PLN_ID does not
depend on any other plans.
DEPENDENT_EMP_ID
Number(11,0)
The ID of a payee belonging to the plan specified at
DEPENDENT_PLN_ID.
116
3
Column name
Data type
Description
DEPENDENT_PLN_ID
Number(11,0)
The ID of a plan. If PLN_ID has a value, then if DEPENDENT_PLN_ID
is marked for recalculation, PLN_ID must also be recalculated. If
PLN_ID is null, then no plans are dependent on
DEPENDENT_PLN_ID.
DELTA
Number(11,0)
Internal flag used during processing to indicate whether a dependency
is new or existing.
Primary key
CD_ID
Foreign key
DEPENDENT_EMP_ID = EMPLOYEES.EMP_ID
DEPENDENT_PLN_ID = PLANS.PLN_ID
This table contains details of the background and text formatting that has been
applied to calculator cells in ICM Admin by users. Each record defines the
formatting for a single cell. Cells that have not been formatted by the user are
not contained in this table.
Table columns
Column name
Data type
Description
CALC_ID
Number(11,0)
The ID of the calculator.
COL_INDEX
Number(11,0)
The column index number of the cell, starting at 1.
-1 indicates that the formatting was set by the user at the column
header cell and so applies to all cells in the column unless overridden
for a specific cell.
ROW_INDEX
Number(11,0)
The row index number of the cell, starting at 0.
-1 indicates that the formatting was set by the user at the row header
cell and so applies to all cells in the row unless overridden for a specific
cell.
COLOUR_CODE
VarChar2(6)
ITALIC
Number(1)
Hexadecimal HTML color code for the cell background color.
Flag indicating whether the cell text style is italic
-1 - Cell text is italic
BOLD
Number(1)
Flag indicating whether the cell text style is bold
-1 - Cell text is bold
FONT
VarChar2(60)
The name of the cell text font.
FONT_SIZE
Number(11,0)
The size of the cell text in points.
117
3
CALCULATOR_CELLS
Column name
Data type
Description
FONT_COLOUR_CODE
VarChar2(6)
Hexadecimal HTML color code for the cell text color.
TEXT_ALIGN
Number(11,0)
The cell text alignment:
0 - Left aligned
1 - Centered
2 - Right aligned
STYLE_ID
Number(11,0)
The ID of the calculator named style (if any) associated with this cell.
Primary key
None.
Foreign keys
STYLE_ID = CALCULATOR_NAMED_STYLES.STYLE_ID
CALCULATOR_CELLS
This table contains the cells within calculators. Each record represents a cell
within a calculator and its associated formula or value.
Table columns
Column name
Data type
Description
CALC_ID
Number(11,0)
The ID of the calculator to which this cell belongs.
CALC_ROW
Number(11,0)
The number of the row in the calculator grid represented by this cell.
CALC_COLUMN
Number(11,0)
The number of the column in the calculator grid represented by this cell.
CALC_FORMULA
VarChar2(255)
The formula or value that exists in this cell.
Primary key
CALC_ID + CALC_ROW + CALC_COLUMN
Foreign keys
118
3
This table contains details of the column width formatting that has been
applied to calculators in ICM Admin by users. Each record defines the
formatting for a single column. Columns that have not been formatted by the
user are not contained in this table.
NOTE: The entries in this table for a calculator are all removed if a user clicks
the Reset link in the edit view or test mode for the calculator.
Table columns
Column name
Data type
Description
CALC_ID
Number(11,0)
COL_INDEX
Number(11,0)
The column index number, starting at 0 for the left most column.
COL_WIDTH
Number(24,0)
The width of the column in pixels.
TEST_MODE
Number(1)
Flag indicating which mode the width applies to:
-1 - Applies to test mode
0 - Applies to edit mode
Primary key
None.
Foreign keys
CALCULATOR_FILTERS
This table is a legacy table used by earlier version of NICE ICM. The table is no
longer used.
CALCULATOR_NAMED_STYLES
This table defines a style that can be applied to calculator cells. The table is
populated when users create named styles by choosing Administration > System
Configuration > Styles in ICM Admin.
119
3
Table columns
Column name
Data type
Description
STYLE_ID
Number(11,0)
A unique identifier for the named style.
STYLE_NAME
VarChar2(75)
The name of the named style. This name appears in popups when the
user can select a style.
COLOUR_CODE
VarChar2(6)
A hexadecimal code defining the RGB values for the color of the cell
background.
ITALIC
Number(1)
Flag indicating whether the text should be italic (-1) or not (0).
BOLD
Number(1)
Flag indicating whether the text should be bold (-1) or not (0).
FONT
VarChar2(60)
The name of the font to be used for text.
FONT_SIZE
Number(11,0)
The size of the font (in points).
FONT_COLOUR_CODE
VarChar2(6)
A hexadecimal code defining the RGB values for the font color.
TEXT_ALIGN
Number(11,0)
The text alignment: Possible values are:
0 - Left
1 - Center
2 - Right
Primary key
STYLE_ID + STYLE_NAME
Foreign keys
None.
This table contains references between calculators. An example a reference to a
table calculator from an event calculator.
Table columns
Column name
Data type
Description
CALC_ID
Number(11,0)
The ID of the calculator containing the reference.
REFERENCED_CALC_ID
Number(11,0)
The ID of the calculator that is referenced.
SYNCH
Date
The date and time when the calculator containing the reference was
last updated.
Primary key
CALC_ID + REFERENCE_CALC_ID
120
3
CALCULATOR_SETTINGS
Foreign keys
REFERENCED_CALC_ID = CALCULATORS.CALC_ID
CALCULATOR_SETTINGS
This table contains the dimension settings associated with table calculators.
Each record represents a setting and its associated value.
Table columns
Column name
Data type
Description
CALC_ID
Number(11,0)
SETTING_PARAMETER
VarChar2(50)
The name of the calculator parameter.
SETTING_VALUE
VarChar2(255)
The value of the calculator parameter.
Primary key
CALC_ID + SETTING_PARAMETER
Foreign keys
121
3
This table contains the test values that users last used when testing calculators.
The table has a record for each test value for each user for each calculator. The
system uses the information to pre-populate the test calculator tab with the
values that the user last used to test a calculator.
Table columns
Column name
Data type
Description
CTV_ID
Number(11,0)
The internally generated unique ID for this record.
CTV_USER_ID
Number(11,0)
The ID of the user for which this test value applies.
CTV_CALC_ID
Number(11,0)
The ID of the calculator for which this test value applies.
CTV_AUTH_ID
Number(11,0)
If the calculator is associated with an authorization rule, this column is
set to the ID of the rule when the calculator is first saved. The column is
set to 0 after the calculator has been authorized, or if the calculator is
not associated with a rule.
CTV_NAME
VarChar2(255)
The name of the field that the test value applies to:
SELECTED_YEAR
SELECTED_EMPLOYEE
SELECTED_PLAN
SELECTED_TRANSACTION
SELECTED_PERIOD
SELECTED_QUARTER
CTV_TYPE
Number(11,0)
The type of test value:
0 - Year
1 - Employee
2 - Plan
3 - Transaction
4 - Field
5 - Prompt
6 - Period
7 - Quarter
8 - Function Input
CTV_PERIOD
Number(11,0)
The financial period if any that the value applies to.
CTV_VALUE
VarChar2(255)
The test value.
CTV_PROMPT
VarChar2(255)
Only used if the calculator contains ASK functions. Contains the values
of any ASK values that have been entered.
Primary key
CTV_ID
122
3
CALCULATORS
Foreign keys
CTV_CALC_ID = CALCULATORS.CALC_ID
CTV_USER_ID = USERS.USR_ID
CALCULATORS
This table stores definitions of all calculators including table calculators. Each
record represents a calculator.
Table columns
Column name
Data type
Description
CALC_ID
Number(11,0)
The internally generated unique ID for the calculator.
CALC_CODE
VarChar2(50)
No longer used.
CALC_NAME
VarChar2(75)
The name of the calculator.
CALC_TYPE
Number(11,0)
The calculator type.
1 - Event
2 - Summary
3 - Table
4 - Function
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
CALC_FREQ
Number(11,0)
The frequency setting for the calculator.
1 - Annual
2 - Quarterly
3 - By Period
CALC_AUTO_
ACCUMULATE
Number(1)
No longer used.
CALC_DESCRIPTION
VarChar2(2000)
The descriptive text specified against the calculator.
CALC_CELL_SIZE
Number(11,0)
The size of the cells to display when editing the calculator.
CALC_GROUP_
OPTIMISE
Number(1)
No longer used.
CALC_PRIORITY
Number(11,0)
The priority of a summary calculator.
1 - High
2 - Medium
3 - Low
CALC_INPUT_
COLUMNS
Number(11,0)
The number of input columns to use for rendering ASK values.
NUM_ROWS
Number(11,0)
The number of rows currently in use by the calculator.
NUM_COLS
Number(11,0)
The number of columns currently in use by the calculator.
CALC_REF
VarChar2(50)
The calling reference for a table or function calculator.
CALC_ROW_RANGE
Number(1)
No longer used.
123
3
CLAWBACK_BANDS
Column name
Data type
Description
CALC_COL_RANGE
Number(1)
Used during table calculator validation of a column.
CALC_GROUP
VarChar2(75)
The group to which the calculator belongs.
CALC_NUM_
DIMENSIONS
Number(11,0)
The number of dimensions if the calculator is of type TABLE.
CALC_DIM_RANGE_1
to
CALC_DIM_RANGE_10
Number(1)
Used during table calculator validation of a dimension.
CALC_FORCE_RECALC
Number(1)
A flag to indicate whether payees are to be automatically recalculated
when this calculator changes (-1) or not (0).
CALC_RECALC_MODE
Number(11,0)
No longer used.
CALC_SECURITY_
VALUE
VarChar2(100)
Used to restrict access to a calculator. A user can then only access the
calculator if the user data access restrictions allow the user to see
payees that have this value. For more information on restricting
access to calculators, see the System Administration Guide.
USE_HINTS
Number(1)
No longer used.
CALC_HINT
VarChar2(50)
No longer used.
REQUIRE_HINT
VarChar2(50)
No longer used.
CALC_REPORT_
SOURCE
Number(1)
Flag to indicate whether the calculator should be used as a report
source:
-1 - Use as a report source. The system creates appropriate views
during the Initialize Reports job enabling reports to be run for this
calculator. For information on this job, see “Job type 100 - Initialize
reports” in the System Administration Guide.
Primary key
CALC_ID
Foreign keys
None.
CLAWBACK_BANDS
This table contains the band records associated with clawback templates. Each
record represents a band value within a clawback template.
Table columns
Column name
Data type
Description
CB_ID
Number(11,0)
The ID of the clawback.
CB_SEQ
Number(11,0)
The sequence number of the band.
CB_UP_TO
Number(20,8)
The upper limit of the band, if not the over band.
CB_PCNT
Number(20,8)
The percentage to clawback against this band.
124
3
CLAWBACKS
Column name
Data type
Description
CB_PRO_RATE
Number(1)
Flag indicating whether the amount to clawback should be prorated.
CB_OVER
Number(1)
Flag indicating whether this band represents the over value band.
Primary key
CB_ID + CB_SEQ
Foreign keys
None.
CLAWBACKS
This table contains all clawback templates. Each record represents a clawback
template.
Table columns
Column name
Data type
Description
CB_ID
Number(11,0)
The internally generated ID for the clawback.
CB_CODE
VarChar2(30)
The clawback code.
CB_NAME
VarChar2(75)
The name of the clawback.
CB_TRN_TYPE
VarChar2(50)
The type of event to use as a clawback trigger.
CB_TRN_MATCH
VarChar2(30)
The first event field to use as a match field.
CB_TRN_MATCH_2
VarChar2(30)
The second event field to use as a match field.
CB_TIMESCALE
Number(11,0)
The units of measurement of the bands.
CB_EFFECTIVE_DATE
Date
The effective date of the clawback.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
CB_PERFORMANCE
Number(1)
Flag indicating whether this clawback should operate on performance
figures rather than pay.
CB_TYPE
Number(11,0)
The type of clawback:
0 - Payment
1 - Performance at Date
2 - Performance at Source
CB_TRN_MATCH_3
VarChar2(30)
The third event field to use as a match field.
CB_TRN_MATCH_4
VarChar2(30)
The fourth event field to use as a match field.
Primary key
CB_ID
125
3
CLEAN_AT_CALC_JOB_ID
Foreign keys
CB_FOLLOW_WITH = CLAWBACKS.CB_ID
CLEAN_AT_CALC_JOB_ID
This table is an internal table used by NICE ICM to determine the old records
should be removed from the ASSIGNED_TRANS view. It contains a record for
each result in ASSIGNED_TRANS that indicate the latest calculation job that
generated the result.
When NICE ICM runs a calculation job, it initially writes the results as new
records to the view in addition to the existing results records. A separate Remove
and archive dirty data job (job type 139) is run as part of each ICM server cycle
to remove old results that have been superseded. This job uses
CLEAN_AT_CALC_JOB_ID to determine which records to retain. For more on
server jobs, see the System Administration Guide.
Table columns
Column name
Data type
Description
AT_EMP_ID
Number(11,0)
The ID of the payee in the ASSIGNED_TRANS record.
PLN_ID
Number(11,0)
The ID of the plan in the ASSIGNED_TRANS record
FP_PERIOD_SEQ
Number(11,0)
The ID of the financial period in the ASSIGNED_TRANS record
FIN_YEAR_ID
Number(11,0)
The ID of the financial year in the ASSIGNED_TRANS record
AT_CALC_JOB_ID
Number(24,0)
The ID of the latest calculation job that created the ASSIGNED_TRANS
record.
Primary key
AT_EMP_ID + PLN_ID + FP_PERIOD_SEQ + FIN_YEAR_ID
Foreign key
AT_EMP_ID = EMPLOYEES.EMP_ID
FP_PERIOD_SEQ,FIN_YEAR_ID = FIN_PERIODS.FP_PERIOD_SEQ,FIN_YEAR_ID
126
3
COMPILED_QUERY
COMPILED_QUERY
This table contains compiled queries. These are coded representations of the
plan filters defined against all active plans, summarized to a distinct level. The
CQ_ID is then stored on the plan to maintain the relationship. The table is
populated every time a new plan query is entered into the system that does not
already exist, in which case a new entry will be generated in the table. The server
process regularly purges this table of any unused compiled queries.
The compiled queries are used by the event optimizer to quickly identify which
plans are affected by a new or changed event.
Table columns
Column name
Data type
Description
CQ_ID
Number(11,0)
The internally generated unique ID of the compiled query.
CQ_TEXT
VarChar2(2000)
The compiled query representation.
SOURCE_TYPE
Number(11,0)
The source of the associated plan filter:
0 - Events
1 - Manual
2 - Payee Results
3 - Plan Results
4 - Single Plan
Primary key
CQ_ID
Foreign keys
None.
CONTACTS
This table contains details about contacts associated with payees. Each record
represents a contact and they are populated through the user interface of via
data ports.
Table columns
Column name
Data type
Description
CONTACT_ID
Number(11,0)
The internally generated unique ID of the contact.
127
3
CONTACTS
Column name
Data type
Description
EMP_ID
Number(11,0)
The ID of the payee to which the contact belongs.
CONTACT_NAME
VarChar2(75)
The contact name.
CONTACT_TYPE
VarChar2(40)
The type of contact.
CONTACT_TEL
VarChar2(20)
The main contact telephone number.
CONTACT_MOB
VarChar2(20)
The contact mobile phone number.
CONTACT_EMAIL
VarChar2(50)
The email address of the contact.
CONTACT_ADD_1 to
CONTACT_ADD_3
VarChar2(50)
The contact address line 1 to 3.
CONTACT_POST_CODE
VarChar2(20
The contact post code.
CONTACT_COUNTRY
VarChar2(40)
The contact country.
CONTACT_CODE
VarChar2(20)
The contact identifying code.
CONTACT_ACCOUNT
VarChar2(30)
The user account name of the contact, if any.
CONTACT_PASSWORD
VarChar2(250)
The encrypted contact account password, if any. Only used when
migrating contacts from NICE ICM version 3.2. When a migrated
contact logs in to NICE ICM for the first time, the contact must
reset the password and this field is not used for subsequent log ins.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
CONTACT_LAST_ACCESS
Date
The date and time at which the contact last access the application.
CONTACT_TERMINATED
Date
The date that the contact was terminated.
CONTACT_ADD_4
VarChar2(50)
The contact address line 4.
CONTACT_FAX
VarChar2(20)
The fax number of the contact.
CONTACT_PROFILE_1 to
CONTACT_PROFILE_5
VarChar2(50)
The first to fifth contact custom profile field, if any.
CONTACT_STARTED
Date
The date that the contact became active.
CONTACT_CREATED
Date
The date and time at which the contact record was created.
CONTACT_CREATED_BY
Number(11,0)
The ID of the user who created the contact.
ENTITY_ID
VarChar2(4000)
The unique reference ID for this contact.
SYNC_DATE
Date
The date and time this record was last synchronized.
MOBILE_ACCESS
Number(11,0)
Flag indicating whether this contact is able to access the mobile
SCA application.
SYNC_STATUS_CODE
VarChar2(255)
A code indicating the result of the synchronization:
Possible codes are:
SUCCESS
NOT_FOUND
DUPLICATE_FOUND
BAD_DATA
INTERNAL_ERROR
A value of null indicates synchronization has not yet started for the
contact.
SYNC_STATUS_INFO
VarChar2(4000)
Details of the synchronization result. For example, an error
description if the synchronization failed.
128
3
CONTENT_ITEMS
Primary key
CONTACT_ID
Foreign keys
CONTENT_ITEMS
This table contains details of items that have been uploaded to the ICM
database. An example is graphic files used by the process manager feature.
Table columns
Column name
Data type
Description
ID
Number(11,0)
A unique system generated identifier for the item.
NAME
VarChar2(255)
The file name of the item that has been uploaded.
DATA
Blob
The content of the uploaded item.
TYPE
VarChar2(255)
The MIME type of the uploaded item. For example: image/jpeg.
Primary key
None.
Foreign keys
None.
CONVERSION_LIST_HEADER
This table contains converters. Each record represents a converter. The table is
populated through the user interface.
Table columns
Column name
Data type
Description
CNV_LST_HDR_ID
Number(11,0)
The internally generated unique ID for the converter.
CNV_LST_HDR_NAME
VarChar2(50)
The name of the converter.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
129
3
Column name
Data type
Description
CNV_CASE
Number(11,0)
The type of case conversion to apply:
1 - Upper
2 - Lower
3 - Mixed
CNV_MATH_TYPE
Number(11,0)
The type of mathematical expression to apply, if any:
1 - Plus
2 - Minus
3 - Multiply
4 - Divide
CNV_MATH_VALUE
Number(20,8)
The number to apply to the mathematical expression, if any.
CNV_REMOVE_ZEROS
Number(1)
A flag indicating whether the converter should remove leading zeros.
CNV_CLEAN_NUMBER
Number(1)
Flag indicating whether the converter should attempt to clean up
number formats.
CNV_FORMAT
VarChar2(255)
The custom formatter used by the converter, if any.
CNV_PAD
Number(11,0)
The padding type, if any:
1 - Left
2 - Right
CNV_PAD_WITH
VarChar2(10)
The characters to use as padding, if any.
CNV_PAD_LENGTH
Number(11,0)
The number of characters to pad to, if any.
CNV_NO_BLANKS
Number(1)
Flag indicating whether the converter should cause the record to be
skipped if the value is blank.
CNV_REP_ID
Number(11,0)
The ID of any source of data report to be used as a conversion list.
CNV_REP_PASS
Number
Flag indicating whether a source of data report list should pass
unmatched values through unchanged.
Primary key
CNV_LST_HDR_ID
Foreign keys
CNV_REP_ID = DRN_REPORTS.REPORT_ID
This table contains the items in a conversion list associated with a converter, if
present. Each record represents a line in the conversion list. It can be populated
through the user interface, or loaded through data ports.
130
3
COPY_PLANS
Table columns
Column name
Data type
Description
CNV_LST_HDR_ID
Number(11,0)
The ID of the converter to which this item belongs.
CNV_LST_FROM
VarChar2(50)
The incoming or from value of the list item.
CNV_LST_TO
VarChar2(50)
The outgoing or to value of the list item.
CNV_LST_ITEM_SEQ
Number(11,0)
The sequence in the list of the list item.
Primary key
CNV_LST_HDR_ID + CNV_LST_ITEM_SEQ
Foreign keys
CNV_LST_HDR_ID = CONVERSION_LIST_HEADER.CNV_LST_HDR_ID
COPY_PLANS
This table is used by the Copy Plans command on the Maintenance menu to store
the plan copy settings when as user submits a copy job. Each record represents
the last copy plans job submitted by each user.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the submitting user.
CP_YEAR_FROM
Number(11,0)
The ID of the year to copy plans from.
CP_YEAR_TO
Number(11,0)
The ID of the year to copy plans to.
CP_PLAN_BONUSES
Number(1)
Flag indicating whether plan additions should be copied.
CP_EMPLOYEES_
BONUSES
Number(1)
No longer used.
CP_DRAW
Number(1)
No longer used.
CP_HOLD_STATUS
Number(11,0)
No longer used.
CP_OVERWRITE
Number(11,0)
No longer used.
NUMBER_EMPLOYEES
Number(11,0)
No longer used.
CP_COPY_MODE
Number(11,0)
The copy mode:
1 - New Financial Year
CP_EMP_ID
Number(11,0)
No longer used.
CP_COPY_SALARY
Number(1)
No longer used.
CP_COPY_INCENTIVE
Number(1)
No longer used.
CP_COPY_PLANS
Number(1)
No longer used.
131
3
Column name
Data type
Description
CP_SELECTED_PLANS
VarChar2(255)
A list of plan IDs to copy from, if any.
CP_TEMPLATE_STATUS
Number(11,0)
Indicator as to the plan template status
1 - Preserve
2 - Set Active
3 - Set Inactive
CP_PLN_HOLD_
STATUS
Number(11,0)
A flag indicating the plan level hold status copy requirement:
1 - Carry Forward
2 - Yes
3 - No
Primary key
USR_ID
Foreign keys
CP_EMP_ID = EMPLOYEES.EMP_ID
CP_YEAR_FROM = FIN_YEARS.FIN_YEAR_ID
CP_YEAR_TO = FIN_YEARS.FIN_YEAR_ID
This table contains the values, defined as either a weighting or a percentage, by
which a corporate target can be cascaded to a lower level.
Table columns
Column name
Data type
Description
CT_ID
Number(11,0)
The ID of the corporate target.
PLN_TEMPLATE_ID
Number(11,0)
The ID of the plan template to which the cascade refers.
CASCADE_SEQUENCE
Number(11,0)
The ID of the cascade.
TIME_SEQUENCE
Number(11,0)
The ID of the period or quarter that the cascade refers to.
FIN_YEAR_ID
Number(11,0)
The ID of the financial year to which cascade refers to.
CT_FIELD_VALUE
VarChar2(50)
The value of the field from which the value for the cascade should be
determined.
CT_VALUE
Number(15,2)
The value of the actual weighting or the percentage. A value of 100
indicates 100%.
Set to 1 if the corporate target is set by year.
Primary key
CT_ID + PLN_TEMPLATE_ID + CASCADE_SEQUENCE + TIME_SEQUENCE +
FIN_YEAR_ID + CT_FIELD_VALUE
132
3
Foreign keys
CT_ID = CORPORATE_TARGETS.CT_ID
PLN_TEMPLATE_ID = PLANS.PLN_ID
FIN_YEAR_ID = FIN_YEARS.FIN_YEAR_ID
This table contains information about how a corporate target that has been
assigned to a plan is cascaded down to a lower level.
Table columns
Column name
Data type
Description
CT_ID
Number(11,0)
PLN_TEMPLATE_ID
Number(11,0)
The ID of the plan template to which the cascade refers.
SEQUENCE
Number(11,0)
A sequence number of the cascade, starting at 0.
CT_PROPORTION_
TYPE
Number(11,0)
Specifies the proportion type:
1 - the proportion type is specify %
2 - the proportion type is import % value
3 - the proportion type is specify weighting
4 - the proportion type is import weighting
CT_SET_BY
VarChar2(50)
The name of the field by which the corporate target is set.
Primary key
CT_ID + PLN_TEMPLATE_ID + SEQUENCE
Foreign keys
CORP_TARGET_PLANS
This table contains information about which plan templates use a corporate
target.
Table columns
Column name
Data type
Description
CT_ID
Number(11,0)
133
3
CORP_TARGET_VALUES
Column name
Data type
Description
PLN_TEMPLATE_ID
Number(11,0)
The plan template ID that is using this corporate target.
CT_ASSIGNMENT
Number(15,2)
The proportion of a target that is assigned to this plan template. A value of
100 indicates100%.
Primary key
CT_ID + PLN_TEMPLATE_ID
Foreign keys
CORP_TARGET_VALUES
This table contains the actual values stored against the corporate target
definitions set up in ICM Admin.
Table columns
Column name
Data type
Description
CT_ID
Number(11,0)
SEQUENCE
Number(11,0)
A sequence number of the target, this corresponds to the period/quarter number,
or 1 for annual in the CORPORATE_TARGETS table.
FIN_YEAR_ID
Number(11,0)
The ID of the financial year of the corporate target.
TRGT_VALUE
Number(15,2)
The actual corporate target value.
Primary key
CT_ID + SEQUENCE + FIN_YEAR_ID
Foreign keys
134
3
CORP_TARGETS
CORP_TARGETS
This table contains the basic information for the corporate target definitions set
up in ICM Admin.
Table columns
Column name
Data type
Description
CT_ID
Number(11,0)
CT_NAME
VarChar2(50)
The name of the corporate target.
CT_GROUP
VarChar2(50)
The group of the corporate target.
CT_FREQ
Number(11,0)
The frequency code for the corporate target
1 - annual
2 - quarter
3- period
CUR_ID
Number(11,0)
The currency of the corporate target. If set to -1 then this is a volume
based corporate target.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
CT_SUM_ID
Number(11,0)
The ID of the value definition to use for this target.
CT_PRO_RATE
Number(1)
If set to true, then the corporate target is set to be pro-rated.
Primary key
CT_ID
Foreign keys
CT_VRN_HDR_ID = VARIATION_HEADERS.VRN_HDR_ID
CT_CUR_ID = CUR_ID.CURRENCIES (if CUR_ID > 0)
CT_SUM_ID = TRAN_SUMS.SUM_ID
CUBE_ ...
Tables beginning CUBE_ are legacy tables used in earlier versions of NICE ICM.
The tables were used to hold temporary information during report generation.
The tables are no longer used.
135
3
CURRENCIES
CURRENCIES
This table contains currency records. Each record represents an available
currency. It can be populated through the user interface of via data ports.
Table columns
Column name
Data type
Description
CUR_ID
Number(11,0)
The internally generated unique ID for the currency.
CUR_CODE
VarChar2(50)
The currency code.
CUR_NAME
VarChar2(50)
The full name of the currency.
CUR_DEFAULT
Number(1)
Flag indicating whether this is the default currency.
CUR_SYNCH
Date
Used by data ports for synchronizing the currency table.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
CUR_NI
Number(1)
No longer used.
Primary key
CUR_ID
Foreign keys
None.
CURRENT_ASSIGNED_TRANSn
These tables are shard tables used by the ASSIGNED_TRANS view.
NICE ICM attempts to share the records for the current year across the shard
tables. The Move data to history tables job (job type 136) runs when a financial
period is closed to move any records older than the current year to the
ASSIGNED_TRANS_HISTORY table.
Table columns
This table has the same columns as the ASSIGNED_TRANS_HISTORY table.
Column name
Data type
Description
TRN_ID
Number(11,0)
PLN_ID
Number(11,0)
The ID of the plan.
COMM_VALUE
Number(32,15)
The commissionable value of the event against the plan, in base
currency.
COMM_PCNT
Number(20,8)
No longer used.
136
3
CURRENT_ASSIGNED_TRANSn
Column name
Data type
Description
COMM_ORDER_VALUE
Number(32,15)
No longer used.
COMM_PARTNER_VALUE
Number(32,15)
No longer used.
COMMISSION_PAID
Number(32,15)
The amount of commission earned against the event in payment
currency.
COMM_QTY
Number(15,2)
The commissionable quantity of the event against the plan.
COMM_VALUE_TARGET
Number(32,15)
The commissionable value of the event against the plan, in target
currency.
COMMISSION_PAID_BASE
Number(32,15)
The amount of commission earned against the event in base
currency.
DATA_SET
Number(11,0)
The ID of the event data set. Normally only one data set is used
which has an ID of 1.
SPIF_ID
Number(11,0)
The ID of any unique SPIF associated with the event and plan.
AT_RRP
Number(32,15)
The price list RRP, if any.
AT_SELL_PRICE
Number(32,15)
The price list sell price, if any.
AT_BUY_PRICE
Number(32,15)
The price list buy price, if any.
AT_VAT_RATE
Number(20,8)
The tax rate, if any.
AT_CLAWED_BACK
Number(32,15)
The amount retrieved from a clawback, if any.
AT_ORIGINAL_VALUE
Number(32,15)
The original event value.
AT_ORIGINAL_VALUE_
TARGET
Number(32,15)
The original event value in plan target currency.
AT_ORIGINAL_QTY
Number(11,0)
The original quantity of the event against the plan.
AT_JOB_ID
Number(11,0)
The ID of the job that last loaded or updated this event in the
TRANSACTIONS table.
AT_EMP_ID
Number(11,0)
The ID of the payee that has been assigned to this event.
AT_PG_ID
Number(11,0)
The ID of the associated plan group.
CB_DATE
Date
The clawback date, if any.
CB_ID
Number(11,0)
The ID of the clawback record, if any.
CB_FROM_DATE
Date
The date clawed back from, if any.
CB_TRN_ID
Number(11,0)
The ID of the original clawback event, if any.
AT_ACTUAL_PAID
Number(32,15)
No longer used.
AT_BALANCE
Number(32,15)
No longer used.
AT_DATE
Date
The date from the event record that has been selected as the
effective date. Usually this date is TRN_ORDER_DATE but could
also be TRN_REFERENCE_DATE.
AT_PA_ID
Number(11,0)
RETURN_TRANSCALC_1 to
RETURN_TRANSCALC_15
Number(15,2)
A custom defined event results field, if used.
AT_CALC_JOB_ID
Number(11,0)
The ID of the server job that calculated this event and created
this record in ASSIGNED_TRANS.
RETURN_TRANSTEXT_1 to
RETURN_TRANSTEXT_5
VarChar2(50)
Returns the text of an event.
COMMISSION_RATE
Number(20,8)
No longer used.
137
3
CURRENT_LEDGER_PLAN_ARCHIVEn
Primary key
TRN_ID + PLN_ID + AT_PA_ID + AT_CALC_JOB_ID
Foreign key
CURRENT_LEDGER_PLAN_ARCHIVEn
These tables are shard tables used by the LEDGER_PLAN_ARCHIVE view.
LEDGER_PLAN_ARCHIVE_HISTORY table.
Table columns
Column name
Data type
Description
EMP_ID
Number(24,0)
The ID of the payee associated with the ledger posting.
PLN_ID
Number(24,0)
The ID of the plan associated with the ledger posting.
LEG_DATE
Date
The effective date of the event. This date is not when the ledger made
the entry. If there is no associated event, the date is the end of the
financial period.
LEG_TYPE
VarChar2(50)
LEG_VALUE_TYPE
Number(24,0)
The type of ledger posting. Possible values include:
•
For debit postings: Draw, Earnings, Adjustment, Rejection
(payment made then removed).
•
For credit postings: Payment.
•
Temporarily used within a transaction: Pending.
The value type of the ledger posting:
1 - Debit
2 - Credit
3 - Pending
REJ_ID
Number(24,0)
The ID of the rejection associated with the ledger posting, if any.
LEG_POSTED
Date
The date this entry was written to the original
CURRENT_LEDGER_PLANn table.
LEG_DESCRIPTION
VarChar2(255)
The description of the ledger posting.
LEG_VALUE
Number(32,15)
The value of the ledger posting.
PB_ID
Number(24,0)
The ID of the payment batch associated with the ledger posting, if any.
LEG_VALUE_BASE
Number(32,15,
The effective value of the ledger posting in base currency.
138
3
CURRENT_LEDGER_PLANn
Column name
Data type
Description
LEG_CUR_ID
Number(24,0)
LEG_JOB_ID
Number(24,0)
The ID of the server job that created this ledger entry.
LEG_ARCHIVED
Date
The date this entry was archived.
IS_PA_ENTRY
Number(24,0)
Flag indicating whether this entry relates to one or more payment
adjustments.
IS_DRAW_ENTRY
Number(24,0)
Flag indicating whether this entry relates to one or more draws.
Primary key
EMP_ID + PLN_ID + LEG_DATE + LEG_TYPE + LEG_VALUE_TYPE + LEG_ARCHIVED +
LEG_JOB_ID
Foreign key
LEG_CUR_ID = CURRENCIES.CUR_ID
LEG_JOB_ID = JOBS.JOB_ID
CURRENT_LEDGER_PLANn
These tables are shard tables used by the LEDGER_PLAN view.
LEDGER_PLAN_HISTORY table.
Table columns
Column name
Data type
Description
EMP_ID
Number(24,0)
PLN_ID
Number(24,0)
LEG_DATE
Date
financial period.
LEG_TYPE
VarChar2(50)
•
•
•
139
3
CURRENT_LEDGER_TRAN_ARCHIVEn
Column name
Data type
Description
LEG_VALUE_TYPE
Number(24,0)
1 - Debit
2 - Credit
3 - Pending
REJ_ID
Number(24,0)
LEG_POSTED
Date
The date the entry was written to the ledger.
LEG_DESCRIPTION
VarChar2(255)
LEG_VALUE
Number(32,15)
PB_ID
Number(24,0)
LEG_VALUE_BASE
Number(32,15,
LEG_CUR_ID
Number(24,0)
LEG_JOB_ID
Number(24,0)
IS_PA_ENTRY
Number(24,0)
adjustments.
IS_DRAW_ENTRY
Number(24,0)
Primary key
EMP_ID + PLN_ID + LEG_DATE + LEG_TYPE + LEG_VALUE_TYPE + LEG_JOB_ID
Foreign key
CURRENT_LEDGER_TRAN_ARCHIVEn
These tables are shard tables used by the LEDGER_TRAN_ARCHIVE view.
LEDGER_TRAN_ARCHIVE_HISTORY table.
Table columns
Column name
Data type
Description
EMP_ID
Number(24,0)
PLN_ID
Number(24,0)
140
3
CURRENT_LEDGER_TRANn
Column name
Data type
Description
TRN_ID
Number(24,0)
The ID of the event associated with the ledger posting.
LEG_DATE
Date
financial period.
LEG_TYPE
VarChar2(50)
LEG_VALUE_TYPE
Number(24,0)
•
•
•
1 - Debit
2 - Credit
3 - Pending
REJ_ID
Number(24,0)
LEG_POSTED
Date
The date the entry was originally written to
CURRENT_LEDGER_TRANn.
LEG_DESCRIPTION
VarChar2(255)
LEG_VALUE
Number(32,15)
PB_ID
Number(24,0)
The ID of the payment batch associated with the ledger posting, if
any.
LEG_VALUE_BASE
Number(32,15,
LEG_CUR_ID
Number(24,0)
LEG_JOB_ID
Number(24,0)
LEG_ARCHIVED
Date
IS_PA_ENTRY
Number(24,0)
adjustments.
IS_DRAW_ENTRY
Number(24,0)
Primary key
EMP_ID + PLN_ID + TRN_ID + LEG_DATE + LEG_TYPE + LEG_VALUE_TYPE +
LEG_ARCHIVED + LEG_JOB_ID
Foreign key
These tables are shard tables used by the LEDGER_TRAN view.
141
3
LEDGER_TRAN_HISTORY table.
Table columns
Column name
Data type
Description
EMP_ID
Number(24,0)
PLN_ID
Number(24,0)
TRN_ID
Number(24,0)
LEG_DATE
Date
financial period.
LEG_TYPE
VarChar2(50)
LEG_DESCRIPTION
VarChar2(255)
•
•
•
LEG_VALUE
Number(32,15)
PB_ID
Number(24,0)
LEG_VALUE_TYPE
Number(24,0)
1 - Debit
2 - Credit
3 - Pending
PA_ID
Number(24,0)
ID of the payment adjustment if any applied to this event.
LEG_POSTED
Date
The date the entry was written to the ledger.
LEG_VALUE_BASE
Number(32,15)
DRAW_ID
Number(24,0)
The ID of the draw associated with the ledger entry, if any.
LEG_CUR_ID
Number(24,0)
REJ_ID
Number(24,0)
LEG_JOB_ID
Number(24,0)
Primary key
LEG_JOB_ID
Foreign key
EMP_ID
PLN_ID
TRN_ID
REJ_ID
=
=
=
=
EMPLOYEES.EMP_ID
PLANS.PLN_ID
TRANSACTIONS.TRN_ID
REJECTIONS.REJ_ID
142
3
CUSTOMERS
CUSTOMERS
This table contains customer reference data. Each record represents a customer
for a period defined by the start and end dates.It can be populated through the
user interface or via data ports.
Table columns
Column name
Data type
Description
CUSTOMER_ID
Number(11,0)
The internally generated unique identifier for the customer.
CUSTOMER_NAME
VarChar2(50)
The name of the customer.
CUSTOMER_GROUP
VarChar2(50)
The customer group.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
ADDRESS_1
VarChar2(75)
The customer address line 1.
ADDRESS_2
VarChar2(75)
ADDRESS_3
VarChar2(75)
TOWN
VarChar2(50)
The customer town.
REGION
VarChar2(50)
The customer region.
POSTAL_CODE
VarChar2(20)
The customer post code.
COUNTRY
VarChar2(50)
The customer country.
CUST_SYNCH
Date
Used by data ports to synchronize the customer table.
CUSTOMER_CODE
VarChar2(50)
The customer code.
CUST_START_DATE
Date
The start date of the customer data records.
CUST_END_DATE
Date
The end date of the customer data records.
Primary key
CUSTOMER_ID
Foreign keys
CUST_YEAR + CUST_PERIOD = FIN_PERIODS.[FIN_YEAR_ID + FP_PERIOD_SEQ]
143
3
This table contains settings associated with data ports. Each record represents a
data port parameter and its associated value.
Table columns
Column name
Data type
Description
DS_ID
Number(11,0)
The ID of the data port.
SETTING_PARAMETER
VarChar2(50)
The data port parameter name.
SETTING_VALUE
VarChar2(255)
The data port parameter value.
Primary key
DS_ID + SETTING_PARAMETER
Foreign keys
DS_ID = DATA_SOURCES.DS_ID
DATA_SOURCES
This table contains the data ports. Each record represents a data port definition.
Table columns
Column name
Data type
Description
DS_ID
Number(11,0)
The internally generated ID for the data port.
DS_NAME
VarChar2(50)
The name of the data port.
DS_ODBC_DSN
VarChar2(50)
The name of the input data source connection.
DS_TABLE_VIEW
VarChar2(128)
The name of the table or view in the source data that the data port
will read from.
DS_FILE
VarChar2(255)
The name of the file that the data port will load, if any.
DS_LAST_FILE_DATE
Date
The date and time stamp of the last file loaded by the data port.
DS_USER
VarChar2(250)
No longer used.
DS_PASSWORD
VarChar2(250)
No longer used.
DS_TRN_CURRENT
Number(1)
Flag indicating whether events should be loaded into the current
system period.
FIN_YEAR_ID
Number(11,0)
The ID of the year associated with the data port, if any.
FP_PERIOD_SEQ
Number(11,0)
The ID of the period associated with the data port, if any.
DS_AUTO_FREQ
VarChar2(10)
The frequency at which the data port should execute automatically,
if any.
144
3
DATA_SOURCES
Column name
Data type
Description
DS_AUTO_TW_START
VarChar2(5)
The start point, in 24 clock, of the time window, if any.
DS_AUTO_TW_DURATION
Number(11,0)
The duration, in hours, of the time window, if any.
DS_AUTO_FIRST_DATE
Date
No longer used.
DS_AUTO_FORCE
VarChar2(50)
No longer used.
DS_AUTO_ATTEMPTS
Number(11,0)
Counter for the number of execution attempts made in the last
run.
DS_AUTO_LAST_RUN
Date
The date and time at which the data port was last executed
automatically.
DS_MANDATORY
Number(1)
No longer used.
DS_SYSFUNCT
Number(11,0)
The type of data that the data port is loading.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
DS_ACCESS_MODE
Number(11,0)
Indicator for the data port access mode:
0 - Manual
2 - Auto
DS_PROCESSOR
VarChar2(50)
The class name of the custom pre processor to use, if any.
DS_UPDATE_ONLY
Number(1)
Flag indicating whether the data port should only update existing
records.
DS_MATCH_FIELD
VarChar2(30)
The field to use to match payee records in payee data ports.
DS_TRUNCATE
Number(1)
No longer used.
DS_FOLLOW_WITH
Number(11,0)
The ID of a data port that should automatically follow this one on
success, if any.
DS_DATA_SET
Number(11,0)
The data set into which events will be loaded.
DS_LOAD_DELETED
Number(1)
Flag indicating whether a payee data port should load payees that
have previously been deleted.
DS_FILE_ARCHIVE
Number(11,0)
Indication as to how the file should be archived, if any:
1 - Leave
2 - Archive
3 - Delete
NUM_EMPLOYEES
Number(11,0)
Events data port only: the number of payees who have been
assigned to this data port.
DS_SS_NUMBER
Number(11,0)
The number of the sales structure to load hierarchy data into.
DS_YTD_SOURCE
Number(1)
Flag indicating whether incoming event data is in YTD format.
DS_REMOVE_INDEXES
Number(1)
No longer used.
DS_APPEND_DATA
Number(1)
Events only. Flag indicating whether records should be appended
to existing records.
DS_SYNCHRONISE
Number(1)
Flag indicating whether this data port should synchronize data.
DS_POST_PROCESSOR
VarChar2(50)
No longer used.
DS_USE_PENDING
Number(1)
Flag indicating whether events should be loaded into the pending
table.
DS_PROCESSOR_OPTIONS
VarChar2(255)
No longer used.
DS_POST_PROCESSOR_
OPTIONS
VarChar2(255)
No longer used.
145
3
DATA_SOURCES
Column name
Data type
Description
DS_DUP_DATA
Number(1)
The mode for handling duplicate events:
0 - None
1 - Ignore
2 - Abort
3 - YTD
4 - Process
DS_TRANSFORM_WITH
VarChar2(50)
The name of an XSLT file used to transform incoming XML data, if
any.
DS_HOLDING
Number(1)
Flag indicating whether the data port should be interactive.
DS_HOLDING_UNIQUE
VarChar2(50)
Interactive data port: the fields that represent the primary key of
the input data.
DS_HOLDING_STATUS
VarChar2(50)
Interactive data port: the field in the input data to contain the
status value.
DS_HOLDING_
DESCRIPTION
VarChar2(50)
Interactive data port: the field in the input data to contain the error
message if any resulting from the running the data port.
DS_HOLDING_PENDING
VarChar2(50)
Interactive data port: the value in the status field that indicates that
a record is ready to be loaded.
DS_HOLDING_SUCCESS
VarChar2(50)
Interactive data port: the value to assign to the status field on
successful load.
DS_HOLDING_FAILURE
VarChar2(50)
Interactive data port: the value to assign to the status field on a load
failure.
DS_HOLDING_LIST
VarChar2(255)
List of incoming fields to display in the data failures screen for
interactive data ports.
DS_IGNORE
Number(1)
Flag indicating whether unmatched payees should be ignored in a
payee related data port.
DS_FILTER
VarChar2(255)
A filter clause for the incoming data, if any.
DS_DLIMITER
VarChar2(20)
Delimited text file source only: the character used to separate field
values.
DS_QUALIFIER
VarChar2(20)
Delimited text file source only: the character used to delimit textual
field values.
DS_GROUP
VarChar2(50)
The group to which the data port belongs.
DS_DATEFORMAT
VarChar2(50)
Delimited text file source only: the format of date field values.
-1 - Ignore unmatched payees
DS_PLAN_YEAR
Number(11,0)
The ID of the year into which plans should be loaded, if any.
DS_HOLDING_JOB_
NUMBER
VarChar2(255)
Interactive data port: the field in the input data to contain the
number of the server job used to run the data port.
DS_HOLDING_MAX_
RECORDS
Number(11,0)
Interactive data port only: the maximum number of records to load
per job.
DS_RULE
Number(11,0)
The ID of the authorization rule (if any) associated with the data
port.
DS_TRAN_LOAD
Number(11,0)
Used by a SQL data port to indicate that this data port loads events.
DS_IGNORE_FAILURE
Number(1)
Flag to indicate whether a chained data port should be run even if
this data port fails.
DS_WORKSHEET_NAME
VarChar2(255)
The name of the worksheet to load.
146
3
DATA_SOURCES
Column name
Data type
Description
DS_MERGE
Number(1)
Tables data port only. Flag to indicate whether the data port is to
handle an existing table calculator:
-1 - Merge the source data into the existing table calculator data
0 - Replace the table calculator data with the source data
DS_FAILURE_DS_ID
Number(11,0)
Interactive data port: the value to assign to the status field on a load
failure.
DS_THREAD
Number(11,0)
The name of the thread used to run the data port.
DS_HOLDING_IGNORE
VarChar2(50)
Interactive port only: the value of the status field that indicates that
the data port should ignore a record.
DS_CALC_MODEL_FLAG
Number(11,0)
Used by a calculation data port to indicate which model is to be
used for the calculation:
0 - Actual, live data
-1 - All models are used for the calculation
other number - The ID of the model to use
DS_CALC_DEPENDANTS
Number(1)
Flag indicating whether payees whose commission depends on the
payees selected are also included in the calculation:
-1 - Include payees
DS_DELETE_EVENTS
Number(11,0)
Flag indicating whether events which were loaded by this data port
are deleted when the data port is deleted. This flag is only set
transiently when a user chooses the command to delete an Events
data port and selects to delete the associated events
0 - Do not delete events
-1 - Delete events
Primary key
DS_ID
Foreign keys
FP_PERIOD_SEQ]
DS_RULE = AUTH_RULES.AUTH_ID
147
3
DATABASE_ERRORS
DATABASE_ERRORS
This table contains any customized error messages registered in the ICM
database. It can only be populated directly via SQL. Each record represents a
wrapper for an anticipated database error associated with saving or loading
data, and produces a friendly error message.
Table columns
Column name
Data type
Description
DBE_FIND
VarChar2(50)
The error character combination to search for.
DBE_TEXT
VarChar2(255)
The descriptive error text to display.
DBE_LANGUAGE_ID
VarChar2(10)
The ID of the language that this message represents.
Primary key
DBE_FIND + DBE_LANGUAGE_ID
Foreign keys
None.
DBMS_STATS_OBJECTTAB
This table is standard Oracle table and not part of the ICM schema.
DELETE_EMPLOYEES
This table performs a holding function for the submission of delete payees jobs,
the user ID being the context ID for the associated filter settings.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user submitting the delete payees request.
FIN_YEAR_ID
Number(11,0)
The ID of the year from which payees are to be deleted.
NUMBER_EMPLOYEES
Number(11,0)
The number of payees involved in the delete request.
Primary key
USR_ID
148
3
DELETE_PLANS
Foreign keys
FIN_YEAR_ID=FIN_YEARS.FIN_YEAR_ID
USR_ID=USERS.USR_ID
DELETE_PLANS
This table is no longer used.
DELETED_EMPLOYEES
This table stores summary details of all payees who have been deleted from the
ICM database via the application. It is used by payee data ports to determine
whether a payee that is being loaded has been deleted previously.
Table columns
Column name
Data type
Description
EMP_NAME
VarChar2(75)
The name of the deleted payee.
EMP_PAYROLL_ID
VarChar2(50)
The payroll ID of the deleted payee.
EMP_UD1 to EMP_UD6
VarChar2(75)
The value of custom field 1to 6 for the deleted payee.
EMP_DIVISION
VarChar2(75)
The division code of the deleted payee.
EMP_DEPT
VarChar2(75)
The department code of the deleted payee.
EMP_LOCATION
VarChar2(75)
The location code of the deleted payee.
EMP_UD7 to EMP_UD10
VarChar2(75)
The value of custom field 1to 6 for the deleted payee.
Primary key
None.
Foreign keys
None.
149
3
This table contains the contents of lists. Each record represents an item within a
list. It can be populated through the user interface or via data ports.
Table columns
Column name
Data type
Description
LIST_ID
Number(11,0)
The ID of the list.
LIST_VALUE_TEXT
VarChar2(100)
The text value of the list item.
LIST_VALUE_NUMBER
Number(20,8)
The numeric value of the list item, if any.
LIST_VALUE_DATE
Date
The date value of the list item, if any.
LIST_YEAR
Number(11,0)
The year of the list item (zero if not period sensitive).
LIST_PERIOD
Number(11,0)
The period of the list item (zero if not period sensitive).
CASCADEVAL
Number(1)
If set, then the list item is cascaded forward.
Primary key
LIST_ID + LIST_VALUE_TEXT + LIST_YEAR + LIST_PERIOD
Foreign keys
LIST_ID = DRN_CUSTOM_LISTS.LIST_ID
DRN_CUSTOM_LISTS
This table contains custom lists. Each record represents a list. It can be
populated through the user interface or via data ports.
Table columns
Column name
Data type
Description
LIST_ID
Number(11,0)
The internally generated unique ID of the list.
LIST_NAME
VarChar2(75)
The name of the list.
LIST_CREATED_BY
Number(11,0)
The ID of the user who created the list.
LIST_CREATED_DATE
Date
The date and time at which the list was created.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
LIST_COUNT
Number(11,0)
The number of items in the list.
LIST_PERIOD_SENSE
Number(1)
If set, it identifies the list as period sensitive.
150
3
DRN_FIELD_ALIAS
Primary key
LIST_ID
Foreign keys
None.
DRN_FIELD_ALIAS
This table contains the fields available in reporting sources for ICM reports.
Each record represents a field available in a reporting source. The table is
populated by the Initialize Reports server job.
Table columns
Column name
Data type
Description
SOURCE_ID
Number(11,0)
The ID of the reporting source.
SOURCE_FIELD_NAME
VarChar2(50)
The database name of the dictionary field.
SOURCE_FIELD_ALIAS
VarChar2(50)
The descriptive name of the dictionary field.
SOURCE_FIELD_FORMAT
VarChar2(150)
The formatting code of the dictionary field.
SOURCE_FIELD_USED
Number(1)
No longer used (always set to -1).
SOURCE_FIELD_DESCRIPTION
VarChar2(2000)
No longer used.
SOURCE_FIELD_GROUP
VarChar2(100)
The group to which the dictionary field belongs.
SOURCE_FIELD_PAYMENT
Number(1)
Flag indicating whether the field is payment related.
SOURCE_LANGUAGE_ID
VarChar2(10)
The ID of the language represented by this record.
Primary key
SOURCE_ID + SOURCE_LANGUAGE_ID + SOURCE_FIELD_NAME
Foreign keys
SOURCE_ID = DRN_SOURCES.SOURCE_ID
151
3
DRN_LOOKUP_ALIAS
DRN_LOOKUP_ALIAS
This table makes friendly versions on reporting source field values available to
the user for the purposes of look up lists. The table is populated by the Initialise
Reports server process.
Table columns
Column name
Data type
Description
FIELD_NAME
VarChar2(75)
The database name of the field to be aliased.
LOOKUP_TABLE
VarChar2(75)
The table or SQL expression from which to lookup.
LOOKUP_FIELD
VarChar2(75)
The field, or SQL expression, to use as the lookup value.
Primary key
FIELD_NAME
Foreign keys
None.
DRN_PIVOT_STATE
This table is used to store the current state of selected fields and filters on ICM
pivot reports. Each record represents a field and its associated type and status
against a pivot report and user. The table is populated automatically when the
state of a pivot report is changed.
Table columns
Column name
Data type
Description
REPORT_ID
Number(11,0)
The ID of the pivot report.
USR_ID
Number(11,0)
The ID of the executing user.
USR_EMPLOYEE
Number(1)
Flag indicating whether the executing user is a payee.
PIVOT_FIELD_TYPE
Number(11,0)
The use to which this record is put.
PIVOT_FIELD
VarChar2(255)
The name of the stored pivot field.
PIVOT_VALUE
VarChar2(255)
The value to use or the output type.
STATE_ID
Number(11,0)
A system generated unique ID for this record.
Primary key
STATE_ID
152
3
DRN_REPORT_ACCESS
Foreign keys
REPORT_ID = DRN_REPORTS.REPORT_ID
USR_ID = USERS.UDR_ID
DRN_REPORT_ACCESS
This table holds a definition of access rights for users and payees to ICM reports.
Each record represents a user’s or payee’s ability to access a specific report. The
table is populated automatically when a user selects the public reports option.
Table columns
Column name
Data type
Description
REP_ACC_TYPE
Number(11,0)
The type of user ID. Can be one of the following values:
1 - User
2 - Payee
REP_ACC_ID
Number(11,0)
The ID of the user or payee with access to the report.
REPORT_ID
Number(11,0)
The ID of the report.
Primary key
REP_ACC_TYPE + REP_ACC_ID + REPORT_ID
Foreign keys
REP_ACC_ID = USERS.USR_ID
DRN_REPORT_ALIAS
This table contains friendly versions of the ICM report definitions. These are
used when reporting on reports. The table is populated automatically every time
a change is made to a report definition. Each record represents an existing report
definition.
Table columns
Column name
Data type
Description
REPORT_ID
Number(11,0)
REPORT_GROUP_BY
VarChar2(255)
Description of the report group by fields.
REPORT_ORDER_BY
VarChar2(255)
Description of the report order by fields.
153
3
DRN_REPORT_EMAIL
Column name
Data type
Description
REPORT_SHOW_FIELDS
VarChar2(255)
Description of the report list fields.
REPORT_TOTAL
VarChar2(255)
Description of the report summary fields.
REPORT_COLUMN
VarChar2(255)
Description of the fields used as report columns.
REPORT_FILTER
VarChar2(2000)
Description of the report filter settings.
REPORT_LANGUAGE_ID
VarChar2(10)
The ID of the language that this record represents.
Primary key
REPORT_ID + REPORT_LANGUAGE_ID
Foreign keys
DRN_REPORT_EMAIL
This table is used to temporarily store ICM report definitions that have been
queued for sending by email.
Table columns
Column name
Data type
Description
JOB_ID
Number(11,0)
The ID of the server job used to run and email the report.
REPORT_DATA
VarChar2(2000)
No longer used.
REPORT_SEND_TO
VarChar2(255)
The email address that the report is to be sent to.
REPORT_CRITERIA
VarChar2(2000)
No longer used.
REPORT_DEFINITION
BLOB
The report definition.
Primary key
None.
Foreign keys
None.
154
3
DRN_REPORT_HISTORY
DRN_REPORT_HISTORY
This table contains the results of previous runs of ICM reports. The output from
the report is held in the REPORT_HIST_DATA column in XML format. If a user runs
a report that has the Store historical reports check box selected, ICM Admin
prompts the user to choose whether to run a new report on live data or to
display one of the saved historical versions of the report.
The number of historical records that the table holds for each report per user is
defined using the The maximum number of historical reports kept setting in the
Reporting Configuration of ICM Admin Choose Administration > System
Configuration > Reporting to modify this setting. The system uses this setting to
remove unwanted records from the table as part of the pre-daily server process.
For more information on ICM server processing, see the System Administration
Guide.
Table columns
Column name
Data type
Description
REPORT_HIST_ID
Number(11,0)
A system generated unique ID for this historical report.
REPORT_ID
Number(11,0)
REPORT_HIST_USR_ID
Number(11,0)
0 indicates the report that was run before it was saved.
The ID of the user that ran the report.
0 indicates a payee ran the report.
REPORT_HIST_EMP_ID
Number(11,0)
The ID of the payee that ran the report.
0 indicates a user ran the report.
REPORT_HIST_RUN_DATE
Date
The date the report was run.
REPORT_HIST_DATA
BLOB
The contents of the report. The contents are store as XML.
REPORT_HIST_TYPE
Number(11,0)
The type of persisted report:
1 - Email
2 - Manual
3 - Linked report
REPORT_MST_ID
Number(11,0)
Either the ID of the master report if this report is a linked report, or
0 if not a linked report.
REPORT_CONTAINS_DATA
Number(1)
A flag to indicate whether the report contains data
-1 - Report contains data
Primary key
None.
Foreign keys
REPORT_ID = DRN_REPORT.REPORT_ID
155
3
This table stores parameters that are used for running an ICM report.
Table columns
Column name
Data type
Description
REPORT_ID
Number(11,0)
REPORT_USR_ID
Number(11,0)
The ID of the user that ran the report.
REPORT_EMP_ID
Number(11,0)
0 indicates a payee ran the report.
The ID of the payee that ran the report.
0 indicates a user ran the report.
REPORT_COMP_TYPE
VarChar2(52)
The type of comparison that the parameter is performing:
1 - not equal
2 - equal
3 - greater than
4 - less than
5 - greater than or equal to
6 - less than or equal to
7 - contains
8 - does not contain
9 - empty
10 - not empty
11 - like
12 - not like
13 - in. Normally used with a list of values
14 - not in. Normally used with a list of values
15 - in bookmark
16 - or
REPORT_COMP_FIELD
VarChar2(256)
The name of the field that the parameter relates to.
REPORT_COMP_VALUE
VarChar2(256)
The values to be compared with.
Primary key
None.
Foreign keys
156
3
DRN_REPORT_SETTINGS
DRN_REPORT_SETTINGS
This table contains the settings associated with an ICM report definition. Each
record represents a parameter and an associated value against a report.
Table columns
Column name
Data type
Description
REPORT_ID
Number(11,0)
SETTING_PARAMETER
VarChar2(50)
The name of the parameters.
SETTING_VALUE
VarChar2(255)
The value of the parameter.
Primary key
REPORT_ID + SETTING_PARAMETER
Foreign keys
DRN_REPORT_USER_INPUT
This table is used to store the last known input criteria by user and report,
enabling the application to remember the last selected options when an ICM
report is run again. Each record represents the last execution of a report by a
user.
Table columns
Column name
Data type
Description
REPORT_ID
Number(11,0)
USR_ID
Number(11,0)
The ID of the user.
USR_EMP
Number(1)
Flag indicating whether the user is a payee.
REPORT_INPUT
VarChar2(2000)
The input criteria specified.
REPORT_DISPLAY
VarChar2(2000)
Description of the input criteria entered.
Primary key
REPORT_ID + USR_ID + USER_EMP
157
3
DRN_REPORTS
Foreign keys
DRN_REPORTS
This table stores ICM report definitions. Each record represents a defined report.
Table columns
Column name
Data type
Description
REPORT_ID
Number(11,0)
The internally generated unique ID for the report.
REPORT_NAME
VarChar2(75)
The name of the report.
REPORT_GROUP
VarChar2(75)
The group that the report belongs to.
REPORT_OUTPUT_TYPE
VarChar2(50)
The output type of the report.
REPORT_SOURCE_ID
Number(11,0)
The ID of the reporting source used by the report.
REPORT_GROUP_BY
VarChar2(255)
The fields used to group the report, if any.
REPORT_ORDER_BY
VarChar2(255)
The fields used to order the report output, if any.
REPORT_SHOW_DETAIL
Number(11,0)
Indicator as to the level of detail to include in the report:
1 - Record
2 - Summary
3 - Summary and Count
4 - Count
REPORT_SHOW_UNIQUE
Number(1)
Flag indicating whether duplicate output lines should be
suppressed.
REPORT_TOTAL
VarChar2(2000)
The fields to use as the report summary values, if any.
REPORT_GRAND_TOTAL
Number(1)
Flag indicating whether the report should display a gran
total.
REPORT_COLUMN
VarChar2(255)
The name of the fields used to provide columns in a table
report.
REPORT_AUTORANGE
Number(1)
No longer used.
REPORT_FILTER
VarChar2(2000)
The report filter settings.
REPORT_LINES_TOTAL
Number(11,0)
REPORT_GROUP_SELECTOR
Number(11,0)
No longer used.
REPORT_SEND_TO
VarChar2(255)
The IDs of the users to whom the report should be sent
automatically, if any.
REPORT_SEND_EVERY
VarChar2(10)
The frequency that the report should be sent
automatically.
REPORT_LAST_SENT
Date
The date and time that the report was last automatically
generated, if any.
REPORT_PUBLIC
Number(1)
No longer used.
158
3
DRN_REPORTS
Column name
Data type
Description
REPORT_ACCESS
Number(11,0)
Indicator as to the scope of access to run this report:
1 - Owner
2 - Selected
REPORT_USERS
VarChar2(2000)
No longer used.
REPORT_OWNER
Number(11,0)
The ID of the user that owns the report definition.
CREATE_KEY
VarChar2(50)
No longer used.
REPORT_PAGE_BREAK
Number(11,0)
No longer used.
REPORT_COLUMN_VALUES
VarChar2(75)
Any column values or ranges specified.
REPORT_CUSTOM
VarChar2(75)
The name of a custom class used to generate customized
reports.
REPORT_CUSTOM_INPUT
Number(1)
No longer used.
REPORT_CHROME
Number(1)
No longer used.
REPORT_EMP_ACCESS
Number(11,0)
Indicator of the level of payee access to run this report:
0 - None
1 - Selected
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
REPORT_TRANSFORM
VarChar2(50)
The name of an XSLT file to use to transform the report
output, if any.
REPORT_EMAIL
Number(1)
Flag indicating whether this report is to be emailed.
-1 - Email report
REPORT_STATEMENT
Number(1)
Flag indicating whether the report should be available as a
payee statement.
-1 - Available as payee statement
REPORT_EMP_REAL_TIME
Number(1)
Flag indicating whether this report should be based on
real time data for payees.
-1 - Report is based on real time data
REPORT_SCHEDULE
Number(1)
Flag indicating whether the report should be
automatically generated.
-1 - Automatically generate report
REPORT_SEND_EMPTY
Number(1)
automatically sent to users if it contains no data.
-1 - Always send report even if it contains no data
REPORT_DOCUMENT
VarChar2(50)
The name of the template file to use in a template report.
REPORT_SEND_USER_TO
Number(1)
automatically generated and sent to users individually.
-1 - Send report to users individually
REPORT_SEND_EMP_TO
Number(1)
automatically generated and sent individually to payees.
-1 - Send report to payees individually
REPORT_LINKS
Number(1)
Flag indicating whether the report has links.
-1 - Report has links
REPORT_LINK_REPORT_1
Number(11,0)
The ID of the first linked report, if any.
159
3
DRN_REPORTS
Column name
Data type
Description
REPORT_LINK_TYPE_1
Number(11,0)
The type of the first link:
0 - None
1 - Zoom
2 - Embed Pre
3 - Embed Post
4 - Append
REPORT_LINK_FIELD_1
VarChar2(75)
The name of the first report link field, if any.
Number(11,0)
The ID of the second linked report, if any.
REPORT_LINK_TYPE_2
Number(11,0)
The type of the second link:
0 - None
1 - Zoom
2 - Embed Pre
3 - Embed Post
4 - Append
REPORT_LINK_FIELD_2
VarChar2(75)
The name of the second report link field, if any.
Number(11,0)
The ID of the third linked report, if any.
REPORT_LINK_TYPE_3
Number(11,0)
The type of the third link:
0 - None
1 - Zoom
2 - Embed Pre
3 - Embed Post
4 - Append
REPORT_LINK_FIELD_3
VarChar2(75)
The name of the third report link field, if any.
REPORT_SEND_TO_PRINTER
VarChar2(75)
The name of the print queue to which the report should
be sent automatically, if any.
REPORT_SUBTOTAL_LEVELS
Number(11,0)
The number of sub total levels to indent and subtotal the
report at.
REPORT_SHOW_FIELDS
VarChar2(2000)
The fields to show against each record, if any.
REPORT_DELTA
Number(1)
No longer used.
REPORT_SENT_TO_EMAIL
VarChar2(255)
No longer used.
REPORT_SENT_TO_FOLDER
VarChar2(255)
No longer used.
REPORT_SENT_TO_FILE
VarChar2(255)
No longer used.
REPORT_SENT_TO_FTP
VarChar2(255)
No longer used.
REPORT_TW_AUTO_START
VarChar2(5)
The time window start point in HH:MM format.
REPORT_TW_AUTO_DURATION
Number(11,0)
The time window duration, in hours.
REP_LINK_1_HIST
VarChar2(20)
The name of the field used as a historical flag setting field
for link number 1, if any.
REP_LINK_2_HIST
VarChar2(20)
REP_LINK_3_HIST
VarChar2(20)
Number(11,0)
160
3
DRN_REPORTS
Column name
Data type
Description
REPORT_LINK_TYPE_4
Number(11,0)
0 - None
1 - Zoom
2 - Embed Pre
3 - Embed Post
4 - Append
REPORT_LINK_FIELD_4
VarChar2(75)
REP_LINK_4_HIST
VarChar2(20)
The name of the field (if any) used as a historical flag
setting field for link number 3.
Number(11,0)
REPORT_LINK_TYPE_5
Number(11,0)
0 - None
1 - Zoom
2 - Embed Pre
3 - Embed Post
4 - Append
REPORT_LINK_FIELD_5
VarChar2(75)
REP_LINK_5_HIST
VarChar2(20)
REPORT_LINK_DIRECT_1
Number(1)
Zoomed reports only.
Number(1)
-1 - First linked report should be a direct link
-1 - Second linked report should be a direct link
Number(1)
-1 - Third linked report should be a direct link
Number(1)
-1 - Fourth linked report should be a direct link
Number(1)
REPORT_ROW_TOTAL
Number(11,0)
Table reports only. Flag indicating whether row-level totals
should be displayed.
REPORT_SHOW_TITLE
Number(1)
Flag indicating whether the report title should be shown if
this report is an appended report.
REPORT_NO_STATEMENT_FILTER
Number(1)
No longer used.
REPORT_PERSISTABLE
Number(11,0)
Flag indicating whether the results of running this report
should be stored.
-1 - Fifth linked report should be a direct link
-1 - Display row-level totals
-1 - Show title
-1 - Store results
REPORT_TRANSFORM_PDF
VarChar2(255)
Flag indicating whether this is a PDF report.
-1 - Report is PDF
161
3
DRN_SOURCES
Column name
Data type
Description
REPORT_EMP_FULL_HIERARCHY
Number(1)
Flag indicating whether the report should show the full
hierarchy of payees that this payee can see.
REPORT_LINES_PER_PAGE
Number(11,0)
HTML reports only. The number of lines to display per
page.
REPORT_SHOW_IN_PAYEE_REP_
LIST
Number(1)
Flag indicating whether this report should appear in the
list of reports that payees can run.
-1 - Show hierarchy
-1 - Appear in list of payee reports
REPORT_READ_ONLY
Number(1)
Flag indicating whether Editor users can only view the
report definition using ICM Admin.
-1 - Editor users can only view the report
0 - Editor user can also modify the report
This flag is ignored for Admin users. Admin users can
modify all report definitions.
ENTITY_ID
VarChar2(4000)
The unique reference ID for this report.
Primary key
REPORT_ID
Foreign keys
REPORT_OWNER = USERS.USR_ID
REPORT_SOURCE_ID = DRN_SOURCES.SOURCE_ID
DRN_SOURCES
This table contains the available reporting sources for ICM reports. Each record
represents a source of data that can be used by a report. The table is populated
automatically by the ICM server Initialise Reports process.
NOTE: The table can contain more than one record for the same report source.
The different records are for different languages (specified in the
SOURCE_LANGUAGE_ID column).
Table columns
Column name
Data type
Description
SOURCE_ID
Number(11,0)
The internally generated unique ID of the report source.
SOURCE_NAME
VarChar2(150)
The name of the report source.
SOURCE_TABLE
VarChar2(50)
The table or view name in the database containing the report
source data.
162
3
DRN_VALUE_ALIAS
Column name
Data type
Description
SOURCE_ACCESS
Number(11,0)
Indicator as to the security level restrictions of the reporting source:
0 - None
1 - General
2 - Administrator
3 - Authorization Based
SOURCE_BUILD_DATE
Date
Date and time stamp when the source was last built.
SOURCE_AUTO
Number(11,0)
Indicator as to where the reporting source definition is defined:
1 - Core
2 - Custom
3 - User
SOURCE_CLOSED
Number(1)
Flag indicating whether the reporting source can support released
payee data.
-1 - Reporting source supports released data
SOURCE_FILTER_EMP
Number(1)
Flag indicating whether the reporting source can be filtered by
payee.
-1 - Can be filtered by payee
SOURCE_FILTER_PLN
Number(1)
Flag indicating whether the reporting source can be filtered by plan.
SOURCE_LANGUAGE_ID
VarChar2(10)
The language for which the report source is available.
SOURCE_FILTER_PERIOD
Number(1)
Flag indicating whether payees can see historical results for their
employees in a report that uses this report source.
-1 - Can be filtered by plan
-1 - Can see historical results
Primary key
SOURCE_ID + SOURCE_LANGUAGE_ID
Foreign keys
None.
DRN_VALUE_ALIAS
This table contains friendly versions of database field values to be used in ICM
reports. Each record represents the conversion of an underlying value to a
display value. The table is populated automatically by the server Initialize
Reports process.
Table columns
Column name
Data type
Description
FIELD_NAME
VarChar2(50)
The name of the field.
163
3
ELEMENT_GROUPS
Column name
Data type
Description
FIELD_VALUE
Number(11,0)
The database level value of the field.
FIELD_DISPLAY
VarChar2(50)
The friendly value to display to the user.
FIELD_LANGUAGE_ID
VarChar2(10)
The language for which this friendly value applies.
Primary key
FIELD_NAME + FIELD_VALUE + FIELD_LANGUAGE_ID
Foreign keys
None.
ELEMENT_GROUPS
This table contains calculator series definitions. Each record represents a
calculator series.
Table columns
Column name
Data type
Description
EG_ID
Number(11,0)
The internally generated unique identifier for the calculator series.
EG_NAME
VarChar2(75)
The name of the calculator series.
EG_TYPE
Number(11,0)
The type of the calculator series:
1 - Calculator
2 - Clawback
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
Primary key
EG_ID
Foreign keys
None.
ELEMENT_ITEMS
This table contains references to the calculators that make up a calculator series.
Each record represents a calculator that belongs to a series.
164
3
EMP_CURRENCIES
Table columns
Column name
Data type
Description
EG_ID
Number(11,0)
The ID of the calculator series.
EG_EFFECTIVE_DATE
Date
The effective date of the series item.
ELEMENT_ID
Number(11,0)
The ID of the calculator that is represented by this item.
Primary key
EG_ID + EG_EFFECTIVE_DATE
Foreign keys
EG_ID = ELEMENT_GROUPS.EG_ID
ELEMENT_ID = CALCULATORS.CALC_ID
EMP_CURRENCIES
This table stores information about the payment currency of payees. Each record
represents the point at which a specific payment currency comes into effect for a
payee.
Table columns
Column name
Data type
Description
EMP_ID
Number(11,0)
FIN_YEAR_ID
Number(11,0)
FP_PERIOD_SEQ
Number(11,0)
CUR_ID
Number(11,0)
The ID of the currency.
Primary key
Foreign keys
FP_PERIOD_SEQ]
165
3
EMPLOYEE_CALC
EMPLOYEE_CALC
This table holds a record for each payee that is marked for recalculation. The
table is populated by the Calculations Dependency job (job type 78). For details
on the server job types, see the System Administration Guide.
Table columns
Column name
Data type
Description
EMP_ID
Number(11,0)
ID of the payee.
NEEDS_PROCESSING
Number(1,0)
Flag indicating whether the payee is marked for recalculation:
-1 - Marked for recalculation
NEEDS_PROCESSING_REASON
Number(11,0)
Code indicating the reason for the marking. Can be one of the
following:
0 - No reason (for example, after a system upgrade)
1 - New event
2 - Payee edit
3 - Draw edit
4 - SPIF edit
5 - Target edit
6 - OTC edit
7 - Clawback edit
8 - Payment adjustment edit
9 - Corporate target edit
10 - Model edit
11 - Salary edit
12 - Exchange rate edit
13 - MBO edit
14 - List edit
15 - Financial year edit
16 - Payment batch deletion
17 - Statement batch deletion
18 - Plan edit
19 - Sales structure edit
20- Calculator edit
21- Calculator series edits
Primary key
EMP_ID
Foreign key
166
3
EMPLOYEE_DRAW
EMPLOYEE_DRAW
This table contains draws and draw templates. Each record represents a draw
against a payee or plan or a draw template. The table is populated through the
user interface, and also through the Synchronize Draws server job automatically
assigning draws from a draw template. For information on this job, see “Job
type 131 - Synchronize draws” in the System Administration Guide.
Table columns
Column name
Data type
Description
DRAW_ID
Number(11,0)
The internally generated unique identifier for the draw.
DRAW_NAME
VarChar2(75)
The name of the draw.
DRAW_TYPE
Number(11,0)
The type of the draw.
1 - Recoverable Draw
2 - Non Recoverable Draw
3 - Recoverable Guarantee
4 - Non Recoverable Guarantee
5 - Additional Payment
6 - Suspended Payment
8 - Recoverable Cap
9 - Non Recoverable Cap
FIN_YEAR_ID
Number(11,0)
The ID of the year.
EMP_ID
Number(11,0)
DRAW_FROM
Number(11,0)
The ID of the start period of the draw.
DRAW_TO
Number(11,0)
The ID of the end period of the draw.
DRAW_PCNT
Number(20,8)
The percentage of the specified type of value associated with
the draw.
DRAW_PAYMENT_TYPE
Number(11,0)
The payment type of the draw.
1 - % of Salary
2 - % of OTC
3 - % of OTE
4 - Specified Amounts
5 - % of period salary
6 - % of period OTC
7 - % of period OTE
PLN_ID
Number(11,0)
The ID of the plan, if any.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
DRAW_TAX_GROUP
Number(11,0)
The tax point for the element.
Can also take one of the following values:
1 - tax point is inherited from payee
2 - tax point is inherited from plan
167
3
EMPLOYEE_DRAW
Column name
Data type
Description
DRAW_TAX_CODE
Number(11,0)
The default tax band for the element.
In general this is a tax band to use, but can also be one of the
following values:
-1 - Tax band is inherited from a payee
-2 - Tax band is inherited from a plan
DRAW_RECOVER_AFTER
Number(11,0)
The period in which recovery is to start.
DRAW_TEMPLATE_ID
Number(11,0)
The ID of the associated draw template (if this draw was
generated from a draw template).
DRAW_TEMPLATE_ACTIVE
Number(1)
Draw template only.
-1 - This template is active
DRAW_LEVEL_TYPE
Number(11,0)
The type of the draw:
0 - Payee level
1 - Plan level
DRAW_TEMPLATE_SYNCH_DATE
Date
The data and time that this draw was last synchronized with
its associated draw template (if this draw was generated from
a draw template).
DRAW_DELETED
Number(1)
Flag indicating whether the draw has been paid out and so
should be marked as deleted (-1) or not (null or 0).
DRAW_TEMPLATE_DELETE
Number(1)
Flag indicating whether the draw template is marked as
deleted and so the Synchronize draw job should delete all of
the slave draw records:
-1 - Draw template is marked as deleted. All other fields in
the record are set to null except DRAW_ID.
Primary key
DRAW_ID
Foreign keys
FIN_YEAR_ID + DRAW_FROM = FIN_PERIODS.[FIN_YEAR_ID + FP_PERIOD_SEQ]
FIN_YEAR_ID + DRAW_TO = FIN_PERIODS.[FIN_YEAR_ID + FP_PERIOD_SEQ]
168
3
This table contains specified draw amounts. Each record represents an amount
of money for a draw and period. The table is populated through the user
interface.
Table columns
Column name
Data type
Description
DRAW_ID
Number(11,0)
The ID of the associated draw.
FP_PERIOD_SEQ
Number(11,0)
The ID of the period that the amount relates to.
DRAW_AMOUNT
Number(15,2)
The amount of the draw in payment currency.
DRAW_TEMPLATE_ID
Number(11,0)
The ID of the draw template that the associated draw was generated
from, if any.
Primary key
DRAW_ID + FP_PERIOD_SEQ
Foreign keys
DRAW_ID = EMPLOYEE_DRAW.DRAW_ID
EMPLOYEE_HIST
This table contains data relating to historical field values against payees. Each
record represents the start point (FIN_DATE field) of a specific value for a payee
against a historical field.
If there are two records for the same historical field for a payee, The system uses
the record with the latest FIN_DATE as the current value. For example, the system
uses the value Supervisor for the payee job title if the EMPLOYEE_HIST table
contains these records:
EMP_ID
FIELD_NAME
FIN_YEAR_ID
FP_PERIOD_SEQ
FIELD_VALUE
FIN_DATE
1364
EMP_JOB_TITLE
10
7
Supervisor
30-JUL-08
1364
EMP_JOB_TITLE
10
1
Agent
01-JAN-08
Table columns
Column name
Data type
Description
EMP_ID
Number(11,0)
The ID of the payee. This ID maps to a record in the EMPLOYEES
table.
169
3
EMPLOYEE_RESULTS
Column name
Data type
Description
FIELD_NAME
VarChar2(30)
The name of the historical field.
FIN_YEAR_ID
Number(11,0)
The ID of the effective year. This ID maps to a record in the
FIN_YEARS table.
FP_PERIOD_SEQ
Number(11,0)
FIELD_VALUE
VarChar2(75)
The value of the historical field.
FIN_DATE
Date
The effective date.
FIELD_VALUE_NUMBER
Number(15,2)
Copy of FIELD_VALUE if a number.
FIELD_VALUE_DATE
Date
Copy of FIELD_VALUE if a date.
FIELD_VALUE_BOOLEAN
Number(1)
Copy of FIELD_VALUE if a boolean.
Primary key
EMP_ID + FIELD_NAME + FIN_DATE
Foreign keys
FP_PERIOD_SEQ]
EMPLOYEE_RESULTS
This table contains payee level calculation results summary. Each record
represents the results for a period, for a payee, for a model. It also can include
additional results records if an extended model count is used against the payee.
The table is populated by the calculation process.
Table columns
Column name
Data type
Description
FIN_YEAR_ID
Number(11,0)
The ID if the year.
FP_PERIOD_SEQ
Number(11,0)
The ID of the period.
EMP_ID
Number(11,0)
ER_SALARY_THIS
Number(32,15)
The salary for the period.
ER_SALARY_QTD
Number(32,15)
The QTD salary.
ER_SALARY_QTR
Number(32,15)
The salary for the quarter.
ER_SALARY_YTD
Number(32,15)
The salary YTD.
ER_SALARY_ANN
Number(32,15)
The annual salary.
ER_INCENTIVE_THIS
Number(32,15)
The total OTC available for the period.
ER_INCENTIVE_QTD
Number(32,15)
The total OTC available QTD.
ER_INCENTIVE_QTR
Number(32,15)
The total OTC available for the quarter.
ER_INCENTIVE_YTD
Number(32,15)
The total OTC available YTD.
170
3
EMPLOYEE_RESULTS
Column name
Data type
Description
ER_INCENTIVE_ANN
Number(32,15)
The total OTC for the year.
ER_COMM_DUE_THIS
Number(32,15)
The calculated earnings due for the period.
ER_COMM_DUE_QTD
Number(32,15)
The calculated earnings due QTD.
ER_COMM_DUE_YTD
Number(32,15)
The calculate earnings due YTD.
ER_DRAW_DUE_THIS
Number(32,15)
The total draw amount applied this period.
ER_DRAW_DUE_QTD
Number(32,15)
The total draw amount applied QTD.
ER_DRAW_DUE_YTD
Number(32,15)
The total draw amount applied YTD.
ER_TOTAL_ADJ_THIS
Number(32,15)
The total payee level adjustments for the period.
ER_TOTAL_ADJ_QTD
Number(32,15)
The total payee level adjustments QTD.
ER_TOTAL_ADJ_YTD
Number(32,15)
The total payee level adjustments YTD.
ER_TOTAL_ADDITION_THIS
Number(32,15)
The total payee level adjustments for the period.
ER_TOTAL_ADDITION_QTD
Number(32,15)
The total payee level adjustments QTD.
ER_TOTAL_ADDITION_YTD
Number(32,15)
The total payee level adjustments YTD.
ER_TOTAL_DUE_THIS
Number(32,15)
The total amount due for the period.
ER_TOTAL_DUE_QTD
Number(32,15)
The total amount due QTD.
ER_TOTAL_DUE_YTD
Number(32,15)
The total amount due YTD.
ER_ACTUAL_PAID_PREV
Number(32,15)
The amount of pay released prior to the period.
ER_ACTUAL_PAID_THIS
Number(32,15)
The amount of pay released, or due to be released this
period.
ER_ACTUAL_PAID_QTD
Number(32,15)
The amount of pay released, or due to be released QTD.
ER_ACTUAL_PAID_YTD
Number(32,15)
The amount of pay released, or due to be released YTD.
ER_BASE_TOTAL_DUE_THIS
Number(32,15)
The total due for the period in base currency.
ER_BASE_TOTAL_DUE_QTD
Number(32,15)
The total due QTD in base currency.
ER_BASE_TOTAL_DUE_YTD
Number(32,15)
The total due YTD in base currency.
ER_ARREARS_YTD
Number(32,15)
No longer used.
ER_BROUGHT_FORWARD
Number(32,15)
The balance brought forward from the previous period.
ER_PAY_DIFF
Number(32,15)
The difference to the calculated earnings and adjustments
made by any draw in this period.
ER_TOTAL_ACTUAL_THIS
Number(32,15)
The total due for the period in base currency.
ER_TOTAL_ACTUAL_QTD
Number(32,15)
The total due QTD in base currency.
ER_TOTAL_ACTUAL_YTD
Number(32,15)
The total due YTD in base currency.
ER_INCENTIVE_AVL
Number(32,15)
The total OTC available based on the payee start and end
dates.
ER_PCNT_OTC_THIS
Number(20,8)
The percentage of period OTC earned.
ER_PCNT_OTC_QTD
Number(20,8)
The percentage of QTD OTC earned.
ER_PCNT_OTC_QTR
Number(20,8)
The percentage of quarter OTC earned.
ER_PCNT_OTC_YTD
Number(20,8)
The percentage of YTD OTC earned.
ER_PCNT_OTC_ANN
Number(20,8)
The percentage of annual OTC earned.
ER_ACTUAL_DUE_THIS
Number(32,15)
The actual amount due for the period.
ER_ACTUAL_DUE_YTD
Number(32,15)
The actual amount due YTD.
ER_ACTUAL_RELEASED_YTD
Number(32,15)
The amount actually paid to a payee so far this year. Set by
the release payment process.
171
3
Column name
Data type
Description
ER_PAYMENTS_MADE_THIS
Number(32,15)
The total payments released this period.
ER_PAYMENTS_MADE_QTD
Number(32,15)
The total payments released QTD.
ER_PAYMENTS_MADE_YTD
Number(32,15)
The total payments release YTD.
QUARTER
Number(11,0)
The ID of the quarter.
EMP_CUR_ID
Number(11,0)
ER_DRAW_DIFF_THIS
Number(32,15)
The draw value that has been over or under paid.
ER_PCNT_OTC_AVL
Number(20,8)
The percentage of available OTC earned.
ER_DRAW_DIFF_QTD
Number(32,15)
The draw value QTD that has been over or under paid.
ER_DRAW_DIFF_YTD
Number(32,15)
The draw value YTD that has been over or under paid.
Primary key
FIN_YEAR_ID + EMP_ID + FP_PERIOD_SEQ + FCST_ID + FCST_USR + MODEL_COUNT
Foreign keys
EMP_CUR_ID = CURRENCIES.CUR_ID
FP_PERIOD_SEQ]
FCST_ID = FORECAST_TEMPLATES.TEM_ID
This table contains payee level summary results that have been released to
payees. As such, it is identical in column structure to the EMPLOYEE_RESULTS
table, with the addition of the statement batch ID as a higher layer which
represents the batch used to release the data.
Table columns
Column name
Data type
Description
SB_ID
Number(11,
0)
The ID of the statement batch under which the data was released.
Primary key
+ SB_ID
Foreign keys
172
3
FP_PERIOD_SEQ]
This table contains payee level summary results that have been released to
managers. As such, it is identical in column structure to the EMPLOYEE_RESULTS
table, with the addition of the statement batch ID as a higher layer which
represents the batch used to release the data.
Table columns
Column name
Data type
Description
SB_ID
Number(11,
0)
The ID of the statement batch under which the data was released.
Primary key
+ SB_ID
Foreign keys
FP_PERIOD_SEQ]
EMPLOYEE_YEAR
This table contains year related data associated with a payee. Each record
represents a payee for a year. The table is populated via the user interface or via
data ports.
Table columns
Column name
Data type
Description
EMP_ID
Number(11,0)
FIN_YEAR_ID
Number(11,0)
The ID of the year.
CUR_ID
Number(11,0)
173
3
EMPLOYEES
Column name
Data type
Description
EY_REPORT_TYPE
Number(11,0)
The ID of the report to use as the default statement for the
payee. Report IDs are stored as negative numbers in this
column.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
VarChar2(50)
EY_HOLD
Number(1)
Flag indicating whether the payee is on hold for the year.
EY_CONTRACT_ACCEPTED
Number(11,0)
No longer used.
EY_ACCEPTED_DATE
Date
No longer used.
LAST_PROCESSED
Date
The date and time at which the payee was last calculated for the
year.
MODEL_UPDATED
Number(1)
Flag indicating whether a model including this payee has been
modified since the last calculation run.
EY_PROCESS_FROM
Number(11,0)
No longer used.
LAST_STATEMENT_BUILT
Date
The date and time at which the payee statement was last built.
Primary key
EMP_ID + FIN_YEAR_ID
Foreign keys
EY_REPORT_TYPE = STATEMENT_TYPES.ST_ID
CURR_ID = CURRENCIES.CUR_ID
EMPLOYEES
This table contains payee data. Each record represents a payee. The table is
populated via the user interface or via data ports.
Shared profile fields (EMP_UD1 to EMP_UD10) are defined via the Shared Profile
configuration tab of ICM Admin. Choose Administration > System Configuration >
Shared Profile to define these fields.
User defined fields (EMP_PROFILE_1 to EMP_PROFILE_55) are defined via the
Payees configuration tab of ICM Admin. Choose Administration > System
Configuration > Payees to define these fields.
The default field types are shown below, but if required you can alter the field
definitions, for example from VarChar2 to Number.
174
3
EMPLOYEES
Table columns
Column name
Data type
Description
EMP_ID
Number(11,0)
The system generated unique ID for the payee.
EMP_MODEL
Number(1)
Flag indicating whether the payee is only to be used in
models. 0 indicates not model.
EMP_PAYROLL_ID
VarChar2(250)
A unique payroll ID assigned to the payee in the user
interface.
EMP_NAME
VarChar2(50)
The name of the payee.
EMP_JOB_TITLE
VarChar2(50)
The current job title or role.
EMP_MANAGER
Number(11,0)
No longer used.
EMP_MBO
Number(1)
Flag indicating whether the payee can set MBO results for
their team members.
-1 - Can see MBO results
EMP_PAYROLL
Number(11,0)
The ID of the payment system used by the payee.
EMP_LOCATION
VarChar2(50)
The current location.
EMP_EMAIL
VarChar2(50)
The payees email address.
EMP_DIVISION
VarChar2(50)
The current division.
EMP_TEL
VarChar2(50)
The payee telephone number.
EMP_PASSWORD
VarChar2(250)
The encrypted password that the payee uses to log in to
the system. Only used when migrating payees from NICE
ICM version 3.2. When a migrated payee logs in to NICE
ICM for the first time, the payee must reset the password
and this field is not used for subsequent log ins.
EMP_START_DATE
Date
The start date of the payee.
EMP_TERMINATION_DATE
Date
The termination date of the payee.
EMP_UD1 to EMP_UD6
VarChar2(50)
The current custom field 1 to 6 values. These are
user-defined fields set up via shared profile configuration.
The fields are related to EMP_UDn_NAME and
EMP_UDn_GROUP.
EMP_UD7 to EMP_UD10
Number(20,8)
The current custom field 7 to 10 values.
EMP_SECURITY_CODE
VarChar2(50)
The randomly generated security code applied to the
payee to protect their log in session.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
EMP_ACCOUNT
VarChar2(50)
The payee system account name. Displays as n/a in the
user interface until there is something payable for this
payee.
EMP_CONTRACT
VarChar2(50)
Not used.
EMP_MODEL_COUNT
Number(11,0)
Count of the number of instances of this payee that
should be applied to models.
EMP_CREATED
Date
The date and time at which the payee record was created.
EMP_NO_HELP
Number(1)
No longer used.
175
3
EMPLOYEES
Column name
Data type
Description
EMP_BANK_NAME
VarChar2(50)
The name of the bank.
NOTE: The bank details fields are only accessible from
the user interface if the Enable bank details option for
Payees check box is selected in the payee configuration of
ICM Admin. To access the payee configuration, choose
Administration > System Configuration > Payee.
EMP_BANK_SORT_CODE
VarChar2(50)
The bank sort code.
EMP_BANK_ACCOUNT_NO
VarChar2(75)
The bank account number.
EMP_BANK_ACCOUNT_NAME
VarChar2(250)
The bank account name.
EMP_BANK_REFERENCE
VarChar2(50)
The bank reference.
EMP_BANK_ADDRESS_1 to
EMP_BANK_ADDRESS_4
VarChar2(50)
The bank address lines 1 - 4.
EMP_BANK_POST_CODE
VarChar2(20)
The bank post code.
EMP_PAID
Number(1)
Flag indicating whether the payee has the potential to be
paid.
-1 - Can be paid
EMP_TEMP_PAYROLL
Number(11,0)
Temporary flag used during payment release.
EMP_CREATED_BY
Number(11,0)
The ID of the user who created the payee record.
EMP_PG_OPEN
VarChar2(255)
The plans that are expanded for this payee in the payee
details when the Hide Plans user preference is selected.
EMP_STATUS
VarChar2(50)
The current status.
EMP_MANAGER_TYPE
VarChar2(50)
The current manager type.
EMP_PAYMENT_NUMBER
Number(11,0)
A count of the number of payments released to the payee.
EMP_LAST_PAYMENT
Date
The date and time of the last payment release to the payee.
EMP_UD1_NAME to
EMP_UD10_NAME
VarChar2(100)
The current custom fields 1 - 10 name values.
NOTE: The EMP_UDn_NAME and EMP_UDn_GROUP
fields are linked with the associated EMP_UDn fields. The
fields are only populated if the Ref. Table check box is
selected for the EMP_UDn field, and also if the Named
and Grouped check boxes are selected. When a user
selects an item for the profile field in the user interface,
the corresponding name and group are copied from the
reference data.
Only custom fields 1 to 6 can be reference data, and so
EMP_UD7_NAME to EMP_UD10_NAME are never used.
EMP_UD1_GROUP to
EMP_UD10_GROUP
VarChar2(50)
The current custom fields 1- 10 group values.
See EMP_UDn_NAME above.
Only custom fields 1 to 6 can be reference data, and so
EMP_UD7_GROUP to EMP_UD10_GROUP are never
used.
EMP_JOB_TITLE_GROUP
VarChar2(50)
The current job title group. Only populated if the
Grouped check box is selected in the Payee configuration
of ICM Admin for the Job Title main payee field.
EMP_JOB_TITLE_TYPE
VarChar2(50)
No longer used.
EMP_LOCATION_GROUP
VarChar2(50)
The current location group. Only populated if the
of ICM Admin for the Location main payee field.
176
3
EMPLOYEES
Column name
Data type
Description
EMP_LOCATION_TYPE
VarChar2(50)
No longer used.
EMP_DIVISION_GROUP
VarChar2(50)
The current division group. Only populated if the
of ICM Admin for the Division main payee field.
EMP_DIVISION_TYPE
VarChar2(50)
No longer used.
EMP_DEPT_TYPE
VarChar2(50)
No longer used.
EMP_PROFILE_1 to
EMP_PROFILE_10
VarChar2(50)
The payee profile fields 1 to 10.
EMP_PROFILE_11 to
EMP_PROFILE_20
Number(15,2)
EMP_PROFILE_21 to
EMP_PROFILE_23
Date
EMP_PROFILE_24 to
EMP_PROFILE_28
Number(1)
EMP_PROFILE_29 to
EMP_PROFILE_38
VarChar2(50)
EMP_PROFILE_39 to
EMP_PROFILE_48
Number(15,2)
EMP_PROFILE_49 to
EMP_PROFILE_50
Date
EMP_PROFILE_51 to
EMP_PROFILE_55
Number(1)
EMP_MANAGER_TYPE_GROUP
VarChar2(50)
The current manager type group. Only populated if the
of ICM Admin for the Manager Type main payee field.
EMP_MANAGER_TYPE_NAME
VarChar2(75)
The current manager type name. Only populated if the
Named check box is selected in the Payee configuration of
ICM Admin for the Manager Type main payee field.
EMP_JOB_TITLE_NAME
VarChar2(75)
The current job title name. Only populated if the Named
check box is selected in the Payee configuration of ICM
Admin for the Job Title main payee field.
EMP_DIVISION_NAME
VarChar2(75)
The current division name. Only populated if the Named
EMP_LOCATION_NAME
VarChar2(75)
The current location name. Only populated if the Named
EMP_DEPARTMENT
VarChar2(75)
The current department.
EMP_DEPARTMENT_NAME
VarChar2(75)
The current department name. Only populated if the
Named check box is selected in the Payee configuration of
ICM Admin for the Department main payee field.
EMP_DEPARTMENT_GROUP
VarChar2(75)
The current department group. Only populated if the
of ICM Admin for the Department main payee field.
EMP_HOLD
Number(1)
The payee hold status.
EMP_OWN_THREAD
Number(1)
No longer used.
NOTE: Payee profile fields are configured on the Payee
configuration tab of ICM Admin.
177
3
EMPLOYEES
Column name
Data type
Description
EMP_TAX_GROUP
Number(11,0)
The ID of the tax group assigned to this payee.
EMP_TAX_CODE
Number(11,0)
No longer used.
EMP_PASSWORD_EXPIRED
Number(1)
Flag indicating whether the password for this payee has
expired.
-1 - Password has expired
EMP_REGION
Number(11,0)
ID of the region to which this payee belongs.
ENTITY_ID
VarChar2(4000)
The unique reference ID for this contact.
SYNC_DATE
Date
MOBILE_ACCESS
Number(11,0)
Flag indicating whether this contact is able to access the
mobile SCA application.
-1 - Can access mobile SCA
SYNC_STATUS_CODE
VarChar2(255)
Possible codes are:
•
SUCCESS
•
NOT_FOUND
•
DUPLICATE_FOUND
•
BAD_DATA
•
INTERNAL_ERROR
A value of null indicates synchronization has not yet
started for the payee.
SYNC_STATUS_INFO
VarChar2(4000)
Details of the synchronization result. For example, an
error description if the synchronization failed.
OTC_CALC_DURATION
Number(11,0)
Internal use only. The duration in milliseconds of the on
target commission calculation from the last calculation
run.
SALARY_CALC_DURATION
Number(11,0)
Internal use only. The duration in milliseconds of the
salary calculation from the last calculation run.
LEDGER_EMP_CALC_DURATION
Number(11,0)
Internal use only. The duration in milliseconds of the
payee level ledger calculation from the last calculation
run.
TOTAL_CALC_DURATION
Number(11,0)
Internal use only. The total duration in milliseconds of
the payee calculation from the last calculation run.
Primary key
EMP_ID
Foreign keys
EMP_PAYROLL = PAYROLL.PR_ID
EMP_REGION = REGIONS.REGION_ID
178
3
EXCHANGE_RATES
EXCHANGE_RATES
This table contains exchange rates. Each record represents the actual and plan
exchange rates for a currency and period. The table is populated via the ICM
Admin user interface or via data ports.
Table columns
Column name
Data type
Description
FIN_YEAR_ID
Number(11,0)
The ID of the year.
CUR_ID
Number(11,0)
FP_PERIOD_SEQ
Number(11,0)
EXR_ACT_VAL
Number(20,8)
The actual exchange rate.
EXR_PLAN_VAL
Number(20,8)
The plan exchange rate.
EXR_SYNCH
Date
Used by data ports to synchronize loaded exchange rates.
Primary key
FIN_YEAR_ID + CUR_ID + FP_PERIOD_SEQ
Foreign keys
FP_PERIOD_SEQ]
FAVOURITE_REPORT
FILTER_CRITERIA
This table contains filter data used against events in plan queries and other
areas. Each record represents a line of a query. The same table is used for several
areas, the context of which is defined by the FILTER_TYPE field.
179
3
FILTER_CRITERIA
Table columns
Column name
Data type
FILTER_SOURCE_TYPE
Number(11,0)
Description
The context of the record to which the filter belongs:
1 - Plans
2 - SPIFs
3 - Update Plans
4 - Models
5 - Clawback
6 - Event List
7 - Event Extension
FILTER_SOURCE_ID
Number(11,0)
The primary ID of the record to which the filter is related.
FILTER_SEQUENCE
Number(11,0)
The sequence number of the filter line.
FILTER_TYPE
Number(11,0)
The ID of the field being tested by the filter line.
FILTER_OPERATION
Number(11,0)
The operation code of the filter line:
1 - Is one of these
2 - Is not one of these
3 - Also include these
4 - Greater than
5 - Less than
6 - Is empty
7 - Is not empty
8 - Is nothing. This code is no longer available and included for
backwards compatibility only
9 - Is not nothing. This code is no longer available and included for
backwards compatibility only
10 - Is equal
11 - Is not equal
13 - True
14 - False
15 - Matches
16 - Between
17 - Is in list
18 - Is not in list
19 - contains
20 - Does not contain
21 - Within
22 - Does not match
23 - Contains case insensitive
24 - Does not contain case insensitive
25 - Greater than or equal to
26 - Less than or equal to
27 - Starts with
28 - Ends with
100 - Roll up match
150 - Roll up literal
200 - Roll up match exclusive
250 - Roll up literal exclusive
FILTER_SOURCE_ID2
Number(11,0)
The secondary ID of the record to which the filter is related, if any.
180
3
FILTER_VALUES
Primary key
FILTER_SOURCE_TYPE + FILTER_SOURCE_ID + FILTER_SOURCE_ID2 +
FILTER_SEQUENCE
Foreign keys
FILTER_SOURCE_TYPE + FILTER_SOURCE_ID = (context table).(ID)
FILTER_SOURCE_TYPE + FILTER_SOURCE_ID + FILTER_SOURCE_ID2 = (context
table).[(ID) + (ID2)]
FILTER_VALUES
This table contains any values entered against a filter line in the
FILTER_CRITERIA table. Each record represents a value specified against the
criteria in a filter line.
Table columns
Column name
Data type
FILTER_SOURCE_TYPE
Number(11,0)
Description
The context of the record to which the filter line is related:
1 - Plans
2 - SPIFs
3 - Update Plans
4 - Models
5 - clawback
6 - Event List
FILTER_SOURCE_ID
Number(11,0)
The primary ID of the record to which the filter line is related.
FILTER_SEQUENCE
Number(11,0)
The sequence number of the filter line.
FILTER_SOURCE_ID2
Number(11,0)
The secondary ID of the record to which the filter line is related, if
any.
FILTER_VALUE
VarChar2(255)
The value being tested against the filter criteria.
Primary key
FILTER_SEQUENCE + FILTER_VALUE
Foreign keys
FILTER_SEQUENCE = FILTER_CRITERIA.[ FILTER_SOURCE_TYPE +
FILTER_SOURCE_ID + FILTER_SOURCE_ID2 + FILTER_SEQUENCE]
FILTER_SOURCE_TYPE + FILTER_SOURCE_ID = (context table).(ID)
FILTER_SOURCE_TYPE + FILTER_SOURCE_ID + FILTER_SOURCE_ID2 = (context
table).[(ID) + (ID2)]
181
3
FIN_DAYS
FIN_DAYS
This table contains dates within the known calendar. Each record represents a
date within the system calendar. The table is populated automatically when
years are updated.
Table columns
Column name
Data type
Description
FIN_DATE
Date
The date.
FIN_YEAR_ID
Number(11,0)
The ID of the year.
FP_PERIOD_SEQ
Number(11,0)
FIN_QUARTER
Number(11,0)
The number of the quarter that the date is in. A number from 1 to 4.
BW_JOB_ID
Number(11,0)
ID of the server job that most recently loaded data for this day. This ID is used
by the brick wall feature.
Primary key
FIN_DATE
Foreign keys
FP_PERIOD_SEQ]
FIN_PERIODS
This table contains information about the defined periods. Each record
represents a period within the system calendar. The table is populated through
the user interface.
A financial year can contain up to 100 periods, although it is normal to have 12
in a calendar year.
Table columns
Column name
Data type
Description
FIN_YEAR_ID
Number(11,0)
The ID of the year to which this period applies.
FP_PERIOD_SEQ
Number(11,0)
The internally generated ID of the period.
FP_PERIOD_NAME
VarChar2(50)
The descriptive name of the period.
FP_START_DATE
Date
The start date of the period.
FP_END_DATE
Date
The end date of the period.
182
3
FIN_YEARS
Column name
Data type
Description
FP_CLOSED
Number(1)
Flag indicating whether the period has been closed.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
FP_PERIOD_CODE
VarChar2(50)
A unique user defined code for the period.
FP_TRANS_LOAD
Number(1)
Not used.
FP_NUMBER
Number(11,0)
An internally generated unique ID for the period.
FP_PAYMENT_DATE
Date
Not used.
FP_QTR_END
Number(1)
Flag indicating whether the period represents a quarter end.
-1 - Period represents quarter end
FP_QUARTER
Number(11,0)
The number of the quarter that the date is in. A number from 1 to 4.
Primary key
FIN_YEAR_ID + FP_PERIOD_SEQ
Foreign keys
None.
FIN_YEARS
This table contains financial year information. Each record represents a defined
year. The table is populated through the user interface.
Financial years, quarters, and periods enable event data to be divided up so that
reports and payments can be made at intervals.
A financial year is created by choosing Administration > Financial Years. A
financial year can be less than or greater than a calendar, but make sure that:
•
A new financial year does not overlap with any existing financial year.
•
There are no gaps between the end of an existing financial year and the start
of the new one.
The system performs calculations for all open years whenever any of the data is
changed or new data arrives. When a financial year is closed, calculations no
longer take place for that year. You can, however, reopen a closed financial year.
You can archive a closed financial year providing the previous year is also
closed.
183
3
FLAT_FILES
Table columns
Column name
Data type
Description
FIN_YEAR_ID
Number(11,0)
The internally generated unique ID for the year.
FIN_YEAR_NAME
VarChar2(20)
The name of the year.
FIN_YEAR_START_DATE
Date
The start date of the year.
FIN_YEAR_END_DATE
Date
The end date of the year.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
FY_PUBLIC
Number(1)
Flag indicating whether data for the year can be seen by payees.
-1 - Data for year can be seen by payees
FY_CLOSED
Number(1)
Flag indicating whether the year has been closed.
-1 - Year is closed
WEEK_ROOT_DATE
Date
A date that indicates the first day of week 1 of the year. Only used if
week numbers are being used.
FY_ARCHIVE
Number(11,0)
Flag field set by the user when editing a financial year to indicate
that the year needs archiving.
-1 - Year needs archiving
Primary key
FIN_YEAR_ID
Foreign keys
None.
FLAT_FILES
This table is used by flat file data ports to load incoming data for custom
formatting. Each record represents a row or part of a row from the incoming file.
Table columns
Column name
Data type
Description
DS_NAME
VarChar2(75)
The name of the data port responsible for creating the record.
SEQ
Number
The sequence number of the record.
TEXT
VarChar2(255)
The contents of the line of data.
Primary key
DS_NAME + SEQ
184
3
Foreign keys
None.
This table contains the achievement values ina model. Each record represents
the achievement values in a model section, and is populated via the user
interface.
Table columns
Column name
Data type
Description
TEM_ID
Number(11,0)
VALUE_ID
Number(11,0)
The ID of the model section to which this record applies.
SEQUENCE
Number(11,0)
A sequence number used to distinguish between different
achievement alterations within a model section.
ACHIEVEMENT_TYPE
Number(11,0)
The type of achievement extrapolation to use in the model:
1 - Actual.
2 - Target.
3 - Specified.
4 - Extrapolate QTD.
5 - Extrapolate YTD.
6 - Extrapolate from previous years.
ACHIEVEMENT_CHANGE
Number(15,2)
The percentage change in summary performance to apply.
Primary key
TEM_ID + VALUE_ID + SEQUENCE
Foreign keys
None.
FORECAST_TEMPLATES
This table contains the values of the Model Details section of a model. Each
record represents a single model. The table is populated through the user
interface.
185
3
FORECAST_VALUES
Table columns
Column name
Data type
Description
TEM_ID
Number(11,0)
The internally generated unique ID for the model.
TEM_NAME
VarChar2(50)
The name of the model.
FIN_YEAR_ID
Number(11,0)
The ID of the year.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
VarChar2(50)
TEM_ENABLED
Number(1)
Flag indicating whether the model is active.
-1 - Model is active
TEM_PUBLIC
Number(1)
Flag indicating whether the results of the model are visible to payees.
-1 - Model results are visible to payees
TEM_DATA_SET
Number(11,0)
The global event data set to be used by the model.
TEM_KEEP_PAYMENTS
Number(1)
Flag indicating whether actual payments should be preserved for
payees in the model results.
-1 - Preserve actual payments
Primary key
TEM_ID
Foreign keys
FORECAST_VALUES
This table contains a definition of each section in a model. A section specifies
a set of payees, plans and changes to be modelled.
Each record represents a model section, and is populated via the user interface.
Table columns
Column name
Data type
Description
TEM_ID
Number(11,0)
VALUE_ID
Number(11,0)
The ID of the model section. This also operates as a sequence number.
TARGET_CHANGE
Number(20,8)
No longer used.
OTC_CHANGE
Number(20,8)
No longer used.
BASIC_CHANGE
Number(20,8)
No longer used.
186
3
IMPORT_FILES
Column name
Data type
Description
FREQUENCY
Number(11,0)
The frequency of the achievement changes for this model section:
1 - By Plan
2 - By Quarter
3 - By Period
Primary key
TEM_ID + VALUE_ID
Foreign keys
TEM_ID = FORECAST_TEMPLATES.TEM_ID
IMPORT_FILES
This table contains a mapping of each directory defined by choosing Data >
Manage Files. Each record represents a file currently in the directory. It is
synchronised automatically by the user interface when a user access a directory
in the manage files option.
Table columns
Column name
Data type
Description
IF_ID
Number(11,0)
The internally generated unique ID for the file.
IF_TYPE
Number(11,0)
The ID of the source folder of the file:
1 = Import Directory
2 = Archive Directory
3 = Custom Directory 1
IF_NAME
VarChar2(75)
The name of the file.
IF_DATE
Date
The date and time stamp of the file.
IF_UPLOADED_BY
Number(11,0)
The ID of the user who uploaded the file, if any.
IF_SIZE
Number(11,0)
The size, in bytes, of the file.
IF_SYNCH
Date
Used as part of the synchronisation with the operating system.
IF_DOWNLOADED
Date
The date and time at which the file was last downloaded.
Primary key
IF_ID
187
3
IMPORT_MAPPING
Foreign keys
IF_UPLOADED_BY = USERS.USR_ID
IMPORT_MAPPING
This table contains all fields and expressions mapped to data ports. Each record
represents the assignment of a source field or expression to a data port. The
table is populated through the user interface.
Table columns
Column name
Data type
Description
DS_ID
Number(11,0)
The ID of the data port.
IM_TO_FIELD
VarChar2(50)
The destination field name in the database.
IM_FROM_
FIELD
VarChar2(2000)
The source field name or expression from which to populate the
field.
IM_CONV_LIST_ID
Number(11,0)
The ID of the converter used, if any.
IM_AUTO_CREATE
Number(1)
Flag indicating whether values failing validation against reference
tables should automatically generate new reference entries.
IM_INDEX
Number(1)
Flag indicating whether this is an index field for the purposes of
event duplication checking.
IM_DUP_TYPE
Number(11,0)
-1 - Generate
The methodology to use for duplicate records:
0 - None
1 - Combine
2 - Overwrite
Primary key
DS_ID + IM_TO_FIELD
Foreign keys
IM_CONV_LIST_ID = CONVERSION_LIST_HEADER.CNV_LST_HDR_OD
188
3
INCENTIVES
INCENTIVES
This table contains information about the payee incentives. Each record
represents the start point of an incentive value and/or percentage of basic salary.
The table is populated through the user interface or via data ports.
Table columns
Column name
Data type
Description
EMP_ID
Number(11,0)
FIN_YEAR_ID
Number(11,0)
FP_PERIOD_SEQ
Number(11,0)
INCENTIVE
Number(15,2)
The OTC amount.
PCNT_OF_BASE
Number(20,8)
The OTC percentage of salary.
Primary key
Foreign keys
FP_PERIOD_SEQ]
JOB_DEPENDENTS
This table contains records showing dependencies between server jobs.
Table columns
Column name
Data type
Description
JOB_ID
Number(11,0)
The ID of a job that must wait for the job specified at
DEPENDENT_JOB_ID to complete before it can run.
DEPENDENT_JOB_ID
Number(11,0)
The ID of the job that must complete before the job specified at
JOB_ID can run.
Primary key
JOB_ID + DEPENDENT_JOB_ID
189
3
JOB_MEASUREMENT
Foreign key
DEPENDENT_JOB_ID = JOBS.JOB_ID
JOB_MEASUREMENT
This table holds statistical information about each Calculate job (job type 80)
that has been run. The records in this table are used by the Process Calculation
Batch Summary job (job type 81) to generate summary information for
calculation batches.
Table columns
Column name
Data type
Description
JOB_ID
Numebr(11,0)
The ID of the job.
MEAURE_KEY
VarChar2(200)
A text description of the information being stored:
PLANS_PROCESSED
TRANSACTIONS_PROCESSED
PAYEE_CALCULATION_TIME
MEASURE_TYPE_ID
Number(11,0)
A code indicating the type of information begin recorded:
1 - Time value
2 - Counter value
VALUE
Number(20,8)
The actual value.
Primary key
JOB_ID + MEASURE_KEY
Foreign key
190
3
JOB_TYPES
JOB_TYPES
This table contains a description for each known job type. Each record
represents a job type and the table is used to provide a friendly name for job
types throughout the application. It is built automatically by the server process.
For a description of all the job types, see the System Administration Guide.
Table columns
Column name
Data type
Description
JOB_TYPE
Number(11,0)
The job type code.
JOB_TYPE_NAME
VarChar2(50)
The job type description.
THREAD_TYPE
Number(11,0)
The type of thread to use to run this job type:
0 - Main job queue
1 - Calculations
2 - Synchronization
3 - Reporting
4 - Data processing
5 - Optimizing
6 - Releasing payments and statements
7 - Fast track calculations
8 - Calculator execution
9 - Encryption
10 - Event extension processing
11 - Compiled query processing
Primary key
JOB_TYPE
Foreign keys
JOB_TYPE = JOBS.JOB_TYPE
191
3
JOBS
JOBS
This table is the job queue for the ICM server process. Each record represents a
task required of the server. The table is populated via a combination of user
activity, automated triggers and submissions to the listener. The table contains a
historical record for each task that has been run, and also a record for each task
that is awaiting execution.
Table columns
Column name
Data type
Description
JOB_ID
Number(11,0)
The internally generated ID of the job.
JOB_TYPE
Number(11,0)
The job type.
JOB_SOURCE_RECORD
Number(11,0)
The ID of the source record for the job, if any.
JOB_SOURCE_SUB_RECORD
Number(11,0)
The ID of the source sub record of the job, if any.
FIN_YEAR_ID
Number(11,0)
The ID of the year, if any.
FP_PERIOD_SEQ
Number(11,0)
The ID of the period, if any.
JOB_SUBMITTED_AT
Date
The date and time at which the job was submitted to the
queue.
JOB_SUBMITTED_BY
Number(11,0)
The ID of the user who submitted the job.
JOB_RUN_AT
Date
A date and time prior to which the job must not
execute.
JOB_PARAMETERS
VarChar2(4000)
The parameters required by this job type, if any.
JOB_MAX_RETRIES
Number(11,0)
The maximum number of retries permitted for this job.
JOB_ATTEMPTS
Number(11,0)
Number of attempts made by the server to execute this
job.
JOB_LAST_RUN
Date
The data and time at which the job processing
completed.
JOB_IN_PROGRESS
Number(1)
Flag indicating whether the job is currently in progress.
JOB_COMPLETED
Number(1)
Flag indicating whether the job has completed
successfully.
JOB_ABORTED
Number(1)
Flag indicating whether the job has failed.
-1 - Job in progress
-1 - Job completed successfully
-1 - Job failed
JOB_RESULT
VarChar2(2000)
The job result description.
JOB_PRIORITY
Number(11,0)
The priority code for the job.
ACKNOWLEDGED
Number(1)
Flag indicating whether a failure has been
acknowledged.
JOB_STARTED_AT
Date
The date at which the job was started.
JOB_DURATION
Date
The time that the job took to process.
LSNR_CORRELATION_ID
VarChar2(255)
Not used.
LSNR_SENDING_APP
VarChar2(255)
The tag name of the sending client of the listener.
192
3
JOBS
Column name
Data type
Description
LSNR_ROUTE
VarChar2(255)
The route map from the listener.
LSNR_SENT_REPLY
Number(11,0)
Flag indicating that the listener has replied to the client.
LSNR_TRANSPORT_METHOD
VarChar2(255)
The transport protocol used by the listener to submit
this job.
LSNR_DATA
VarChar2(2000)
XML data containing details about the job (currently
only used for running reports and data ports.
LSNR_ORIGINATOR
VarChar2(255)
The originator ID of the listener message.
LSNR_DATA_LOC
VarChar2(500)
The location of XML message from the listener to be
processed asynchronously.
JOB_RUN_CUST_PROCESS
Number(1)
Flag indicating whether the job has been run as a result
of a customized process.
-1 - Listener has replied to the client
-1 - Job was run as a result of a customized process
JOB_CALLED_BY
Number(11,0)
The ID of the job that created this one, if any.
HIDE_API_TRIGGER
Number(1)
Data Source jobs (job type 40) only. Flag indicating
whether to hide the link in the data port log tab.
THREAD_NAME
VarChar2(25)
Records the name of the server thread that has
processed, or is processing, the job.
JOB_RECORDS_READ
Number(11,0)
Data Source jobs (job type 40) only. The number of
records read by the data port.
JOB_RECORDS_INSERTED
Number(11,0)
records inserted by the data port.
JOB_RECORDS_UPDATED
Number(11,0)
records updated by the data port.
JOB_RECORDS_FAILED
Number(11,0)
records that failed to be processed by the data port.
JOB_RECORDS_DELETED
Number(11,0)
records deleted by the data port.
JOB_RECORDS_IGNORE_RESULTS
Number(11,0)
records ignored by the data port. For example, when
loading payees, if a data port detects a payee record that
is identical to data already in the ICM database, then
this record would be considered to be ignored.
JOB_DURATION_SECONDS
Number(11,0)
The number of seconds that the job ran.
QUEUED_AT
Timestamp(6)
Only used if JMS queueing is used. The date and time at
which the job was put on the JMS queue.
JOB_DURATION_MILLIS
Number(24,0)
The number of milliseconds that the job ran.
JOB_SUBMITTED_BY_DELEGATE_ID
Number(11,0)
The ID of the delegate user that submitted the job, if
any.
Primary key
JOB_ID
Foreign keys
JOB_CALLED_BY = JOBS.JOB_ID
193
3
LEDGER_EMP
JOB_SUBMITTED_BY = USERS.USR_ID
FP_PERIOD_SEQ]
LEDGER_EMP
This table holds the payee level ledger. LEDGER_EMP holds all payee level
entries not just those for the current year (unlike the LEDGER_PLAN and
LEDGER_TRAN views).
At the end of each period, NICE ICM rolls up the earnings and payee level
adjustments and draws for each payee and writes a single summary record for
the payee to this table.
When NICE ICM writes changed records to LEDGER_EMP, it also copies the
matching old records to LEDGER_EMP_ARCHIVE to maintain a historical
record of changes.
For more on how NICE ICM uses LEDGER_PLAN, see “Data flow in NICE ICM”
on page 16.
NICE ICM also maintains an event level and plan level ledger in the
LEDGER_TRAN and LEDGER_PLAN views.
NOTE: At releases earlier than 4.2, the ledger consisted of a single table
containing event, plan, and payee level entries called LEDGER_TRAN.
Table columns
Column name
Data type
Description
EMP_ID
Number(24,0)
LEG_DATE
Date
financial period.
LEG_TYPE
VarChar2(50)
LEG_VALUE_TYPE
Number(24,0)
•
•
•
1 - Debit
2 - Credit
3 - Pending
REJ_ID
Number(24,0)
LEG_POSTED
Date
The date at which the posting was made.
LEG_DESCRIPTION
VarChar2(255)
194
3
LEDGER_EMP_ARCHIVE
Column name
Data type
Description
LEG_VALUE
Number(32,15)
PB_ID
Number(24,0)
LEG_VALUE_BASE
Number(32,15)
LEG_CUR_ID
Number(24,0)
LEG_JOB_ID
Number(24,0)
IS_PA_ENTRY
Number(24,0)
adjustments.
IS_DRAW_ENTRY
Number(24,0)
Primary key
EMP_ID + LEG_DATE + LEG_TYPE + LEG_VALUE_TYPE + LEG_JOB_ID
Foreign key
IS_PA_ENTRY = PAY_ADJUST.PA_ID
IS_DRAW_ENTRY = EMPLOYEE_DRAW.DRAW_ID
LEDGER_EMP_ARCHIVE
This table contains a historical record of changed entries from the
LEDGER_EMP table. When a payment batch is released, NICE ICM also writes a
debit record of type PENDING to the LEDGER_EMP table for payee level draws and
adjustments for each transaction in the payment batch.
Table columns
Column name
Data type
Description
EMP_ID
Number(24,0)
LEG_DATE
Date
financial period.
LEG_TYPE
VarChar2(50)
•
•
•
195
3
LEDGER_EMP_CALC_JOB
Column name
Data type
Description
LEG_VALUE_TYPE
Number(24,0)
1 - Debit
2 - Credit
3 - Pending
REJ_ID
Number(24,0)
LEG_POSTED
Date
LEG_DESCRIPTION
VarChar2(255)
LEG_VALUE
Number(32,15)
PB_ID
Number(24,0)
LEG_VALUE_BASE
Number(32,15)
LEG_CUR_ID
Number(24,0)
LEG_JOB_ID
Number(24,0)
LEG_ARCHIVED
Date
IS_PA_ENTRY
Number(24,0)
adjustments.
IS_DRAW_ENTRY
Number(24,0)
Primary key
EMP_ID + LEG_DATE + LEG_TYPE + LEG_VALUE_TYPE + LEG_ARCHIVED +
LEG_JOB_ID
Foreign key
LEDGER_EMP_CALC_JOB
This table is used by the Remove and archive dirty data job (job type 139) to
determine which duplicate entries to move from LEDGER_EMP to
LEDGER_EMP_ARCHIVE.
Table columns
Column name
Data type
Description
CALC_JOB_ID
Number(11,0)
ID of the job that last calculated this entry.
EMP_ID
Number(11,0)
ID of the payee for the LEDGER_EMP entry.
196
3
LEDGER_PLAN
Primary key
CALC_JOB_ID + EMP_ID
Foreign key
CALC_JOB_ID = JOBS.JOB_ID
LEDGER_PLAN
This view holds the plan level ledger. It holds the entries for the current year.
Entries older than a year are held in the LEDGER_PLAN_HISTORY table.
The ledger is built as part of the calculation process. For each payee and plan
combination, NICE ICM rolls up the earnings for all events into a single record
per day and add it to this view. When NICE ICM writes a changed record to the
view, it writes the corresponding old record to LEDGER_PLAN_ARCHIVE to
maintain a history of the changes.
When a payment batch is released, NICE ICM also writes a debit record of type
PENDING to the LEDGER_PLAN view for earnings and plan level draws and
adjustments for each transaction in the payment batch to offset each entry in
the batch. If the batch is accepted, NICE ICM then:
•
Moves the PENDING record to the LEDGER_PLAN_ARCHIVE view.
•
Adds a debit record of type PAYMENT to the LEDGER_PLAN view and
LEDGER_EMP table for each transaction in the payment batch to offset each
earning entry in the batch so that the earning entry cannot be used in future
batches.
If the batch is declined, NICE ICM then moves the PENDING record to the
LEDGER_PLAN_ARCHIVE view. This enables the original earning record to be
used in another payment batch.
For more on how NICE ICM uses LEDGER_PLAN, see “Data flow in NICE ICM”
on page 16.
The view is made up of an SQL query on the following tables:
•
CURRENT_LEDGER_PLANn (holds records less than a year old)
•
LEDGER_PLAN_HISTORY (holds records over a year old)
NICE ICM also maintains a payee level and event level ledger in the
LEDGER_EMP table and LEDGER_TRAN view.
197
3
LEDGER_PLAN_ARCHIVE
LEDGER_PLAN_ARCHIVE
This view contains archived entries from the plan level ledger, LEDGER_PLAN.
When NICE ICM writes a changed entry to LEDGER_PLAN, it also writes the old
entry to the LEDGER_PLAN_ARCHIVE view to maintain a history of the
changes.
•
CURRENT_LEDGER_PLAN_ARCHIVEn (holds records less than a year old)
•
LEDGER_PLAN_ARCHIVE_HISTORY (holds records over a year old)
LEDGER_PLAN_ARCHIVE_HISTORY
This table contains records from the LEDGER_PLAN_ARCHIVE view that are
over a year old.
Table columns
Column name
Data type
Description
EMP_ID
Number(24,0)
PLN_ID
Number(24,0)
LEG_DATE
Date
financial period.
LEG_TYPE
VarChar2(50)
LEG_VALUE_TYPE
Number(24,0)
•
•
•
1 - Debit
2 - Credit
3 - Pending
REJ_ID
Number(24,0)
LEG_POSTED
Date
LEG_DESCRIPTION
VarChar2(255)
LEG_VALUE
Number(32,15)
PB_ID
Number(24,0)
LEG_VALUE_BASE
Number(32,15)
LEG_CUR_ID
Number(24,0)
LEG_JOB_ID
Number(24,0)
LEG_ARCHIVED
Date
198
3
LEDGER_PLAN_CALC_JOB
Column name
Data type
Description
IS_PA_ENTRY
Number(24,0)
adjustments.
IS_DRAW_ENTRY
Number(24,0)
Primary key
EMP_ID + PLN_ID + LEG_DATE + LEG_TYPE + LEG_VALUE_TYPE + LEG_ARCHIVED +
LEG_JOB_ID
Foreign key
LEDGER_PLAN_CALC_JOB
determine which duplicate entries to move from LEDGER_PLAN to
LEDGER_PLAN_ARCHIVE.
Table columns
Column name
Data type
Description
CALC_JOB_ID
Number(11,0)
ID of the job that last calculated the entry in LEDGER_PLAN for the
specified plan and payee combination.
PLN_ID
Number(11,0)
ID of the plan for the entry.
EMP_ID
Number(11,0)
ID of the payee for the entry.
Primary key
CALC_JOB_ID + PLN_ID
Foreign key
199
3
LEDGER_PLAN_HISTORY
LEDGER_PLAN_HISTORY
This table contains records from the LEDGER_PLAN view that are over a year
old.
Table columns
Column name
Data type
Description
EMP_ID
Number(24,0)
PLN_ID
Number(24,0)
LEG_DATE
Date
financial period.
LEG_TYPE
VarChar2(50)
LEG_VALUE_TYPE
Number(24,0)
•
•
•
1 - Debit
2 - Credit
3 - Pending
REJ_ID
Number(24,0)
LEG_POSTED
Date
LEG_DESCRIPTION
VarChar2(255)
LEG_VALUE
Number(32,15)
PB_ID
Number(24,0)
LEG_VALUE_BASE
Number(32,15)
LEG_CUR_ID
Number(24,0)
LEG_JOB_ID
Number(24,0)
IS_PA_ENTRY
Number(24,0)
adjustments.
IS_DRAW_ENTRY
Number(24,0)
Primary key
EMP_ID + PLN_ID + LEG_DATE + LEG_TYPE + LEG_VALUE_TYPE + LEG_JOB_ID
Foreign key
200
3
LEDGER_TRAN
LEDGER_TRAN
This view holds the event level ledger. It holds the entries for the current year.
Entries older than a year are held in the LEDGER_TRAN_HISTORY table.
The ledger is built as part of the calculation process. Unlike the ledger used in
earlier ICM releases, the entries are a single summary record for each payee, plan
and event combination, rather than multiple records recording the differences
for each calculation change. From NICE ICM 4.2 onwards, when NICE ICM
writes a changed entry to the ledger, it also writes the old entry to the
LEDGER_TRAN_ARCHIVE view to maintain a history of the changes.
•
CURRENT_LEDGER_TRANn (holds records less than a year old)
•
LEDGER_TRAN_HISTORY (holds records over a year old)
NICE ICM also maintains a payee level and plan level ledger in the
LEDGER_EMP table and LEDGER_PLAN view.
LEDGER_TRAN_ARCHIVE
This view contains archived entries from the event level ledger, LEDGER_TRAN.
From NICE ICM 4.2 onwards, when NICE ICM writes a changed entry to
LEDGER_TRAN, it also writes the old entry to the LEDGER_TRAN_ARCHIVE
view to maintain a history of the changes.
•
CURRENT_LEDGER_TRAN_ARCHIVEn (holds records less than a year old)
•
LEDGER_TRAN_ARCHIVE_HISTORY (holds records over a year old)
201
3
LEDGER_TRAN_ARCHIVE_HISTORY
LEDGER_TRAN_ARCHIVE_HISTORY
This table contains records from the LEDGER_TRAN_ARCHIVE view that are
over a year old.
Table columns
Column name
Data type
Description
EMP_ID
Number(24,0)
PLN_ID
Number(24,0)
TRN_ID
Number(24,0)
LEG_DATE
Date
financial period.
LEG_TYPE
VarChar2(50)
LEG_VALUE_TYPE
Number(24,0)
•
•
•
1 - Debit
2 - Credit
3 - Pending
REJ_ID
Number(24,0)
LEG_POSTED
Date
LEG_DESCRIPTION
VarChar2(255)
LEG_VALUE
Number(32,15)
PB_ID
Number(24,0)
The ID of the payment batch associated with the ledger posting, if
any.
LEG_VALUE_BASE
Number(32,15)
LEG_CUR_ID
Number(24,0)
LEG_JOB_ID
Number(24,0)
LEG_ARCHIVED
Date
The date the entry was archived.
PA_ID
Number(24,0)
The ID of the adjustment associated with the ledger posting, if any.
DRAW_ID
Number(24,0)
The ID of the draw associated with the ledger posting, if any.
Primary key
LEG_JOB_ID
Foreign key
202
3
LEDGER_TRAN_CALC_JOB
LEDGER_TRAN_CALC_JOB
determine which duplicate entries to move from LEDGER_TRAN to
LEDGER_TRAN_ARCHIVE.
Table columns
Column name
Data type
Description
CALC_JOB_ID
Number(11,0)
ID of the job that last calculated the entry in LEDGER_TRAN for the
specified plan and payee combination
PLN_ID
Number(11,0)
ID of the plan for the entry.
EMP_ID
Number(11,0)
ID of the payee for the entry.
Primary key
CALC_JOB_ID + PLN_ID
Foreign key
LEDGER_TRAN_CLOSED
203
3
LEDGER_TRAN_HISTORY
LEDGER_TRAN_HISTORY
This table contains records from the LEDGER_TRAN view that are over a year
old.
Table columns
Column name
Data type
Description
EMP_ID
Number(24,0)
PLN_ID
Number(24,0)
TRN_ID
Number(24,0)
LEG_DATE
Date
financial period.
LEG_TYPE
VarChar2(50)
•
•
•
LEG_DESCRIPTION
VarChar2(255)
LEG_VALUE
Number(32,15)
PB_ID
Number(24,0)
LEG_VALUE_TYPE
Number(24,0)
1 - Debit
2 - Credit
3 - Pending
PA_ID
Number(24,0)
The ID of the adjustment associated with the ledger posting, if any.
LEG_POSTED
Date
LEG_VALUE_BASE
Number(32,15)
DRAW_ID
Number(24,0)
The ID of the draw associated with the ledger posting, if any.
LEG_CUR_ID
Number(24,0)
REJ_ID
Number(24,0)
LEG_JOB_ID
Number(24,0)
Primary key
LEG_JOB_ID
Foreign key
204
3
LEDGER_TRAN_MANAGED
LEDGER_TRAN_MANAGED
LOCKS
This table is an internal table used by NICE ICM to ensure that only one of a
particular job type is created with particular parameters. Currently, the table is
only used for rank plans jobs to make sure that only one rank plans job is
created for a particular plan template.
LOG_FILES
This table records the log files available for viewing through the ICM Admin
user interface. Each record represents one of the application log files defined on
the System Path configuration tab of ICM Admin. Choose Administration >
System Configuration > System Path to access this tab.
Table columns
Column name
Data type
Description
LF_ID
Number(11,0)
The internally generated unique ID of the log file.
LF_NAME
VarChar2(50)
The name of the log file.
LF_GROUP
VarChar2(50)
The group to which the log file belongs.
LF_LOCATION
VarChar2(255)
The location of the log file.
Primary key
LF_ID
Foreign keys
None.
MANAGEMENT_STATEMENTS
205
3
MANAGER_APPROVALS
MANAGER_APPROVALS
MANUAL_PLAN_RESULTS
This table contains all manual plan results entered by managers. Each record
represents the manual result for a plan, for a payee, for a period. The table is
populated via the user interface or via data ports.
Table columns
Column name
Data type
Description
FP_PERIOD_SEQ
Number(11,0)
EMP_ID
Number(11,0)
FIN_YEAR_ID
Number(11,0)
The ID of the year.
PLN_ID
Number(11,0)
The ID of the plan.
MPR_RESULT
Number(20,8)
The result value assigned by the manager.
FCST_ID
Number(11,0)
Primary key
FIN_YEAR_ID + EMP_ID + FP_PERIOD_SEQ + PLN_ID + FCST_ID
Foreign keys
FP_PERIOD_SEQ]
MI_ ...
Tables beginning MI_ are internal tables used by NICE ICM to store information
for use by the optional SCA component.
206
3
MIGRATION_LOG
MIGRATION_LOG
This table records the use of the ICM Admin migration feature.
For more information on the migration feature, see the System Administration
Guide.
Table columns
Column name
Data type
Description
USER_ID
Number(11,0)
The ID of the user that performed the migration.
MIG_TYPE
Number(11,0)
The type of migration:
1 - Import
2 - Export
FILE_NAME
VarChar2(255)
The full path to the migration file involved in the migration. For an export, the
file is created by the migration. For an import, an existing file is read by the
migration.
MIG_DATE
Date
The date of the migration.
Primary key
None.
Foreign keys
USER_ID = USERS.USR_ID
MODEL_ ...
Tables beginning MODEL_ are used by the NICE ICM modelling feature. Their
structure and use is the same as the corresponding live table, but with an
additional field to identify the model being used.
MOST_RECENTLY_USED
207
3
MRU
MRU
This table contains most recently used items in ICM Admin against users. Each
record represents a recently loaded record by a user and is used to populate the
Most Recently Used (MRU) area in the ICM Admin user interface.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user for which the MRU record applies.
USR_EMPLOYEE
Number(1)
Flag indicating whether the user is a payee.
USR_CONTACT
Number(11,0)
No longer used.
MRU_TYPE
VarChar2(20)
The identifying code for the MRU context.
MRU_DATE
Date
The date and time that the MRU item was last used.
MRU_ID
Number(11,0)
The ID of the record that the MRU refers to.
-1 - User is a payee
Primary key
USR_ID + USR_EMPLOYEE + USR_CONTACT + MRU_TYPE + MRU_ID
Foreign keys
NON_WORKING_DAYS
This table represents days that should not be included in date duration
calculations. Each record represents a day that is set as non working. It can only
be populated through SQL.
Table columns
Column name
Data type
Description
NON_WORKING_DATE
Date
The date of the non working day.
FIN_YEAR_ID
Number(11,0)
The ID of the year.
FP_PERIOD_SEQ
Number(11,0)
FIN_DAY_NUM
Number(11,0)
The sequential number of the non working day in the year.
DESCRIPTION
VarChar2(255)
The description of the non working day.
208
3
NOT_AGAIN
Primary key
NON_WORKING_DATE
Foreign keys
FP_PERIOD_SEQ]
NOT_AGAIN
This table is used to store a user request to suppress the appearance of help
items, bulletins and other notification areas in the ICM Admin user interface.
Each record represents a request for suppression by a user.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user.
USR_EMPLOYEE
Number(1)
No longer used.
USR_CONTACT
Number(11,0)
No longer used.
NA_TYPE
VarChar2(20)
The context code of the suppression.
NA_ID
Number(11,0)
The ID of the record associated with the suppression.
Primary key
USR_ID + USR_EMPLOYEE + USR_CONTACT + NA_TYPE + NA_ID
Foreign keys
USR_ID = USERS.USER_ID
NOTE_ATTACHMENTS
This table contains note attachment files uploaded against records by users.
Each record represents a note attachment file.
Table columns
Column name
Data type
TABLE_NAME
VarChar2(50)
Description
The table to which the data record belongs such as AUTH_REQUESTS or
PAYMENT_BATCHES.
209
3
NOTES
Column name
Data type
Description
RECORD_ID
VarChar2(255)
The compound record ID of the associated data record.
SEQUENCE_NUMBER
Number(11,0)
The sequence number for this attachment within the list of attachments.
FILENAME
VarChar2(255)
The file name of the file displayed to the user.
ATTACHMENT
BLOB
The attached file.
Primary key
None.
Foreign keys
None.
NOTES
This table contains notes entered against records by users. Each record
represents a private or public note.
Table columns
Column name
Data type
Description
TABLE_NAME
VarChar2(50)
The table that the data record belongs to.
RECORD_ID
VarChar2(50)
The compound record ID of the associated data record.
NOTE_TEXT
VarChar2(2000)
The note content.
Primary key
TABLE_NAME + RECORD_ID
Foreign keys
OPTIMISER_ ...
Tables beginning OPTIMISER_ are legacy tables that used to be used when
optimizing jobs were run. These tables and jobs are no longer used.
OTE_WORKSHEET
210
3
PAL_COUNTER
PAL_COUNTER
This table is used by the system to maintain the next available ID against any
ICM database tables requiring an internally generated ID. It also stores the
status of a number of system elements, such as the ICM database schema
version numbers.
Table columns
Column name
Data type
Description
TABLE_NAME
VarChar2(50)
The name of the table or context code to which the next available ID relates.
NEXT_ID
Number(11,0)
The next available ID, or status indicator.
Primary key
TABLE_NAME
Foreign keys
None.
PARAMETER_LANGUAGES
This table contains configuration parameters for multilingual support in ICM
Admin.
Table columns
Column name
Data type
Description
PARAM_ID
Number(11,0)
The internally generated unique identifier for the parameter.
LANGUAGE_CODE
VarChar2(5)
The language ID.
SP_PARAMETER
VarChar2(50)
The parameter code.
TEXT_SINGULAR
VarChar2(4000)
The singular word in the given language.
TEXT_PLURAL
VarChar2(4000)
The plural word in the given language.
Primary key
PARAM_ID
Foreign keys
None.
211
3
PAY_ADJUST
PAY_ADJUST
This table stores all adjustments and adjustment templates. Each record
represents an adjustment or adjustment template. The table is populated via the
user interface, via data ports, or via a Synchronize Adjustments server job
automatically creating payment adjustments from an adjustment template. For
information on this job, see “Job type 19 - Synchronize adjustments” in the
Table columns
Column name
Data type
Description
PA_ID
Number(11,0)
The internally generated unique ID for the adjustment.
FIN_YEAR_ID
Number(11,0)
The ID of the year.
FP_PERIOD_SEQ
Number(11,0)
EMP_ID
Number(11,0)
PA_ADJUSTMENT
Number(15,2)
The adjustment amount in the specified currency.
PA_DESCRIPTION
VarChar2(255)
The description of the adjustment.
PA_RECOVERABLE
Number(1)
No longer used.
PA_CREATED
Date
The date and time at which the adjustment was created.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
FCST_ID
Number(11,0)
CUR_ID
Number(11,0)
The ID of the currency of the adjustment.
FCST_USR
Number(11,0)
No longer used.
PA_PAID
Number(15,2)
No longer used.
COMM_OVERRIDE
Number(1)
No longer used.
TRN_FIELD
VarChar2(50)
No longer used.
PA_INVOICE
Number(1)
No longer used.
PLN_ID
Number(11,0)
The ID of the plan, if any.
TRN_ID
Number(11,0)
The ID of the event, if any.
ADJ_DATE
Date
The date of the adjustment.
ADJ_RECOVERY_DATE
Date
No longer used.
PA_UD1 to PA_UD5
VarChar2(50)
The value of custom adjustment field 1 to 5.
0 indicates no model is being used.
ADJ_PAYMENT
Number(1)
Flag indicating whether the adjustment is to be paid off line.
PA_UD6 to PA_UD20
VarChar2(50)
The value of custom adjustment field 6to 20.
ADJ_TAX_GROUP
Number(11,0)
The ID of the default tax group for the element.
ADJ_TAX_CODE
Number(11,0)
The ID of the default tax band for the element. Alternatively., the
value can be:
-1 - The tax band is inherited from a payee
-2 - The tax band is inherited from a plan
212
3
PAY_RECOVERY
Column name
Data type
Description
PA_TEMPLATE_ID
Number(11,0)
The ID of the payment adjustment template that this record has
been generated from. Alternatively, the value can be:
0 - This record is a manual payment adjustment
-1 - This record is a payment adjustment template
Primary key
PA_ID
Foreign keys
FP_PERIOD_SEQ]
ADJ_TAX_GROUP = TAX_GROUPS.TAX_GROUP_ID
ADJ_TAX_CODE = TAX_BANDS.TAX_ID
PAY_RECOVERY
PAYMENT_BATCH_AUTH
This table contains all authorizations for a payment batch. Each record
represents a single authorization for a payment batch. The table is populated
when a payment batch is authorized by a user.
Table columns
Column name
Data type
Description
BATCH_ID
Number(11,0)
AUTH_LEVEL
Number(11,0)
The authorization level.
AUTH_SEQ
Number(11,0)
The sequence of the authorization within the authorization level
specified at AUTH_LEVEL.
AUTH_BY
Number(11,0)
The ID of the user that authorized the payment batch.
AUTH_DATE
Date
The date of authorization.
Number(11,0)
The ID of the delegate user that authorized the payment batch, if
any.
213
3
Primary key
BATCH_ID + AUTH_LEVEL + AUTH_SEQ
Foreign keys
BATCH_ID = PB_ID.PAYMENT_BATCHES
The table contains the values at a payee level within a previewed payment batch.
Each record represents the amount that would be paid to a payee within the
payment batch. The table is populated when a user previews a payment batch.
The entries are updated the next time a user previews a payment batch.
NOTE: Previewing a payment batch does not create the payment batch. There
may be differences in the payment amounts when the payment batch is
created if calculation changes have occurred between previewing and
creating the batch.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user previewing the payment batch.
EMP_ID
Number(11,0)
AMOUNT_TO_PAY
Number(15,2)
The total amount to pay the payee in the batch.
APPROVED
Number(1,0)
Flag indicating whether the payment has been approved.
TAX_TO_PAY
Number(15,2)
The amount of tax due on the amount to be paid if a tax rate is
available.
TAX_RATE
Number(20,8)
TAX_BAND
Number(11,0)
The ID of the tax band associated with this record.
AMOUNT_TO_PAY_BASE
Number(32,15)
The total amount to pay the payee in the base currency.
TAX_TO_PAY_BASE
Number(32,15)
The amount of tax due in the base currency.
Primary key
USR_ID + EMP_ID
Foreign key
214
3
The table contains the values at a payee level within a payment batch. Each
record represents the amount to pay to a payee within the payment batch. The
table is populated when a payment batch is submitted.
Table columns
Column name
Data type
Description
PB_ID
Number(11,0)
EMP_ID
Number(11,0)
AMOUNT_TO_PAY
Number(15,2)
The total amount to pay the payee in the batch.
APPROVED
Number(11,0)
Flag indicating whether the payment has been approved.
TAX_TO_PAY
Number(15,2)
available.
REJ_ID
Number(11,0)
The ID of the rejection, if any.
TAX_RATE
Number(20,8)
TAX_BAND
Number(11,0)
AMOUNT_TO_PAY_BASE
Number(32,15)
TAX_TO_PAY_BASE
Number(32,15)
Primary key
PB_ID + EMP_ID + TAX_BAND + REJ_ID
Foreign keys
PAYMENT_BATCH_PLANS
The table contains the values at a plan level within a payment batch. Each
record represents the amount to pay to a payee for a plan within the payment
batch. The table is populated when a payment batch is submitted.
Table columns
Column name
Data type
Description
PB_ID
Number(11,0)
215
3
Column name
Data type
Description
EMP_ID
Number(11,0)
PLN_ID
Number(11,0)
The ID of the plan.
AMOUNT_TO_PAY
Number(15,2)
The total amount to pay the payee against the plan.
TAX_TO_PAY
Number(15,2)
available.
TAX_RATE
Number(20,8)
REJ_ID
Number(11,0)
TAX_BAND
Number(11,0)
AMOUNT_TO_PAY_BASE
Number(32,15)
TAX_TO_PAY_BASE
Number(32,15)
Primary key
PB_ID + EMP_ID + PLN_ID + TAX_BAND + REJ_ID
Foreign keys
The table contains the values at a plan level within a previewed payment batch.
Each record represents the amount that would be paid to a payee for a plan
within the payment batch. The table is populated when a user previews a
payment batch.
The entries are updated the next time a user previews a payment batch.
NOTE: Previewing a payment batch does not create the payment batch. There
may be differences in the payment amounts when the payment batch is
created if calculation changes have occurred between previewing and
creating the batch.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user who is previewing the payment batch.
EMP_ID
Number(11,0)
PLN_ID
Number(11,0)
The ID of the plan.
AMOUNT_TO_PAY
Number(15,2)
The total amount to pay the payee against the plan.
216
3
Column name
Data type
Description
TAX_TO_PAY
Number(15,2)
available.
TAX_RATE
Number(20,8)
TAX_BAND
Number(11,0)
AMOUNT_TO_PAY_BASE
Number(32,15)
TAX_TO_PAY_BASE
Number(32,15)
Primary key
USR_ID + EMP_ID + PLN_ID
Foreign key
USR_ID =
EMP_ID =
PLN_ID =
TAX_BAND
USERS.USR_ID
EMPLOYEES.EMP_ID
PLANS.PLN_ID
= TAX_BANDS.TAX_ID
The table contains the values at a plan and event level within a payment batch.
Each record represents the amount to pay to a payee for events within the plan
and payment batch. It also contains plan and payee level records that represent
the difference between event earnings and the higher levels. The table is
populated when a payment batch is submitted.
Table columns
Column name
Data type
Description
PB_ID
Number(11,0)
EMP_ID
Number(11,0)
PLN_ID
Number(11,0)
The ID of the plan.
TRN_ID
Number(11,0)
PA_ID
Number(11,0)
The ID of the associated payment adjustment, if any.
REJ_ID
Number(11,0)
AMOUNT_TO_PAY
Number(15,2)
The amount to pay the payee against the plan and event.
TAX_RATE
Number(20,8)
TAX_TO_PAY
Number(15,2)
The amount of tax due on the amount to be paid if a tax rate is available.
DRAW_ID
Number(11,0)
The ID of the associated draw, if any.
TAX_GROUP
Number(11,0)
The ID of the tax group associated with this record.
TAX_BAND
Number(11,0)
EARNING_DATE
Date
The date copied from the effective date of the associated event.
217
3
PAYMENT_BATCHES
Column name
Data type
Description
BM_ID
Number(11,0)
The bookmark ID, or null if this entry was not generated from a bookmark.
Primary key
PB_ID + EMP_ID + PLN_ID + TRN_ID + PA_ID + DRAW_ID + REJ_ID + TAX_BAND
+ ENTRY_TYPE
Foreign keys
BM_ID = BOOKMARKS.BM_ID
PAYMENT_BATCHES
This table contains payment batches. Each record represents a payment batch
and its associated status. The table is populated when a payment batch is
created.
Table columns
Column name
Data type
Description
PB_ID
Number(11,0)
The internally generated unique ID for the batch.
FIN_YEAR_ID
Number(11,0)
The ID of the year.
FP_PERIOD_SEQ
Number(11,0)
NUMBER_EMPLOYEES
Number(11,0)
The number of payees affected by this batch.
SUBMITTED_DATE
Date
The date and time at which the batch was originally
submitted.
SUBMITTED_BY
Number(11,0)
The ID of the user who originally submitted the batch.
SUBMITTED_NOTES
VarChar2(2000)
The notes entered by the submitting user, if any.
APPROVED
Number(1)
Flag indicating whether the payment batch has been
approved.
APPROVED_DATE
Date
The date and time at which the batch was approved.
APPROVED_BY
Number(11,0)
The ID of the approving user.
APPROVED_NOTES
VarChar2(2000)
The notes entered by the authorizing users, if any.
DECLINED
Number(1)
-1 - Batch has been approved
Flag indicating whether the batch has been declined.
-1 - Batch has been declined
DECLINED_DATE
Date
The date and time at which the batch was declined.
218
3
PAYMENT_BATCHES
Column name
Data type
Description
DECLINED_BY
Number(11,0)
The ID of the user who declined the batch.
DECLINED_NOTES
VarChar2(2000)
The notes entered by the declining user, if any.
RELEASED
Number(1)
Flag indicating whether the batch has been released.
-1 - Batch has been released
AUTH_LEVEL_1
Number(1)
Flag indicating whether the batch has been approved at level
1.
-1 - Batch has bee approved at level 1
AUTH_LEVEL_1_BY
Number(11,0)
The ID of the user who approved the batch at level 1.
AUTH_LEVEL_1_DATE
Date
The date and time at which the batch was approved at level
1.
AUTH_LEVEL_2
Number(1)
2.
AUTH_LEVEL_2_BY
Number(11,0)
The ID of the user who approved the batch at level 2
AUTH_LEVEL_2_DATE
Date
2.
AUTH_LEVEL_3
Number(1)
3.
AUTH_LEVEL_3_BY
Number(11,0)
AUTH_LEVEL_3_DATE
Date
3.
AUTH_LEVEL_4
Number(1)
4.
AUTH_LEVEL_4_BY
Number(11,0)
AUTH_LEVEL_4_DATE
Date
4.
AUTH_LEVEL_5
Number(1)
5.
AUTH_LEVEL_5_BY
Number(11,0)
AUTH_LEVEL_5_DATE
Date
5.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
AUTH_MANAGERS
Number(1)
No longer used.
INVOICE_DATE
Date
The date to use when calculating tax.
PB_REPORT
Number(11,0)
No longer used.
PB_PAYMENT_REFERENCE
VarChar2(50)
The payment reference, if any.
PAYMENT_DATE
Date
The effective date of the payment batch.
AUTH_ID
Number(11,0)
The ID of the authorization rule used to approve the batch.
PB_OFFLINE
Number(1)
Flag indicating whether the payment batch should only
include offline adjustments.
-1 - Batch should only include offline adjustments
219
3
PAYROLL
Column name
Data type
Description
PB_INCLUDE
Number(11,0)
Indicator as to which type of payments should be included:
0 - All
1 - Positive
2 - Negative
USE_BOOKMARK
Number(1)
Flag indicating whether the payment batch has been
generated using the latest available bookmark.
-1 - Batch has been generated using the latest available
bookmark
PAYMENT_START_DATE
DATE
The start date of this payment batch.
Number(11,0)
The ID of the delegate user that submitted the batch, if any.
Number(11,0)
The ID of the delegate user that declined the batch, if any.
Number(11,0)
The ID of the delegate user that approved the batch, if any.
Primary key
PB_ID
Foreign keys
FP_PERIOD_SEQ]
PAYROLL
This table contains payment systems and associated payment file formats. Each
record represents a payment system.
Table columns
Column name
Data type
Description
PR_ID
Number(11,0)
The internally generated unique identifier for the payment system.
PAYROLL_NAME
VarChar2(100)
The name of the payment system.
FILE_CODE
VarChar2(50)
The code to use to make up the payment file name.
FILE_HEADER
VarChar2(2000)
The content structure of the payment file header, if any.
FILE_CONTENT
VarChar2(2000)
The content structure of each payment file record.
FILE_FOOTER
VarChar2(2000)
The content structure of the payment file footer, if any.
FILE_EXTENSION
VarChar2(3)
The extension name of the payment file.
SEND_TO
VarChar2(255)
The destination address for the payment file.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
220
3
PLAN_CALC_INPUTS
Column name
Data type
Description
SHOW_DECIMAL
Number(1)
Flag indicating whether values in the payment file should include a
decimal place.
TEMPLATE_FILE
VarChar2(75)
The template file to base the payment batch file on.
FILE_TYPE
Number(11,0)
The type of payroll file to produce:
-1 - Payment file should include decimal place
0 - Text
1 - Excel
2 - Word
3 - Report
REPORT_ID
Number(11,0)
Only used if the type of payroll file is Report (3). The ID of the report
to run.
Primary key
PR_ID
Foreign keys
None.
PLAN_CALC_INPUTS
This table contains the values entered against ASK functions in calculators at the
plan level. Each record represents a value entered on, or synchronised with, a
plan against an ASK value.
Table columns
Column name
Data type
Description
PLN_ID
Number(11,0)
The ID of the plan.
CALC_ID
Number(11,0)
INPUT_NAME
VarChar2(100)
The ASK function name.
INPUT_VALUE
VarChar2(100)
The ASK function value.
Primary key
PLN_ID + CALC_ID + INPUT_NAME
Foreign keys
221
3
PLAN_ELEMENTS
PLAN_ELEMENTS
This table contains the additional elements assigned to plans. Each record
represents a plan addition against a plan. The table is populated by the user
interface and the plan template synchronization process.
Table columns
Column name
Data type
Description
PLN_ID
Number(11,0)
The ID of the plan.
ELEMENT_TYPE
Number(11,0)
Indicator as to the type of plan addition:
3 - SPIF
4 - Calculator
5 - Clawback
ELEMENT_ID
Number(11,0)
The ID of the plan addition record.
ELEMENT_OPTIONS
VarChar2(2000)
No longer used.
Primary key
PLN_ID + ELEMENT_TYPE + ELEMENT_ID
Foreign keys
PLAN_GROUP_ORDER
This table contains the sequence by which plan groups will be displayed. Each
record represents a plan group and its sequence within the order. The table is
populated through the system administration options.
Table columns
Column name
Data type
Description
SEQUENCE
Number(11,0)
The sequence of the plan group.
PLN_GROUP
VarChar2(100)
The plan group name.
WZ_ID
Number(11,0)
Reference to the parameter maintenance code for plan related parameters.
Primary key
SEQUENCE
222
3
PLAN_GROUPS
Foreign keys
WZ_ID = WIZARD_NAMES.WZ_ID
PLAN_GROUPS
This table contains a record for each current plan group, and associates an ID
with it. The table is populated every time a plan group is added or changed on a
plan.
Table columns
Column name
Data type
Description
PG_ID
Number(11,0)
The internally generated unique ID for the plan group.
PLN_GROUP
VarChar2(75)
The name of the plan group.
Primary key
PG_ID
Foreign keys
None.
PLAN_ORDER
PLAN_RELATIONS
This table contains a record for each plan instance of a plan template for each
payee within a financial year. A payee can sometimes be removed from a plan
template, for example because a non-historical field changes. If this happens
and the payee is then restored to the plan, the system uses the entry in this table
to ensure that the plan assigned to the payee is given the same ID as before.
Table columns
Column name
Data type
Description
PLN_TEMPLATE_ID
Number(11,0)
The ID of the plan template.
223
3
PLAN_RESULTS
Column name
Data type
Description
EMP_ID
Number(11,0)
The ID of the payee associated with the plan instance.
PLN_ID
Number(11,0)
The ID of the plan instance.
FIN_YEAR_ID
Number(11,0)
The ID of the financial year in which the plan instance occurs.
SEQUENCE_NUMBER
Number(11,0)
The sequence number of the entry. A payee could have more than one
entry for a plan template if the template is assigned using a historical
field value.
Primary key
PLN_TEMPLATE + EMP_ID + SEQUENCE_NUMBER + FIN_YEAR_ID
Foreign keys
None.
PLAN_RESULTS
This table contains summary results at the plan level. Each record represents the
calculation results summarized by model, payee, plan and period. The table is
populated by the calculation process.
Table columns
Column name
Data type
Description
FIN_YEAR_ID
Number(11,0)
The ID of the year.
FP_PERIOD_SEQ
Number(11,0)
EMP_ID
Number(11,0)
PLN_ID
Number(11,0)
The ID of the plan.
PR_ACTUAL_YTD
Number(32,15)
The accumulated event performance YTD in target currency.
PR_ACTUAL_THIS
Number(32,15)
The accumulated event performance for the period in target
currency.
PR_BASE_ACTUAL_YTD
Number(32,15)
The accumulated event performance YTD in base currency.
PR_BASE_ACTUAL_THIS
Number(32,15)
The accumulated event performance for the period in base
currency.
PR_TARGET_YTD
Number(32,15)
The YTD target in target currency.
PR_TARGET_THIS
Number(32,15)
The period target in target currency.
PR_TARGET_QTD
Number(32,15)
The QTD target in target currency.
PR_TARGET_QTR
Number(32,15)
The quarter target in target currency.
PR_TARGET_ANN
Number(32,15)
The plan target in target currency.
PR_ACHIEV_THIS
Number(20,8)
The percentage achievement against target for the period.
PR_ACHIEV_QTD
Number(20,8)
The percentage achievement against target QTD.
PR_ACHIEV_QTR
Number(20,8)
The percentage achievement against target for the quarter.
224
3
PLAN_RESULTS
Column name
Data type
Description
PR_ACHIEV_YTD
Number(20,8)
The percentage achievement against target YTD.
PR_ACHIEV_ANN
Number(20,8)
The percentage achievement against target for the plan.
PR_OTC_THIS
Number(32,15)
The period OTC in payment currency.
PR_OTC_QTD
Number(32,15)
The QTD OTC in payment currency.
PR_OTC_QTR
Number(32,15)
The quarter OTC in payment currency.
PR_OTC_YTD
Number(32,15)
The YTD OTC in payment currency.
PR_OTC_ANN
Number(32,15)
The plan OTC in payment currency.
PR_EFFECTIVE_RATE_THIS
Number(20,8)
Commission due for this period divided by the actual result
achieved.
PR_EFFECTIVE_RATE_QTD
Number(20,8)
Commission due for this quarter to date divided by the actual
result achieved.
PR_EFFECTIVE_RATE_YTD
Number(20,8)
Commission due for this year to date divided by the actual result
achieved.
PR_COMM_DUE_THIS
Number(32,15)
The calculated earnings due for the period in payment currency.
PR_COMM_DUE_QTD
Number(32,15)
The calculated earnings due QTD in payment currency.
PR_COMM_DUE_YTD
Number(32,15)
The calculated earnings due YTD in payment currency.
PR_DRAW_DUE_THIS
Number(32,15)
The overall draw amount for the period in payment currency.
PR_DRAW_DUE_QTD
Number(32,15)
The overall draw amount QTD in payment currency.
PR_DRAW_DUE_YTD
Number(32,15)
The overall draw amount YTD in payment currency.
PR_PAY_DUE_THIS
Number(32,15)
The overall plan amount due for the period in payment currency.
PR_PAY_DUE_QTD
Number(32,15)
The overall plan amount due QTD in payment currency.
PR_PAY_DUE_YTD
Number(32,15)
The overall plan amount due YTD in payment currency.
PR_BASE_PAY_DUE_THIS
Number(32,15)
The overall plan amount due for the period in base currency.
PR_BASE_PAY_DUE_QTD
Number(32,15)
The overall plan amount due QTD in base currency.
PR_BASE_PAY_DUE_YTD
Number(32,15)
The overall plan amount due YTD in base currency.
PR_FOLLOW_ID
Number(11,0)
The ID of the plan that is post-merged with this one, if any.
MODEL_COUNT
Number(11,0)
The ID of the model count.
PR_BASE_TARGET_THIS
Number(32,15)
The period target in base currency.
PR_BASE_TARGET_QTD
Number(32,15)
The QTD target in base currency.
PR_BASE_TARGET_QTR
Number(32,15)
The quarter target in base currency.
PR_BASE_TARGET_YTD
Number(32,15)
The YTD target in base currency.
PR_BASE_TARGET_ANN
Number(32,15)
The plan target in base currency.
PR_EFFECTIVE_TARGET
Number(32,15)
The effective target based on target frequency for the period in
target currency.
PR_PAY_DUE_PREV
Number(32,15)
The overall plan amount due as of the previous period in
payment currency.
PR_COMM_WITHELD
Number(32,15)
No longer used.
PR_RANK_THIS
Number(11,0)
The period rank position of the plan in this period.
PR_RANK_THIS_JOINT
Number(11,0)
The number of payees sharing the period rank position.
PR_RANK_QTR
Number(11,0)
The quarter rank position of the plan in this period.
PR_RANK_QTR_JOINT
Number(11,0)
The number of payees sharing the quarter rank position.
PR_RANK_ANN
Number(11,0)
The annual rank position of the plan in this period.
225
3
PLAN_RESULTS
Column name
Data type
Description
PR_RANK_ANN_JOINT
Number(11,0)
The number payees sharing the annual rank position.
PR_VOLUME_THIS
Number(11,0)
The total event Volume for the period.
PR_VOLUME_QTD
Number(11,0)
The total event Volume QTD.
PR_VOLUME_YTD
Number(11,0)
The total event Volume YTD.
PR_ACTUAL_PAID_YTD
Number(32,15)
The amount of payment released against the plan YTD.
PR_ORIGINAL_THIS
Number(32,15)
The accumulated original event performance for the period in
target currency.
PR_ORIGINAL_QTD
Number(32,15)
The accumulated original event performance QTD in target
currency.
PR_ORIGINAL_YTD
Number(32,15)
The accumulated original event performance YTD in target
currency.
PR_BASE_ORIGINAL_THIS
Number(32,15)
The accumulated original event performance for the period in
base currency.
PR_BASE_ORIGINAL_QTD
Number(32,15)
The accumulated original event performance QTD in base
currency.
PR_BASE_ORIGINAL_YTD
Number(32,15)
The accumulated original event performance YTD in base
currency.
PR_ACTUAL_PAID_THIS
Number(32,15)
The amount of payment released against the plan for the period.
PR_ACTUAL_PAID_QTD
Number(32,15)
The amount of payment released against the plan QTD.
PR_UD1_THIS to
PR_UD6_THIS
Number(32,15)
The value of custom summary field 1 to 6 for the period, if any.
PR_UD1_QTD to
PR_UD6_QTD
Number(32,15)
The value of custom summary field 1 to 6 QTD, if any.
PR_UD1_YTD to
PR_UD6_YTD
Number(32,15)
The value of custom summary field 1 to 6 YTD, if any.
PR_UD1_PCNT_THIS to
PR_UD4_PCNT_THIS
Number(20,8)
The value of custom summary percentage field 1 to 4 for the
period, if any.
PR_UD1_PCNT_QTD to
PR_UD4_PCNT_QTD
Number(20,8)
The value of custom summary percentage field 1 to 4 QTD, if
any.
PR_UD1_PCNT_YTD to
PR_UD4_PCNT_YTD
Number(20,8)
The value of custom summary percentage field 1 to 4 YTD, if any.
PR_ADJ_THIS
Number(32,15)
The total plan level adjustment value for the period in payment
currency.
PR_ADJ_QTD
Number(32,15)
The total plan level adjustment value QTD in payment currency.
PR_ADJ_YTD
Number(32,15)
The total plan level adjustment value YTD in payment currency.
PR_BASE_ADJ_THIS
Number(32,15)
The total plan level adjustment value for the period in base
currency.
PR_BASE_ADJ_QTD
Number(32,15)
The total plan level adjustment value QTD in base currency.
PR_BASE_ADJ_YTD
Number(32,15)
The total plan level adjustment value YTD in base currency.
PR_TRAN_UD_1_THIS to
PR_TRAN_UD_15_THIS
Number(32,15)
The total value of custom event field 1 to 15 for the period, if
any.
PR_TRAN_UD_1_QTD to
PR_TRAN_UD_15_QTD
Number(32,15)
The total value of custom event field 1 to 15 QTD, if any.
PR_TRAN_UD_1_YTD
Number(32,15)
The total value of custom event field 1 to 15 YTD, if any.
to PR_TRAN_UD_15_YTD
226
3
PLAN_RESULTS
Column name
Data type
Description
QUARTER
Number(11,0)
The ID of the quarter.
PR_ACTUAL_QTD
Number(32,15)
The accumulated event performance QTD in target currency.
PR_BASE_COMM_DUE_THIS
Number(32,15)
The calculated earnings due for the period in base currency.
PR_BASE_COMM_DUE_QTD
Number(32,15)
The calculated earnings due QTD in base currency.
PR_BASE_COMM_DUE_YTD
Number(32,15)
The calculated earnings due YTD in base currency.
PR_DRAW_DIFF_THIS
Number(32,15)
The draw value that has been over or under paid.
PR_TRAN_COUNT_THIS
Number(11,0)
The number of events calculated for this payee and plan in this
period.
PR_TRAN_COUNT_QTD
Number(11,0)
quarter to date.
PR_TRAN_COUNT_YTD
Number(11,0)
year to date.
PR_UD7_THIS to
PR_UD15_THIS
Number(32,15)
Custom result field for this period. Usually created by writing
back in a calculator.
PR_UD7_QTD to
PR_UD15_QTD
Number(32,15)
Custom result field for the quarter to date. Usually the rolled up
values of the period field but could also be created by writing
PR_UD7_YTD to
PR_UD15_YTD
Number(32,15)
Custom result field for the year to date. Usually the rolled up
values of the period field but could also be created by writing
PR_BASE_ACTUAL_QTD
Number(32,15)
The accumulated event performance QTD in base currency.
PR_UD16_THIS to
PR_UD30_THIS
Number(32,15)
Additional custom result field for this period. Usually created by
writing back in a calculator.
PR_UD16_QTD to
PR_UD30_QTD
Number(32,15)
Additional custom result field for the quarter to date. Usually the
rolled up values of the period field but could also be created by
PR_UD16_YTD to
PR_UD30_YTD
Number(32,15)
Additional custom result field for the year to date. Usually the
rolled up values of the period field but could also be created by
PR_PAY_DIFF
Number(32,15)
The difference between what is due and what has been paid in
the current period.
PR_BROUGHT_FORWARD
Number(32,15)
The difference between what is due and what was paid for the
previous period.
PR_DRAW_DIFF_QTD
Number(32,15)
The draw value QTD that has been over or under paid.
PR_DRAW_DIFF_YTD
Number(32,15)
The draw value YTD that has been over or under paid.
Primary key
FIN_YEAR_ID + EMP_ID + FP_PERIOD_SEQ + PLN_ID + FCST_ID + FCST_USR +
MODEL_COUNT
Foreign keys
227
3
PLAN_RESULTS_CLOSED
FP_PERIOD_SEQ]
PLAN_RESULTS_CLOSED
This table contains the payee released version of the PLAN_RESULTS data. As such,
it has the same structure but with the addition of the statement batch ID. The
table is populated by the statement release process.
Table columns
Column name
Data type
Description
SB_ID
Number(11,0)
Primary key
MODEL_COUNT + SB_ID
Foreign keys
FP_PERIOD_SEQ]
PLAN_RESULTS_MANAGED
This table contains the manager released version of the PLAN_RESULTS data. As
such, it has the same structure but with the addition of the statement batch ID.
The table is populated by the statement release process.
Table columns
Column name
Data type
Description
SB_ID
Number(11,0)
Primary key
MODEL_COUNT + SB_ID
228
3
PLAN_TABLE
Foreign keys
FP_PERIOD_SEQ]
PLAN_TABLE
Some SQL client program such as Toad create this table. It is not a NICE ICM
table.
PLAN_TRANSACTION_MATCH
This is an internal table used by the Set Calculations job following an Events
data port. The table is used to determine which plans need recalculation.
Table columns
Column name
Data type
Description
PLN_ID
Number(24,0)
The ID of the plan.
EMP_ID
Number(24,0)
MIN_TRN_DATE
Date
The earliest transaction date where there was a match to the plan. This date
used to set the plan start processing from fields so that NICE ICM only
calculates from the financial period it needs to.
JOB_ID
Number(24,0)
The ID of the Set Calculations job.
Primary key
JOB_ID + PLN_ID + EMP_ID
Foreign key
PLAN_TRANSACTION_UPDATE
This table is an internal table used by the Set calculations job to help identify
plans where their event dates have changed.
229
3
PLANS
Table columns
Column name
Data type
Description
PLN_ID
Number(24,0)
The ID of the plan.
EMP_ID
Number(24,0)
JOB_ID
Number(24,0)
The ID of the Set Calculations job.
MIN_TRN_DATE
Date
The earliest event date for the plan.
PLAN_PROC_DATE
Date
The processing start date of the corresponding plan. Used internally to
determine if any events appear before this date so that the plan can be
reflagged.
MIN_AT_DATE
Date
The earliest event date for the given plan from the ASSIGNED_TRANS
table. Used internally to determine if any transactions appear before this
date so the plan can be reflagged.
Primary key
PLN_ID + EMP_ID + JOB_ID
Foreign key
PLANS
This table contains plans and plan templates. Each record represents a plan or a
plan template. The record is a plan template when the EMP_ID field contains a
zero value. The table is populated via the ICM Admin user interface.
Table columns
Column name
Data type
Description
PLN_ID
Number(11,0)
The internally generated unique ID of the plan.
FIN_YEAR_ID
Number(11,0)
The ID of the year.
EMP_ID
Number(11,0)
The ID of the payee, or zero for a plan template.
PLN_NAME
VarChar2(200)
The name of the plan.
PLN_PAY_FREQ
Number(11,0)
The frequency of payment release from the plan:
0 - On Demand
1 - Period
2 - Quarterly
3 - Half Yearly
4 - Yearly
230
3
PLANS
Column name
Data type
Description
PLN_STD_MTHD_CALC
Number(11,0)
The ID of the first calculator added to the plan. This is
used as its main calculation. Any additional calculators,
SPIFs, or clawbacks added to the plan are stored in the
PLAN_ELEMENTS table.
A negative value in this field indicates the plan is linked
to a calculator series. The absolute value is then the ID
of the calculator series and links to the
ELEMENT_GROUPS and ELEMENT_ITEMS tables.
PLN_TARGET_CUR_ID
Number(11,0)
PLN_TARGET_FREQ
Number(11,0)
The ID of the currency in which the target is set.
The frequency of the target:
1 - Plan
2 - Quarterly
3 - Period
PLN_START
Number(11,0)
The ID of the period in which the plan starts.
PLN_END
Number(11,0)
The ID of the period within which the plan ends.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
PLN_FULL_TARGET
Number(1)
No longer used.
LAST_PROCESSED
Date
The date and time at which the plan was last calculated.
PLN_MODEL_ONLY
Number(1)
Flag indicating whether the plan should only be used in
models.
-1 - Use only in models
PLN_JUST_UD1 to PLN_JUST_UD6
Number(11,0)
Indicator as to the filter match status of custom field 1
to 6:
0 - None
-1 - Only
>0 - Sales Structure
PLN_START_DAY
Number(11,0)
The period day number at which the plan starts.
PLN_END_DAY
Number(11,0)
The day of the period that the plan ends.
PLN_NEEDS_PROCESSING
Number(1)
Flag indicating whether the plan needs calculating.
PLN_MODEL_UPDATED
Number(1)
Flag indicating whether a model that includes this plan
has been updated
-1 - Plan has been updated
PLN_FORECAST_UPDATED
Number(1)
No longer used.
PLN_STD_MTHD_CALC_TYPE
Number(11,0)
The type of calculator specified in the
PLN_STD_MTHD_CALC field:
0 - None
2 - Calculator
PLN_RANK
Number(11,0)
Indicator as to whether the plan should be ranked:
0 - None
1 - Performance
2 - Payment
PLN_SUM_ID
Number(11,0)
The ID of the value definition used by the plan, if any.
231
3
PLANS
Column name
Data type
Description
PLN_EXCLUSIVE
Number(1)
Flag indicating whether the plan filter should operate
on an exclusive basis.
PLN_GROUP
VarChar2(50)
The group that the plan belongs to.
PLN_FINANCE_CODE
VarChar2(20)
No longer used.
PLN_PLIST_ID
Number(11,0)
The ID of the price list associated with the plan, if any.
PLN_PAY_TYPE
Number(11,0)
The ID of the currency in which the plan should pay,
zero is payee payment currency.
PLN_PAY_BANK
Number(1)
No longer used.
PLN_GIFT_ID
Number(1)
No longer used.
-1 - Plan filter should operate on exclusive basis
PLN_DATA_SET
Number(11,0)
The event data set to be used by the plan filter.
PG_ID
Number(11,0)
The ID of the plan group.
PLN_PRO_RATE
Number(1)
Flag indicating whether the targets should be pro rated
to the plan coverage period.
-1 - Targets should be pro rated
PLN_START_DATE
Date
The date at which the plan starts.
PLN_END_DATE
Date
The date that the plan ends.
PLN_UD1 to PLN_UD5
VarChar2(50)
The value of plan custom field 1 to 5, if any.
CQ_ID
Number(11,0)
The ID of the compiled query associated with the plan.
PLN_DATA_SOURCE
Number(11,0)
The source of data for the plan filter:
0 - Events
1 - Manual
2 - Payee Results
3 - Plan Results
4 - Single plan
PLN_DATA_SOURCE_FREQ
Number(11,0)
The frequency associated with a manual payment
source:
1 - Period
2 - Quarter
3 - Half Year
4 - Year
PLN_TEMPLATE_ID
Number(11,0)
PLN_TEMPLATE_ACTIVE
Number(1)
The ID of the plan template to which this plan belongs.
Flag indicating whether the plan template is active.
-1 - Template is active
PLN_TEMPLATE_DELETE
Number(1)
Flag used to indicate that the plan template has been
deleted.
-1 - Template has been deleted
PLN_TEMPLATE_SYNCH
Date
The date and time at which the plan template was last
synchronised.
232
3
PLANS
Column name
Data type
Description
PLN_JUST_UD7 to PLN_JUST_UD10
Number(11,0)
Indicator as to the filter match status of custom field 7
to 10:
0 - None
-1 - Only
>0 - Sales Structure
PLN_TEMPLATE_SET_TARGET
VarChar2(20)
The field by which target settings are maintained in a
plan template.
PLN_EFF_DATE_FIELD
VarChar2(50)
The name of the event field to use as an effective date.
PLN_TEMPLATE_SET_OTC
VarChar2(50)
The field by which OTC settings are maintained in a
plan template.
PLN_RESULTS_FIELD
VarChar2(50)
The results field name to use as the value in payee or
plan payments sourced plans.
PLN_RECALC_CHECK
VarChar2(20)
Used for optimizing dependent payees at calculation
time.
PLN_DELETED
Number(1)
Flag to indicate that the system has paid out on this
plan.
-1 - System has paid out on this plan
PLN_SPLIT_FROM
Date
Date used to split plans.
PLN_HOLD
Number(1)
The plan hold status.
PLN_INHERIT_TARGET
Number(11,0)
Number of the sales structure used to roll up targets.
Zero if none set.
PLN_SECURITY_VALUE
VarChar2(100)
Used to restrict access to a plan. A user can then only
access the plan if the user data access restrictions allow
the user to see payees that have this value. For more
information on restricting access to calculators, see the
PLN_TAX_GROUP
Number(11,0)
The ID of the tax group for the plan or -2 if the tax group
is inherited from the payee.
PLN_TAX_CODE
Number(11,0)
The ID of the tax code for the plan or -2 if the tax group
is inherited from the payee.
USE_HINTS
Number(1)
Flag indicating whether a hint should be used when
merging from the ASSIGNED_TRANS into the
TRANSACTIONS table. This field is not available in the
user interface.
PLAN_HINT
VarChar2(50)
The hint to use when merging from the
ASSIGNED_TRANS into the TRANSACTIONS table.
PLN_JOB_IN_PROGRESS
Number(11,0)
Used by the system when calculating by template.
PLN_LAST_TRN_JOB
Number(11,0)
The ID of the last event job that was processed when
calculating.
PLN_UD6 to PLN_UD10
VarChar2(50)
The value of plan custom field 6 to 10.
PLN_GST_SEQUENCE
Number(11,0)
Flag field set by the synchronisation process.
-1 - Hint should be used
-1 - This plan is the result of a guest relationship
0 or null - This is not a guest plan
PLN_DESC
VarChar2(4000)
233
The description of the plan.
3
PLANS
Column name
Data type
Description
SEQUENCE_NUMBER
Number(11,0)
The sequence number of the plan. If a plan is allocated
via historical fields, a payee.
PLN_SOURCE_EMP_ID
Number(11,0)
Single plan source type only. Used together with
PLN_SOURCE.PLN_NAME to identify a single plan for
a single payee to be used as a source. Contains the ID of
the payee.
PLN_SOURCE_PLN_NAME
VarChar2(50)
Single plan source type only. The name of the single
plan that is used as a source.
PLN_BUILD_LEDGER
Number(1)
Flag indicating whether the ledger needs rebuilding for
this plan. Used mainly during the calculation process to
indicate that the ledger should be rebuilt at the end of
the calculation job.
-1 - Ledger needs rebuilding
PLN_GUEST_ONLY
Number(1)
Flag indicating whether the template is only for guests
(that is, there is no filter for assigning payees).
-1 - Template is only for guests
PLN_OTC_FREQ
Number(11,0)
The OTC frequency:
1 - By year
2 - By quarter
3 - By period
PLN_BW_MODE
Number(11,0)
The lock down mode to be used with this plan:
0 - none
1 - relative period
2 - relative days
4 - specific date
PLN_BW_RELATIVE_PERIODS
Number(11,0)
PLN_RELEASE_TRANS_CLOSED
Number(1)
The number of periods to recalculate this plan for. This
number is rolling so that NICE ICM only calculates this
number of periods. Part of the lock down feature.
Flag indicating whether events should be copied to
ASSIGNED_TRANS_CLOSED when creating a statement
batch using this plan.
-1 - Copy events to ASSIGNED_TRANS_CLOSED
PLN_MANUAL_RESULTS_SOURCE
Number(11,0)
How manual results are to be entered for the plan:
1 - Using the standard NICE ICM command: Processing
> Manual Results.
2 - Using a custom form at the NICE application.
PLN_PROC_START_FPSQ
Number(11,0)
The ID of a financial period. Together with the next
column, this value specified when the recalculation is to
be started from. If a full recalculation is being
performed, this column is null.
PLN_PROC_START_FYID
Number(11,0)
The ID of a financial year. Together with the next
column, this value specified when the recalculation is to
be started from. If a full recalculation is being
performed, this column is null.
CALC_DURATION_MILLIS
Number(24,0)
The duration in milliseconds of the last calculation of
this plan for the payee specified at EMP_ID.
234
3
PLANS_CLOSED
Column name
Data type
Description
PLN_BW_SPECIFIC_PERIOD_FY_ID
Number(11,0)
The ID of a financial year. Used together with the next
column to define when this plan should be recalculated
from. Part of the lock down feature.
The two columns define a specific period, rather than a
relative period as specified at
PLN_BW_RELATIVE_PERIODS.
PLN_BW_SPECIFIC_PERIOD_SEQ_ID
Number(11,0)
The ID of a period. Used together with the previous
column to define when the plan is to be recalculated
from. Part of the lock down feature.
LEDGER_CALC_DURATION
Number(11,0)
Total calculation time in milliseconds for plan level
ledger population.
COMP_PERF_CALC_DURATION
Number(11,0)
Total calculation time in milliseconds for assigning
events, event calculator, and event level ledger
population.
Primary key
PLN_ID
Foreign keys
CQ_ID = COMPILED_QUERIES.CQ_ID
PG_ID = PLAN_GROUPS.PG_ID
PLN_PLIST_ID = PRICELISTS.PLIST_ID
PLN_SUM_ID = TRAN_SUMS.SUM_ID
PLN_TARGET_CUR_ID = CURRENCIES.CUR_ID
PLN_TEMPLATE_ID = PLANS_PLN_ID
VRN_HDR_ID = VARIATION_HEADERS.VRN_HDR_ID
PLANS_CLOSED
This table contains the payee released version of the PLANS data. As such, it has
the same structure but with the addition of the statement batch ID. The table is
populated by the statement release process.
Table columns
The table contains the following columns in addition to the PLANS table
columns:
Column name
Data type
Description
SB_ID
Number(11,0)
Primary key
SB_ID + PLN_ID
235
3
PLANS_MANAGED
Foreign keys
PLANS_MANAGED
This table contains the manager released version of the PLANS data. As such, it
has the same structure but with the addition of the statement batch ID. The
table is populated by the statement release process.
Table columns
The table contains the following columns in addition to the PLANS table
columns:
Column name
Data type
Description
SB_ID
Number(11,0)
Primary key
SB_ID + PLN_ID
Foreign keys
236
3
PLATFORM_TO_DELETE
PLATFORM_TO_DELETE
This table contains an entry for each user, contact, or payee that has been
deleted from the ICM database but the corresponding user accounts have not
yet been deleted from the service platform’s database.
The service platform regularly sends requests to the ICM service layer to discover
any accounts that have been deleted for each ICM slave application. The service
layer examines this table and returns a list of entity IDs that have been deleted.
The service platform can then unregister the corresponding accounts from its
database. The ICM service layer then deletes the corresponding records from the
table.
Table columns
Column name
Data type
Description
ENTITY_ID
VarChar2(4000)
The entity ID of the deleted user, payee, or contact account.
ENTITY_TYPE
Number(11,0)
The type of account:
1 - Payee
2 - User
3 - Contact
Primary key
None.
Foreign keys
None.
PLN_GUESTS
This table stores the guest relationships.
Table columns
Column name
Data type
Description
PLN_TEMPLATE_ID
Number(11,0)
EMP_ID
Number(11,0)
GST_SEQUENCE
Number(11,0)
The sequence number of this template/payee pair. The sequence starts at
1.
237
3
POSTING_PLAN
Column name
Data type
Description
GST_START_DATE
Date
The start date of the guest relationship.
Null indicates that it should be inferred from the plan start, payee start,
and financial year start dates.
GST_END_DATE
Date
The end date of the guest relationship.
Null indicates that it should be inferred from the plan end, payee end,
and financial year end dates.
LAST_MODIFIED
Date
The date and time at which the record was last modified.
LAST_MODIFIED_BY
Number(11,0)
The USR_ID of the user who last modified the record.
Primary key
PLN_TEMPLATE_ID + EMP_ID + GST_SEQUENCE
Foreign keys
POSTING_PLAN
This table contains plan level postings.
Table columns
Column name
Data type
Description
FIN_YEAR_ID
Number(11,0)
The ID of the financial year that this posting relates to.
FP_PERIOD_SEQ
Number(11,0)
The ID of the period that this posting relates to.
PLN_ID
Number(11,0)
The plan ID.
EMP_ID
Number(11,0)
The payee ID.
CALC_ID
Number(11,0)
The ID of the calculator that wrote back the value for this posting.
POSTING_CODE
VarChar2(100)
The code of the posting.
POSTING_CAPTION
VarChar2(100)
The description of the posting.
A value of None indicates no description is supplied.
POSTING_VALUE
Number(15,2)
The posting value.
POSTING_DATE
Date
The date and time that the calculator was executed.
Primary key
FIN_YEAR_ID + FP_PERIOD_SEQ + PLN_ID + EMP_ID + CALC_ID + POSTING_CODE
+ POSTING_CAPTION
238
3
POSTING_PLAN_CLOSED
Foreign key
FIN_YEAR_ID,FP_PERIOD_SEQ = FIN_PERIODS.FIN_YEAR_ID,FP_PERIOD_SEQ
POSTING_PLAN_CLOSED
This table contains payee level postings that have been released to payees. As
such, it is identical in column structure to the POSTING_PLAN table, with the
addition of the statement batch ID which identifies the batch used to release the
data. The table is populated by the statement release process.
Table columns
This table has the same columns AS POSTING_PLAN with the addition of the
following column:
Column name
Data type
Description
SB_ID
Number(11,0)
Primary key
SB_ID + FIN_YEAR_ID + FP_PERIOD_SEQ + PLN_ID + EMP_ID + CALC_ID +
POSTING_CODE + POSTING_CAPTION
Foreign key
POSTING_PLAN_MANAGED
This table contains the manager released version of the POSTING_PLAN data. As
Table columns
This table has the same columns AS POSTING_PLAN with the addition of the
following column:
Column name
Data type
Description
SB_ID
Number(11,0)
239
3
POSTING_TRAN
Primary key
SB_ID + FIN_YEAR_ID + FP_PERIOD_SEQ + PLN_ID + EMP_ID + CALC_ID +
POSTING_CODE + POSTING_CAPTION
Foreign key
POSTING_TRAN
This table contains event level postings.
Table columns
Column name
Data type
Description
TRN_ID
Number(11,0)
The event ID.
PLN_ID
Number(11,0)
The plan ID.
EMP_ID
Number(11,0)
The payee ID.
CALC_ID
Number(11,0)
The ID of the calculator that wrote back the value for this posting.
POSTING_CODE
VarChar2(100)
The code of the posting.
POSTING_CAPTION
VarChar2(100)
The description of the posting.
A value of None indicates no description is supplied.
POSTING_VALUE
Number(32,15)
The posting value.
POSTING_DATE
Date
The date and time that the calculator was executed.
TRN_YEAR_ID
Number(11,0)
The ID of the financial year that this posting relates to.
TRN_PERIOD_SEQ
Number(11,0)
The ID of the financial period that this posting relates to.
Primary key
TRN_ID + PLN_ID + EMP_ID + CALC_ID + POSTING_CODE + POSTING_CAPTION
Foreign key
TRN_YEAR_ID,TRN_PERIOD_SEQ = FIN_PERIODS.FIN_YEAR_ID,FP_PERIOD_SEQ
240
3
POSTING_TRAN_CLOSED
POSTING_TRAN_CLOSED
This table contains event level postings that have been released to payees. As
such, it is identical in column structure to the POSTING_TRAN table, with the
addition of the statement batch ID which identifies the batch used to release the
data. The table is populated by the statement release process.
Table columns
This table has the same columns AS POSTING_TRAN with the addition of the
following column:
Column name
Data type
Description
SB_ID
Number(11,0)
Primary key
SB_ID + TRN_ID + PLN_ID + EMP_ID + CALC_ID + POSTING_CODE +
POSTING_CAPTION
Foreign key
POSTING_TRAN_MANAGED
This table contains the manager released version of the POSTING_TRAN data. As
Table columns
This table has the same columns AS POSTING_TRAN with the addition of the
following column.
Column name
Data type
Description
SB_ID
Number(11,0)
Primary key
SB_ID + TRN_ID + PLN_ID + EMP_ID + CALC_ID + POSTING_CODE +
POSTING_CAPTION
241
3
PRICE_LIST_ITEMS
Foreign key
PRICE_LIST_ITEMS
This table contains the contents of price lists. Each record represents a line and
effective date within a price list. The table is populated through the user
interface or via data ports.
Table columns
The table has the following columns
Column name
Data type
Description
PLIST_ID
Number(11,0)
The ID of the price list.
PRODUCT_CODE
VarChar2(50)
The product code of the item.
PLI_EFFECTIVE_DATE
Date
The effective date of the item.
PLI_RRP
Number(15,2)
The RRP of the item.
PLI_SELL_PRICE
Number(15,2)
The sell price of the item.
PLI_BUY_PRICE
Number(15,2)
The Buy Price of the item.
VAT_ID
Number(11,0)
The ID of the tax rate.
Primary key
PLIST_ID + PRODUCT_CODE + PLI_EFFECTIVE_DATE
Foreign keys
PLIST_ID = PRICE_LISTS.PLIST_ID
PRODUCT_CODE = PRODUCTS.PRODUCT_CODE
242
3
This table contains previous values for entries in the price list.
Table columns
Column name
Data type
Description
PRODUCT_CODE
VarChar2(50)
The product code of the item.
PLI_EFFECTIVE_DATE
Date
The effective date of the item.
PLI_RRP
Number(15,2)
The RRP of the item.
PLI_SELL_PRICE
Number(15,2)
The sell price of the item.
PLI_BUY_PRICE
Number(15,2)
The Buy Price of the item.
VAT_ID
Number(11,0)
The ID of the tax rate.
PLIST_ID
Number(11,0)
The ID of the price list.
Primary key
PLIST_ID + PRODUCT_CODE + PLI_EFFECTIVE_DATE
Foreign keys
PLIST_ID = PRICE_LISTS.PLIST_ID
PRODUCT_CODE = PRODUCTS.PRODUCT_CODE
PRICE_LISTS
This table contains price lists. Each record represents a defined price list. The
table is populated through the user interface.
Table columns
Column name
Data type
Description
PLIST_ID
Number(11,0)
The system generated unique ID of the price list.
PLIST_CODE
VarChar2(50)
The price list code.
PLIST_NAME
Date
The name of the price list.
CUR_ID
Number(15,2)
The ID of the price list currency.
LAST_MODIFIED
Number(15,2)
LAST_MODIFIED_BY
Number(15,2)
Primary key
PLIST_ID
243
3
PROCESS_SEMAPHORES
Foreign keys
CURR_ID = CURRENCIES.CUR_ID
PROCESS_SEMAPHORES
PROCESS_SEMAPHORES_ACTIVITY
PRODUCT_SPIF
This table contain SPIF data. Each record represents a SPIF. The table is
populated through the user interface.
Table columns
Column name
Data type
Description
SPIF_ID
Number(11,0)
The internally generated unique ID for the SPIF.
SPIF_NAME
VarChar2(75)
The name of the SPIF.
PRODUCT_TYPE
VarChar2(50)
The product type of the SPIF, if any.
PRODUCT_GROUP
VarChar2(50)
The product group of the SPIF, if any.
PRODUCT_CATEGORY
VarChar2(50)
The product category of the SPIF, if any.
PRODUCT_CODE
VarChar2(50)
The product code of the SPIF, if any.
SPIF_TYPE
Number(11,0)
The type of the SPIF:
1 - Value per unit
2 - Percentage uplift
3 - Value per event
4 - Uplift per unit
5 - Uplift per event
6 - Payment uplift
SPIF_VALUE
Number(15,2)
The value associated with the SPIF, if any.
SPIF_PCNT
Number(20,8)
The percentage uplift associated with the SPIF, if any.
SPIF_PRODUCT_SELECTION
Number(11,0)
Identifier for the product selection mode:
1=By Classification
2=Individual Products
3=Individual Categories
4=Individual Groups
5=Individual Types
SPIF_CODE
VarChar2(20)
The SPIF code.
244
3
PRODUCT_SPIF_PRODUCTS
Column name
Data type
Description
SPIF_PARTNER_VALUE
Number(1)
No longer used.
SPIF_INDIV
Number(1)
Flag indicating whether the SPIF should contain individual
product values.
SPIF_PRIORITY
Number(11,0)
The SPIF priority code.
SPIF_VISIBLE
Number(1)
Flag indicating whether the SPIF should be visible to the payees.
-1 - SPIF is visible to payees
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
SPIF_FROM_DATE
Date
The date on which the SPIF starts.
SPIF_TO_DATE
Date
The date on which the SPIF ends.
Primary key
SPIF_ID
Foreign keys
FIN_YEAR_ID + SPIF_FROM = FIN_PERIODS.[FIN_YEAR_ID + FP_PERIOD_SEQ]
FIN_YEAR_ID + SPIF_TO = FIN_PERIODS.[FIN_YEAR_ID + FP_PERIOD_SEQ]
PRODUCT_SPIF_PRODUCTS
This table contains specific product or product classification values or
percentages if the Individual option on the SPIF is set. Each record represents a
product or classification level against which a value or percentage is specified.
The table is populated through the ICM Admin user interface.
Table columns
Column name
Data type
Description
SPIF_ID
Number(11,0)
The ID of the SPIF.
PRODUCT_CODE
VarChar2(50)
The product or classification code of the SPIF item.
P_SPIF_VALUE
Number(15,2)
The value associated with the SPIF item.
P_SPIF_PCNT
Number(20,8)
The percentage associated with the SPIF item.
Primary key
SPIF_ID + PRODUCT_CODE
Foreign keys
245
3
PRODUCTS
PRODUCTS
This table contains the product reference information. Each record represents a
product record for a period defined by the start and end dates. The table is
populated through the user interface or via data ports.
Table columns
Column name
Data type
Description
PRODUCT_ID
Number(11,0)
The internally generated unique identifier for the product.
PRODUCT_TYPE
VarChar2(50)
The product type.
PRODUCT_GROUP
VarChar2(50)
The product group.
PRODUCT_CATEGORY
VarChar2(50)
The product category.
PRODUCT_CODE
VarChar2(50)
The product code.
PRODUCT_DESCRIPTION
VarChar2(50)
The product description.
PRODUCT_COST_OF_SALE
Number(15,2)
The product cost of sale.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
PRICE_LIST
Number(1)
Flag indicating whether the product should be available within
price lists.
-1 - Product is available within price lists
PROD_SYNCH
Date
Used by data ports to synchronize the product table.
PRODUCT_CLASS_1 to
PRODUCT_CLASS_10
VarChar2(50)
The product classification value 1 to 10, if any.
PRODUCT_START_DATE
Date
The start date of the product records, if any.
PRODUCT_END_DATE
Date
The end date of the product records, if any.
Primary key
PRODUCT_ID
Foreign keys
PROD_YEAR + PROD_PERIOD = FIN_PERIODS.[FIN_YEAR_ID + FP_PERIOD_SEQ]
PROF_FLD_TIDY
This table contains a record for each shared profile field that is awaiting
deletion. The system adds a record to this table when a user deletes the profile
field through ICM Admin. The Profile field maintenance server job (job type
111) uses the entries in this table to set the corresponding fields to null. For
more information on this server job, see the System Administration Guide.
246
3
PROFILE_DEFINITION
Table columns
Column name
Data type
Description
PROFILE_FIELD
VarChar2(255)
The name of the profile field.
TABLE_NAME
VarChar2(255)
The name of the table to which the profile field
applies.
Primary key
None.
Foreign keys
None.
PROFILE_DEFINITION
QDE_ITEMS
This table contains the item definitions for payee quick data entry (QDE)
screens. Each record represents a field within a defined QDE screen. The table is
populated through ICM Admin by choosing Administration > System
Configuration > Payee Entry.
Table columns
Column name
Data type
Description
QDE_ID
Number(11,0)
The ID of the QDE profile.
QDE_SEQ
Number(11,0)
The sequence number of the QDE field.
QDE_FIELD
VarChar2(50)
The name of the QDE field.
QDE_DEFAULT
VarChar2(50)
The default value of the QDE field.
QDE_LOOKUP
Number(1)
Flag indicating whether the field should permit a lookup option.
-1 - Field permits a lookup option
Primary key
QDE_ID + QDE_SEQ
247
3
QDE_PROFILES
Foreign keys
QDE_ID = QDE_PROFILES.QDE_ID
QDE_PROFILES
This table contains QDE definitions. Each record represents a QDE profile
definition. The table is populated through ICM Admin by choosing
Administration > System Configuration > Payee Entry.
Table columns
Column name
Data type
Description
QDE_ID
Number(11,0)
The internally generated ID for the QDE profile.
QDE_NAME
VarChar2(75)
The name of the QDE profile.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
Primary key
QDE_ID
Foreign keys
None.
QRY_ACTIVITIES
This table is only present in the ICM database if you have upgraded from an
earlier NICE ICM version 3.2 system that has been using payee queries. The
table contains historical information about past payee queries that can be used
to run reports using the Inquiries (including Historic) report source. The old NICE
ICM 3.2 query system is superseded by NICE ICM’s Inquiry Management
feature, which has its own set of database tables.
This table contains activity information associated with a payee query. Each
record represents a specific activity against a query. The table is populated
through the query management user interface.
Table columns
Column name
Data type
Description
QRY_ID
Number(11,0)
The ID of the query.
248
3
QRY_ATTACHMENTS
Column name
Data type
Description
QRY_ACT_SEQ
Number(11,0)
The sequence number of the activity.
QRY_ACT_DATE
Date
The date and time of the activity.
QRY_ACT_ASSIGNED_TO
Number(11,0)
The ID of the user to whom the activity is current assigned.
QRY_ACT_DETAILS
VarChar2(2000)
The description of the activity.
QRY_ACT_REMINDER
Date
The date and time at which to send a reminder to the
assigned user.
QRY_ACT_REMINDER_SENT
Number(1)
Flag indicating whether a reminder has been sent against
the activity.
-1 - Reminder has been sent
QRY_ACT_SERVICE_NOTIFIED
Number(1)
Flag indicating whether a the service level threshold has
triggered a notification.
-1 - Service level threshold triggered a notification
QRY_ACT_OUT_OF_SERVICE
Number(1)
Flag indicating whether the activity is out of service.
-1 - Activity is out of service
QRY_ACT_CLOSED
Date
The date and time at which the activity was closed.
QRY_ACT_SERVICE_PCNT
Number(20,8)
The current percentage of service level attained by the
activity.
QRY_ACT_BY
Number(11,0)
The ID of the user who performed the activity.
QRY_ACT_ASSIGNMENT
Number(1)
Flag indicating that the activity is an assignment.
-1 - Activity is an assignment
Primary key
QRY_ID + QRY_ACT_SEQ
Foreign keys
QRY_ID = QRY_HEADER.QRY_ID
QRY_ACT_ASSIGNED_TO = USERS.USER_ID
QRY_ACT_BY = USERS.USER_ID
QRY_ATTACHMENTS
This table contains a reference to the files attached to a payee query, if any. Each
record represents a file attached to a query. The table is populated when a user
adds or removes an attached file to a query.
Table columns
249
3
QRY_HEADER
Column name
Data type
Description
QRY_ID
Number(11,0)
The ID of the query.
QRY_ATT_SEQ
Number(11,0)
The sequence number of the attachment.
QRY_ATT_FILE_NAME
VarChar2(75)
QRY_ATT_DOWNLOADED
Date
The date and time at which the attachment was last downloaded.
QRY_ATT_DATA
Blob
The contents of the attachment file.
Primary key
None.
Foreign keys
QRY_HEADER
This table contains payee queries. Each record represents a query raised by a
payee.
Table columns
Column name
Data type
Description
QRY_ID
Number(11,0)
The internally generated unique ID of the query.
QRY_RAISED_BY
Number(11,0)
The ID of the payee who raised the query.
QRY_DATE_RAISED
Date
The date and time that the query was raised.
QRY_STATUS
Number(11,0)
Indicator of the query status:
0 - Open
1 - In Progress
2 - Closed
QRY_SUBJECT
VarChar2(255)
The query subject line.
QRY_DETAILS
VarChar2(2000)
The description of the query.
QRY_SUBMITTED_VALUE
Number(15,2)
The values of the query submitted by the payee.
QRY_ASSESSED_VALUE
Number(15,2)
The assessed value of the query.
QRY_TYPE
VarChar2(30)
The query categorisation.
250
3
QRY_HEADER
Column name
Data type
Description
QRY_SERVICE_NOTIFIED
Number(1)
Flag indicating whether a service level warning has been issued
against this query.
QRY_OUT_OF_SERVICE
Number(1)
-1 - Service level warning has been issued
Flag indicating that the query has run out of service level.
-1 - Query has run out of service level
QRY_DATE_CLOSED
Date
The date and time that the query was closed.
QRY_WITH
Number(11,0)
The ID of the user who the query is currently allocated to.
QRY_SERVICE_PCNT
Number(20,8)
The current service level percentage of the query.
QRY_RESPONSE
VarChar2(2000)
The administrators response to the query.
FIN_YEAR_ID
Number(11,0)
The ID of the year.
FP_PERIOD_SEQ
Number(11,0)
QRY_PROFILE_1 to
QRY_PROFILE_8
VarChar2(100)
Custom query profile field 1 to 8. Can be configured by
choosing Administration > System Configuration > Query
Management in ICM Admin.
QRY_PROFILE_9 to
QRY_PROFILE_12
Number(15,2)
Custom query profile field 9 to 12.
QRY_PROFILE_13 to
QRY_PROFILE_16
Date
QRY_PROFILE_17 to
QRY_PROFILE_20
Number(1)
PLN_ID
Number(11,0)
The ID of the plan that the query relates to.
TRN_ID
Number(11,0)
The ID of the event that the query relates to.
Primary key
QRY_ID
Foreign keys
FP_PERIOD_SEQ]
QRY_RAISED_BY = EMPLOYEES.EMP_ID
QRY_WITH = USERS.USER_ID
251
3
QRY_UPLOADS
QRY_UPLOADS
This table contains a record for each file uploaded to a payee query. The record
is written when the payee uploads a file to attach to the query even before the
changes to the query itself are saved. Details of the attachment are written to the
QRY_ATTACHMENTS table when the query is saved.
Table columns
Column name
Data type
Description
QRY_EMP_ID
Number(11,0)
The ID of the payee that uploaded the file.
QRY_ATT_FILE_NAME
VarChar2(75)
The file name of the attachment.
QRY_ATT_DATA
BLOB
The contents of the file.
QRY_ID
Number(11,0)
The ID of the payee query.
Primary key
None.
Foreign keys
RANK_PLANS
252
3
RECEIVE_EMAIL
RECEIVE_EMAIL
This table contains a record of all incoming emails. Each record represents an
incoming email collected by the ICM server.
Table columns
Column name
Data type
Description
EM_ID
Number(11,0)
The internally generated unique ID for the incoming email.
EM_MAIL_ID
VarChar2(255)
The SMTP ID of the incoming email.
EM_FROM
VarChar2(255)
The email From address.
EM_TO
VarChar2(255)
The email To address.
EM_CC
VarChar2(255)
The email CC addresses.
EM_SUBJECT
VarChar2(255)
The subject line of the email.
EM_BODY
VarChar2(2000)
The email body text.
EM_DATE_COLLECTED
Date
The date and time at which the email was collected.
EM_PROCESSED
Number(11,0)
Flag indicating whether the incoming email has been processed.
-1 - Incoming mail has been processed
Primary key
EM_ID
Foreign keys
None.
REGIONS
This table contains a record for each region defined in the system. The records
are updated via ICM Admin by choosing Administration > System Configuration >
Regions.
Table columns
Column name
Data type
Description
REGION_NAME
VarChar2(50)
The name of the region. For example UK.
REGION_DEFAULT
Number(1)
A flag indicating whether this region is the default.
REGION_DATE_FORMAT
VarChar2(50)
The format of dates for this region. For example, d MMM yyyy
REGION_NUMBER_FORMAT
VarChar2(50)
The format of numbers for this region. For example, #,##0.00
REGION_ID
Number(11,0)
A system generated unique identifier for the region.
253
3
REJECTIONS
Column name
Data type
Description
REGION_DECIMAL_POINT
VarChar2(1)
The character to use for decimal point for the region.
REGION_GROUP_SEPARATOR
VarChar2(1)
The thousands separator character for the region.
REGION_LANGUAGE
VarChar2(10)
The language code for the region.
Primary key
REGION_ID
Foreign keys
None.
REJECTIONS
This table contains rejections. Each record represents a rejection entered by a
user using ICM Admin.
Table columns
Column name
Data type
Description
REJ_ID
Number(11,0)
The internally generated unique ID of the rejection.
PB_ID
Number(11,0)
EMP_ID
Number(11,0)
REJ_REASON
VarChar2(255)
The reason for the rejection.
REJ_DATE
Date
The date of the rejection.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
FIN_YEAR_ID
Number(11,0)
The ID of the year.
FP_PERIOD_SEQ
Number(11,0)
Primary key
REJ_ID
Foreign keys
FP_PERIOD_SEQ]
254
3
RELEASED_STATEMENTS
RELEASED_STATEMENTS
RENAMABLE_RESULTFIELD_ALIAS
REPORT_HISTORY
This table contains a history of ICM report executions. Each record represents
the running of a report by a user. The table is populated every time a report is
executed.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user who ran the report.
REPORT_ID
Number(11,0)
0 indicates the report was run before it was saved.
REPORT_NAME
VarChar2(100)
The name of the report.
RUN_DATE
Timestamp(6)
The date and time that the report was run.
RUN_CRITERIA
VarChar2(2000)
The criteria used to execute the report.
RUN_DATA_RETURNED
Number(1)
Flag indicating whether any data was returned.
PERSISTED_ID
Number(11,0)
The ID of the persisted report.
TYPE_EMPLOYEE
Number(1)
Flag indicating type of account that ran the report.
-1 - Data was returned
-1 - Payee
0 - User
Primary key
USR_ID + REPORT_ID + RUN_DATE
Foreign keys
255
3
SALES_STRUCTURE
SALES_STRUCTURE
This table contains the sales structures. Each record represents a node in one of
the available sales structure hierarchies. The table is populated through the user
Table columns
Column name
Data type
Description
SS_ID
Number(11,0)
The internally generated unique identifier for the sales
structure record.
SS_LEVEL
Number(11,0)
The level of the sales structure record in a static sales
structure.
SS_CODE
VarChar2(100)
The sales structure code.
SS_NAME
VarChar2(75)
The name of the sales structure record.
SS_PARENT
Number(11,0)
The ID of the parent record.
TARGET_CUR_ID
Number(11,0)
The ID of the target currency.
TARGET_FREQ
Number(11,0)
The frequency setting of the target:
1 - Plan
2 - Quarterly
3 - Monthly
NEEDS_PROCESSING
Number(1)
No longer used.
SS_RANKING
Number(11,0)
No longer used.
SS_PARENT_CODE
VarChar2(100)
The code of the parent record.
SS_NUMBER
Number(11,0)
The sales structure number.
TARGET_GROWTH
Number(1)
Flag indicating that the target should be growth based.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
SS_DATE_FROM
Date
The start date of the sales structure record (if any).
-1 - Target should be growth based
SS_DATE_TO
Date
The end date of the sales structure record (if any).
SS_MM_CODE
VarChar2(20)
The code of this sales structure entry. Used if the sales
structure is many to many.
SS_PARENT_MM_CODE
VarChar2(20)
The code of the parent of this sales structure entry. Used
if the sales structure is many to many.
SS_CODE_GRP
Number(11,0)
Sales structure code group.
SS_CODE_GRP_NEEDS_RESOLVING
Number(1)
Flag indicating whether the sales structure group code
needs resolving.
-1 - Code needs resolving
Primary key
SS_ID
256
3
SCHEMA_DOC
Foreign keys
SS_PARENT = SALES_STRUCTURE.SS_ID
TARGET_CUR_ID = CURRENCIES.CUR_ID
SCHEMA_DOC
This table is used internally to build a list of the tables in the schema.
SCREEN_FIELDS
This is an internal table used by the system to reference database fields that are
not contained in the ICM database dictionary such as fields in a custom table.
Table columns
Column name
Data type
Description
FIELD_ID
Number(11,0)
An internally generated unique reference for the field.
FIELD_NAME
VarChar2(50)
Primary key
FIELD_ID
Foreign keys
None.
257
3
SEL_DESCRIPTIONS
SEL_DESCRIPTIONS
This table contains a friendly version of the contents of the SEL_FILTERS table
for reporting and display purposes. Each record represents a filter. The table is
populated automatically every time a filter is altered.
Table columns
Column name
Data type
Description
FILTER_SOURCE
Number(11,0)
The filter context indicator:
1 - Model
2 - User Data Restriction
3 - Statement Batch
4 - Payment Batch
5 - Statement Notes
7 - Copy Plans
8 - Update Plans
9 - Delete Plans
11 - Delete Employees
12 - Statement Template
13 - Calculations
14 - Data Port
15 - System Parameter
18 - Target Worksheet
19 - Report Employee Access
20 - Report User Access
23 - Report Send to Users
24 - Report Send to Payees
25 - Authorization Rule Users
26 - Plan Template
27 - Authorization Condition
ID1
Number(11,0)
The primary ID of the related record.
ID2
Number(11,0)
The secondary ID of the related record.
FILTER_DESCRIPTION
VarChar2(2000)
Textual description of the filter.
Primary key
FILTER_SOURCE + ID1 + ID2
Foreign keys
ID1 = (context record).(ID)
ID1 + ID2 = (context records).(ID1 + ID2)
258
3
SEL_FILTERS
SEL_FILTERS
This table stores all payee and user filters as used by various areas of the system.
Each record represents an element of the filter and any associated value. The
table is populated via the ICM Admin user interface.
A friendly version of this table suitable for reporting is SEL_DESCRIPTIONS. For
information on this table, see “SEL_DESCRIPTIONS” on page 260
Table columns
Column name
Data type
Description
FILTER_SOURCE
Number(11,0)
The filter context identifier:
1 - Model
2 - User Data restriction
3 - Statement Batch
4 - Payment Batch
5 - Statement Notes
7 - Copy Plans
8 - Update Plans
9 - Delete Plans
11 - Delete Employees
12 - Statement Template
13 - Calculations
14 - Data Port
15 - System Parameter
18 - Target Worksheet
19 - Report Employee Access
20 - Report User Access
23 - Report Send to Users
24 - Report Send to Payees
25 - Authorization Rule Users
26 - Plan Template
27 - Authorization Condition
28 - Bulletins
29 - Set Hold Status
30 - Bookmarks
32 - Plan Assignment Override
ID1
Number(11,0)
The primary ID of the source record.
ID2
Number(11,0)
The secondary ID of the source record.
F_SECTION
Number(11,0)
The filter section:
1 - Include
2 - Exclude
3 - Active
259
3
SEND_EMAIL
Column name
Data type
Description
F_SEQUENCE
Number(11,0)
The sequence number of the filter line item.
FILTER_CODE
VarChar2(255)
The field name and value of the filter line item.
Primary key
FILTER_SOURCE + ID1 + ID2 + F_SECTION + F_SEQUENCE
Foreign keys
ID1 = (context record).(ID)
ID1 + ID2 = (context records).(ID1 + ID2)
SEND_EMAIL
This table is the email out box and holds sent items of the NICE ICM email
system. Whenever the application needs to send an email, the details are
submitted into this table. The ICM server process regularly polls the table to see
if any emails need transmitting, and sends them accordingly.
Table columns
Column name
Data type
Description
EM_ID
Number(11,0)
The internally generated unique identifier for the email.
EM_SEND_AT
Date
The date and time at which to send the email, if any.
EM_DATE
Date
The date and time that the email was submitted to the table.
EM_CC
VarChar2(100)
CC address list.
EM_BCC
VarChar2(100)
BCC address list.
EM_SUBJECT
VarChar2(100)
The subject line of the email.
EM_TEXT
VarChar2(2000)
The body of the email.
EM_SENT
Number(1)
Flag indicating whether the email has been sent.
EM_RETRIES
Number(11,0)
The number of transmission retries.
EM_ABORTED
Number(1)
Flag indicating whether the mail transmission was aborted.
-1 - Mail transmission was aborted
EM_RESULT
VarChar2(255)
The result string received when attempting to transmit the email.
EM_SUBMITTED_BY
Number(11,0)
The ID of the user who submitted the email.
EM_TO
VarChar2(2000)
The TO address list.
EM_TRANSMITTED
Date
Date and time at which the email was transmitted.
EM_SERIALIZED
Number(11,0)
Flag indicating whether there is a serialized attachment for this email.
-1 - Mail has serialized attachment
260
3
SEND_EMAIL_ATTACHMENTS
Primary key
EM_ID
Foreign keys
EM_SUBMITTED_BY = USERS.USR_ID
SEND_EMAIL_ATTACHMENTS
This table contains all the file attachments for outgoing emails. Each record
represents a single attachment.
Table columns
Column name
Data type
Description
EM_ID
Number(11,0)
The ID of the outgoing email that this attachment is for.
EM_SEQUENCE
Number(11,0)
The sequence number of the attachment.
EM_FILENAME
VarChar2(255)
The file name of the attachment.
EM_DATA
Blob
The contents of the attachment file.
Primary key
None.
Foreign keys
EM_ID = RECEIVE_EMAIL.EM_ID
SERVER_CONSOLE
This table contains a snapshot of the current ICM server status. The table has a
record showing the activity of each server thread and of the server job queue.
Table columns
Column name
Data type
Description
SERVER_ID
Number(11,0)
The ID of the server.
THREAD_ID
Number(11,0)
The ID of the server thread, or 0 for the server job queue.
SERVER_NAME
VarChar2(75)
The name of the server, if any.
261
3
SERVER_CONSOLE
Column name
Data type
Description
THREAD_FRIENDLY_NAME
VarChar2(75)
The friendly name of the server thread as follows:
0 - Queue Manager
6 - Main Queue
7 - Calculation Process 1
10 - Synchronisation
11 - Reporting Process 1
12 - Data Processing 1
15 - Optimizer
16 - Release
17 - Fast Track Calculation 1
THREAD_LAST_RAN
Date
The date and time that the thread last ran.
THREAD_STATUS
VarChar2(255)
The status of the thread. Either waiting or the ID of the job
currently being run in the thread such as
INIT_REPORTS_CREATE_VIEW.
SERVER_INSTANCE
VarChar2(75)
The ID of the ICM server instance. Currently there can only be one
server instance.
SERVER_FRIENDLY_NAME
VarChar2(75)
The friendly name of the ICM server instance.
SERVER_LAST_RAN
Date
The data and time the server last completed a job or ran a server
cycle.
SERVER_STATUS
VarChar2(255)
The task that the server thread is currently performing.
SHUTDOWN
Number(1)
No longer used.
Primary key
SERVER_ID + THREAD_ID
Foreign keys
None.
262
3
SERVER_CONSOLE_LOG
SERVER_CONSOLE_LOG
This table contains a historical record of ICM server activity. The table has a
record showing the activity of each server thread for each job that has run.
NOTE: This table is only used if the Should server console activity be logged?
system parameter is set to yes. The name of this parameter in the
SYSTEM_PARAMETERS table is SERVER_CONSOLE_LOG. The table can quickly
become very large and so this system parameter should normally be set
to no. Use the The number of days after which the server console log should
be purged system parameter to request the system to automatically
empty the table every few days. The name of this parameter in the
SYSTEM_PARAMETERS file is SERVER_CONSOLE_LOG_PURGE.
Table columns
Column name
Data type
Description
JOB_ID
Number(11,0)
The ID of the ICM server job.
LOG_TIME_STAMP
Number(24,0)
The absolute time when the log entry was written.
LOG_DATE
Date
The date and time when the log entry was written.
SERVER_ID
Number(11,0)
The ID of the ICM server.
THREAD_ID
Number(11,0)
The ID of the server thread, or 0 for the server job queue.
THREAD_FRIENDLY_NAME
VarChar2(75)
The friendly name of the server thread as follows:
0 - Queue Manager
6 - Main Queue
10 - Synchronisation
11 - Reporting Process 1
15 - Optimizer
16 - Release
17 - Fast Track Calculation 1
THREAD_STATUS
VarChar2(255)
The status of the thread. Either waiting or the name of the job, for
example INIT_REPORTS_CREATE_VIEW, currently being run in the
thread.
Primary key
None.
263
3
SERVER_CONSOLE_PARAMS
Foreign keys
SERVER_CONSOLE_PARAMS
This is an internal table used to store parameters used by the system to look up
the dictionary in order to build ICM server console messages.
Table columns
Column name
Data type
Description
PARAM_SERVER_ID
Number(11,0)
The ID of the ICM server.
PARAM_THREAD_ID
Number(11,0)
The id of the server thread.
PARAM_VALUE
VarChar2(1024)
The parameter value.
PARAM_SEQUENCE
Number(11,0)
The sequence number of the value. A single entry in SERVER_CONSOLE
can require multiple parameter substitutions.
PARAM_FORMAT
Number(11,0)
The type of value:
0 - Text
1 - Dictionary lookup
2 - Number
3 - Percentage
4 - Date
5 - Date/time
Primary key
PARAM_SERVER_ID + PARAM_THREAD_ID + PARAM_SEQUENCE
Foreign keys
(PARAM_SERVER_ID + PARAM_THREAD_ID) = SERVER_CONSOLE.(SERVER_ID +
THREAD_ID)
264
3
SERVER_STATUS
SERVER_STATUS
This table contains parameters regularly updated by the ICM server indicating
its status and used to trigger frequency based housekeeping activities.
Table columns
Column name
Data type
Description
SERVER_FIELD
VarChar2(75)
The code of the server status item.
SERVER_VALUE
Date
The data and time the record was last updated.
SERVER_TEXT_VALUE
VarChar2(255)
The value of the server status item.
Primary key
SERVER_FIELD
Foreign keys
None.
SKETCH_AUDIT
This table contains a record of the steps that have been executed in process
manager instances.
Table columns
Column name
Data type
Description
ID
Number(11,0)
A unique system generated ID for this audit entry.
STEP_ID
Number(11,0)
The ID of the step being audited.
USER_GUID
VarChar2(4000)
The entity ID of the user who performed the activity.
TIMESTAMP
Timestamp(6)
The data and time that the activity occurred.
OLD_VALUE
VarChar2(20)
The old value associated with the step before the
activity is performed.
NEW_VALUE
VarChar2(20)
The new value associated with the step after the
activity is performed.
NOTES
VarChar2(2048)
The content of the note that has been added to the
step, if any.
Primary key
ID
265
3
SKETCH_INSTANCES
Foreign keys
STEP_ID=SKETCH_STEPS.ID
SKETCH_INSTANCES
This table contains a record of each process manager instance that has been
started.
Table columns
Column name
Data type
Description
ID
Number(11,0)
A system generated unique identifier for the instance.
STARTED_FROM
VarChar2(1024)
The name of the process manager template from which this instance
was launched.
CREATED_AT
Date
The date on which this instance was started.
NAME
VarChar2(255)
The name of the instance.
LAST_SKETCH_ID
Number(11,0)
The ID of the last template that was opened for this instance.
COMPLETED
Number(1)
A flag that is set to 1 if this instance has completed.
CREATED_BY
VarChar2(4000)
Unique identifier of the user that created the instance.
ACCESSED_AT
Date
The date on which this instance was last opened.
ACCESSED_BY
VarChar2(4000)
Unique identifier of the user that last opened the instance.
COMPLETED_STATUS
VarChar2(4000)
The status of the instance. Possible values depend on how the system
has been installed but can include:
•
null
•
aborted
•
successful
ASSIGNED_TO_GUID
VarChar2(4000)
The unique reference as defined in the ENTITY_ID column of the
user to which this instance is assigned.
OVERDUE_STEPS
Number(1)
A flag that is set to 1 if any steps in the instance are overdue
Primary key
ID
Foreign keys
LAST_SKETCH_ID=SKETCHES.ID
266
3
SKETCH_STEPS
SKETCH_STEPS
This table contains a record of each step that has been executed in each process
manager instance.
Table columns
Column name
Data type
Description
ID
Number(11,0)
A unique system generated ID for the step.
SKETCH_ID
Number(11,0)
The ID of the related process manager instance. This ID identifies the
instance in the SKETCHES table.
STEP_VALUE
VarChar2(20)
The current value of the step.
NOTES
VarChar2(2048)
The note that has been added by the user to the step, if any.
ASSIGNED_TO_GUID
VarChar2(4000)
The unique reference as defined in the ENTITY_ID column of the
user to which this instance is assigned.
TEXT
VarChar2(2048)
The text description of the step. Used for reporting.
DUE
Date
Date the step is due to be completed or null if no due date.
Primary key
ID
Foreign keys
SKETCH_ID=SKETCHES.ID
SKETCHES
This table contains a record for each process manager template, launcher, and
instance. The record includes a detailed definition of the item.
Table columns
Column name
Data type
Description
ID
Number(11,0)
A system generated unique identifier for the entry.
NAME
VarChar2(255)
The name given by the user to the entry.
XML_DATA
Blob
The detailed definition of the template, launcher, or instance. The
definition is stored in XML format.
ENTITY_ID
VarChar2(4000)
Unique ID for the record.
SKETCH_INSTANCE_ID
Number(11,0)
Instance entries only. The ID of the corresponding instance in the
SKETCH_INSTANCE table.
267
3
SQL_HISTORY
Column name
Data type
Description
TYPE
VarChar2(255)
The type of entry:
•
TEMPLATE
•
LAUNCHER
•
INSTANCE
LAST_MODIFIED
TimeStamp(6)
The date and time the entry was last modified.
COPIED_FROM
VarChar2(4000)
The name of the launcher to which this instance is related.
Primary key
ID
Foreign keys
SKETCH_INSTANCE_ID=SKETCH_INSTANCES.ID
SQL_HISTORY
This table contains a record for each SQL statement run via the ICM Admin user
interface using the SQL worksheet feature.
NOTE: The SQL worksheet feature is only available to the super user madmin.
For more information on this user, see the System Administration Guide.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user that ran the SQL statement.
SQL_DATE
Date
The date and time that the SQL statement was run.
SQL_TEXT
VarChar2(4000)
The SQL statement that was run.
Primary key
USR_ID + SQL_DATE
Foreign keys
268
3
SS_MAPPING_D
SS_MAPPING_D
This table contains a de-normalized view of the SALES_STRUCTURE table. A
parent/child combination of every node and its full subordinate list is available
and used by the calculation and reporting processes to quickly identify
ownership. The table is built automatically by the server process every time the
sales structure is changed.
NOTE: The SS_TABLE_VIEW system parameter used in earlier releases of NICE
ICM is no longer used.
A many-to-many sales hierarchy relationship is supported by the SS_MM_CHILD
and SS_MM_PARENT fields. This relationship is only available if the sales structure
is not set as dynamic.
Table columns
Column name
Data type
Description
SS_NUMBER
Number(11,0)
The sales structure number.
V_START_DATE
Date
The start date of the sales structure record, if any.
V_END_DATE
Date
The end date of the sales structure record, if any.
SS_PARENT
VarChar2(100)
The parent code.
SS_CHILD
VarChar2(50)
The child code.
SS_MM_PARENT
VarChar2(100)
Holds a clean version of the parent code field for display and roll up purposes
in M2M hierarchies.
SS_MM_CHILD
VarChar2(100)
Holds a clean version of the code field for display and roll up purposes in
M2M hierarchies.
SS_SYNCH
Date
The date and time the sales structure was last synchronized
Primary key
None.
Foreign keys
None.
269
3
This table contains a record for each connector defined to the system. The table
is populated via ICM Admin by choosing Administration > Connectors.
Table columns
Column name
Data type
Description
CN_ID
Number(11,0)
A system generated unique ID for the connector.
CN_TYPE
Number(11,0)
The type of connector:
1 - Sales Force
2 - Web Service
3 - Other Database
4 - NICE ICM Listener
CN_DISPLAY_NAME
VarChar2(255)
The name of the connector.
CN_PORT
VarChar2(255)
Web Service only: the port to connect to.
CN_URL
VarChar2(255)
Web Service: the URL address for the Web Services
Description Language (WSDL) file.
Other Database: the URL connection to the database.
CN_DRIVER
VarChar2(255)
Other Database only: the name of the connector driver.
CN_USERNAME
VarChar2(255)
Sales Force: the Sales Force user name.
Other Database: the user name to connect to the database.
CN_PASSWORD
VarChar2(255)
Sales Force: the Sales Force password.
Other Database: the password to connect to the database.
Passwords are stored encrypted in this table.
CN_CLIENT
VarChar2(255)
NICE ICM Listener only: the client name.
CN_IN_XSLT
VarChar2(255)
NICE ICM Listener only: the path to the XSLT file for
transforming incoming XML message into NICE ICM.
CN_OUT_XSLT
VarChar2(255)
NICE ICM Listener only: the path to the XSLT file for
transforming XML messages returned by NICE ICM.
CN_EXT_APP_IN_Q
VarChar2(255)
NICE ICM Listener only: the Java Message Service queue
name where outgoing messages are listened for.
CN_EXT_APP_OUT_Q
VarChar2(255)
NICE ICM Listener only: the Java Message Service queue
name where incoming messages listened for.
CN_BULK_TABLE_LOAD
VarChar2(255)
NICE ICM Listener only: the table name to add bulk messages
to.
CN_BULK_TABLE_ASYNC_REQ_
HANDLE
VarChar2(255)
NICE ICM Listener only: the number of bulk load
asynchronous threads to create at start up.
Primary key
CN_ID
270
3
STAT_COMMENT_HEADER
Foreign keys
None.
STAT_COMMENT_HEADER
STAT_COMMENT_VALUES
STAT_PLANS
STAT_SECT_FIELDS
STAT_ZOOM_FIELDS
STATEMENT_BATCH_AUTH
This table contains the authorizations for statement batches. Each record
represents a single authorization of a statement batch. The table is populated
when a statement batch is authorized.
Table columns
Column name
Data type
Description
BATCH_ID
Number(11,0)
AUTH_LEVEL
Number(11,0)
The authorization level.
AUTH_SEQ
Number(11,0)
The sequence of the authorization within the authorization level
specified at AUTH_LEVEL.
AUTH_BY
Number(11,0)
The ID of the user that authorized the statement batch.
AUTH_DATE
Date
The date of authorization.
Number(11,0)
The ID of the delegate user that authorized the batch, if any.
271
3
Primary key
BATCH_ID + AUTH_LEVEL + AUTH_SEQ
Foreign keys
BATCH_ID = STATEMENT_BATCHES.SB_ID
AUTH_BY = USERS.USR_ID
This table contains the payees that exist within a statement batch. Each record
represents a payee within a statement batch. The table is populated when a
statement batch is created.
Table columns
Column name
Data type
Description
SB_ID
Number(11,0)
EMP_ID
Number(11,0)
WAS_UP_TO_DATE
Number(1)
Internal flag used by the statement build process.
Primary key
SB_ID + EMP_ID
Foreign keys
272
3
STATEMENT_BATCHES
STATEMENT_BATCHES
This table contains statement batches. Each record represents a statement batch.
The table is populated when a statement batch is created.
Table columns
Column name
Data type
Description
SB_ID
Number(11,0)
The internally generated unique ID for the batch.
FIN_YEAR_ID
Number(11,0)
The ID of the year.
FP_PERIOD_SEQ
Number(11,0)
NUMBER_EMPLOYEES
Number(11,0)
The number of payees associated with this batch.
SUBMITTED_DATE
Date
The date and time at which the batch was submitted.
SUBMITTED_BY
Number(11,0)
The ID of the user who originally submitted the batch.
SUBMITTED_NOTES
VarChar2(2000)
Notes associated with the batch submission, if any.
APPROVED
Number(1)
Flag indicating whether the batch has been approved.
-1 - Batch has been approved
APPROVED_DATE
Date
The date and time at which approval was gained, if any.
APPROVED_BY
Number(11,0)
The ID of the user who provided the final approval on the
batch, if any.
APPROVED_NOTES
VarChar2(2000)
Note associated with the approval, if any.
DECLINED
Number(1)
Flag indicating whether the batch has been declined.
DECLINED_DATE
Date
The date and time at which the batch was declined.
DECLINED_BY
Number(11,0)
The ID of the user who declined the batch.
DECLINED_NOTES
VarChar2(2000)
Notes associated with the declining of the batch, if any.
RELEASED
Number(1)
-1 - Batch has been declined
Flag indicating whether the batch has been released.
-1 - Batch has been released
EMAIL_TEXT
VarChar2(2000)
The body text to use on the notification email, if any.
EMAIL_SUBJECT
VarChar2(255)
The subject line to use on the notification email, if any.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
SB_MULTI
Number(1)
No longer used.
ATTACH_STATEMENT
Number(1)
Flag indicating whether a statement should be attached to
the notification emails.
-1 - Statement should be attached to the emails
AUTH_ID
Number(11,0)
The ID of the authorization rule used to approve the batch.
AUTH_LEVEL_1
Number(1)
Flag indicating whether the batch has been approved at
level 1.
AUTH_LEVEL_1_BY
Number(11,0)
The ID of the user who provided authorization at level 1.
AUTH_LEVEL_1_DATE
Date
The date and time at which level 1 authorization was
attained, if any.
273
3
STATEMENT_BATCHES
Column name
Data type
Description
AUTH_LEVEL_2
Number(1)
level 2.
AUTH_LEVEL_2_BY
Number(11,0)
The ID of the user who provided authorization at level 2, if
any.
AUTH_LEVEL_2_DATE
Date
attained, if any.
AUTH_LEVEL_3
Number(1)
level 3.
AUTH_LEVEL_3_BY
Number(11,0)
any.
AUTH_LEVEL_3_DATE
Date
attained, if any.
AUTH_LEVEL_4
Number(1)
level 4.
AUTH_LEVEL_4_BY
Number(11,0)
any.
AUTH_LEVEL_4_DATE
Date
attained if any.
AUTH_LEVEL_5
Number(1)
level 5.
AUTH_LEVEL_5_BY
Number(11,0)
any.
AUTH_LEVEL_5_DATE
Date
attained, if any.
EXECUTED_DATE
Date
The date and time at which the associated Release
Statements server job to release the statements ends its
execution.
STATEMENT_DATE
Date
The date of the last day of the period for which this
statement batch applies. Used to determine historical fields
for the statement batch.
Number(11,0)
The ID of the delegate user that submitted the batch, if any.
Number(11,0)
The ID of the delegate user that declined the batch, if any.
Number(11,0)
The ID of the delegate user that approved the batch, if any.
Primary key
SB_ID
Foreign keys
SUBMITTED_BY = USERS.USR_ID
FIN_YEAR_ID + FP_PERIOD_SEQ = FIN_PERIODS.[FIN_YEAR_ID _
FP_PERIOD_SEQ]
AUTH_ID = AUTH_RULES.
274
3
STATEMENT_GRAPH_ITEMS
STATEMENT_GRAPH_ITEMS
STATEMENT_GRAPHS
STATEMENT_ITEMS
STATEMENT_PLAN_SPECIFIC
STATEMENT_TITLES
STATEMENT_TYPES
STATEMENTS
SYSTEM_PARAMETERS
This table contains configuration parameters that control the application
behavior and the appearance of ICM Admin. It is pre-populated at installation,
but can be altered through ICM Admin.
Table columns
Column name
Data type
Description
SP_PARAMETER_GROUP
VarChar2(50)
The parameter group.
SP_PARAMETER
VarChar2(255)
The parameter name.
SP_VALUE
VarChar2(4000)
The value of the parameter.
275
3
SYSTEM_PARAMETERS
Column name
Data type
Description
SP_DESCRIPTION
VarChar2(255)
The description of the parameter.
SP_TYPE
Number(11,0)
The type of the parameter:
1 - Text
2 - Boolean
3 - Password
SP_PICKLIST
VarChar2(255)
The pick list for the parameter, if any.
SP_EMP_SELECT
Number(11,0)
Indicator as to the filter context for a payee dependent
parameter, if any.
SP_TRANSLATE_PL
Number(1)
Flag indicating whether the pick list should be passed through
the dictionary for display purposes.
SP_MULTI_PL
Number(1)
Flag indicating whether the parameter pick list can be
multi-selected.
-1 - Pick list can be multi-selected
PARAM_ID
Number(11,0)
The internally generated unique identifier for the parameter.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
SP_DISPLAY
VarChar2(40)
The display version of the parameter value.
SP_CUSTOM
Number(1)
Flag indicating whether the parameter is customized.
WZ_ID
Number(11,0)
The ID of the maintenance screen that the parameter belongs
to.
SP_LANGUAGE_SENSITIVE
Number(1)
Flag indicating a language-sensitive system parameter.
-1 - Parameter is customized
-1 - Language sensitive system parameter
Primary key
PARAM_ID
Foreign keys
WZ_ID = WIZARD_NAMES.WZ_ID
276
3
TAB_STATE
TAB_STATE
This table contains information about the tabs that have been opened by each
user and payee. The information is used to reopen the tabs in ICM Admin when
the user next logs in. The table contains a record for each tab that has been
opened by each user.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user who opened the tab.
USR_EMPLOYEE
Number(1)
No longer used. The value is always 0.
TAB_NUMBER
Number(11,0)
A number indicating the position of the tab. The value starts at 1 for the left
most tab.
TAB_CAPTION
VarChar2(255)
The text to be displayed on the tab header.
TAB_IMAGE
VarChar2(100)
The file name of the graphic to display in the tab header.
TAB_REF_NAME
VarChar2(100)
Unique internal code for the tab.
SELECTED
Number(1)
No longer used.
TAB_URL
VarChar2(2000)
The ICM Admin URL associated with the tab. For example:
palservlet?SYSACTION=USER_LANDING_PAGE)
Primary key
USR_ID + USR_EMPLOYEE + TAB_NUMBER
Foreign keys
TABLES
This table contains only one field called TABLE_NAME. The field TABLE_NAME holds
the name of an existing core table used by the system. There is one record for
each table. Additional entries can be added for temporary tables.
You can also create custom screens within the API file for editing and updating
custom tables through the user interface. You can use the names in the
TABLE_NAME table to check that you do not use the name of a core table for the
custom screen. For more information on the API file, see the API Guide.
277
3
TARGET_WORKSHEET
Table columns
Column name
Data type
Description
TABLE_NAME
VarChar2(50)
The table name.
Primary key
None.
Foreign keys
None.
TARGET_WORKSHEET
This table holds the current year that a user is working on in the target
worksheet in ICM Admin.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user.
FIN_YEAR_ID
Number(11,0)
The ID of the year.
Primary key
USR_ID
Foreign keys
278
3
TARGETS
TARGETS
This table contains the targets set against a plan. Each record represents a
specific target against a plan. It can be populated via the ICM Admin user
Table columns
Column name
Data type
Description
PLN_ID
Number(11,0)
The ID of the plan.
SEQUENCE
Number(11,0)
The sequence number of the target value. The number of sequence numbers
depends on the plan target frequency.
TRGT_VALUE
Number(15,2)
The target value.
Primary key
PLN_ID + SEQUENCE
Foreign keys
TASK_MANAGER
This table contains information about the currently running server tasks. The
information is used by ICM Admin to create the memory and CPU usage graphs
in the Server Information widget on the User Landing page.
Table columns
Column name
Data type
Description
TASK_SOURCE
Number(11,
0)
Not used. The value is always 1.
TASK_CPU_USAGE
Number(11,
0)
The CPU usage value as a percentage.
TASK_MEM_USAGE
Number(11,
0)
The memory usage value as a percentage.
TASK_DATE
Date
The date and time when the values were recorded in the table.
Primary key
TASK_SOURCE + TASK_DATE
279
3
TAX_BANDS
Foreign keys
None.
TAX_BANDS
This table contains the tax band associated with a tax group. Each record
represents a tax band.
Table columns
Column name
Data type
Description
TAX_ID
Number(11,0)
A unique identifier for the group and type. The system automatically
assigns this value.
TAX_BAND
VarChar2(50)
The tax type.
TAX_GROUP_ID
Number(11,0)
The tax group.
TAX_DEFAULT
Number(11,0)
Flag indicating if this is the default type for this tax group.
-1 - Default type
LAST_MODIFIED
Date
The date and time this record was last modified.
LAST_MODIFIED_BY
Number(11,0)
The ID of the user that last modified this record.
Primary key
TAX_ID
Foreign keys
TAX_GROUP_ID = TAX_GROUPS.TAX_GROUP_ID
LAST_MODIFIED = USERS.USR_ID
TAX_GROUPS
This table contains tax groups. Each record represents a tax group.
Table columns
Column name
Data type
Description
TAX_GROUP_ID
Number(11,0)
A unique identifier for the tax group. The system automatically assigns
this value.
TAX_GROUP
VarChar2(50)
The name of the tax group.
LAST_MODIFIED
Date
The date and time this record was last modified.
LAST_MODIFIED_BY
Number(11,0)
The ID of the user that last modified this record.
280
3
TAX_RATES
Column name
Data type
Description
DEFAULT_TAX_GROUP
Number(1)
A flag indicating whether this record is the default tax group.
TAX_POINT
Number(11,0)
The tax point:
1 - Payment date
2 - Earning date
TAX_CALC_LEVEL
Number(11,0)
The calculation level:
1 - Event
2 - Plan
3 - Payee
Primary key
TAX_GROUP_ID
Foreign keys
LAST_MODIFIED = USERS.USR_ID
TAX_RATES
This table contains the tax rates associated with a tax band. Each record
represents a tax rate.
Table columns
Column name
Data type
Description
TAX_ID
Number(11,0)
A unique identifier for the band and rate combination. The system
automatically assigns this value.
TAX_EFFECTIVE_DATE
Date
The effective date of the tax rate.
TAX_RATE
Number(20,8)
TAX_RATE_PROFILE_001
to
VarChar2(50)
You can define up to 20 extra fields for each tax rate. Profile fields 1-5
are reserved for text fields. However you can change this directly in
the database schema if you wish.
to
Number(15,2)
You can define up to 20 extra fields for each tax rate. Profile fields
6-10 are reserved for currency fields. However you can change this
directly in the database schema if you wish.
to
Date
You can define up to 20 extra fields for each tax rate. Profile fields
11-15 are reserved for date fields. However you can change this
to
Number(1)
You can define up to 20 extra fields for each tax rate. Profile fields 16
- 20 are reserved for boolean fields. However you can change this
281
3
TEMP_EMP_LIST
Primary key
TAX_ID + TAX_EFFECTIVE_DATE
Foreign keys
TAX_ID = TAX_BANDS.TAX_ID
TEMP_EMP_LIST
This is an internal table used by NICE ICM to work out which payees should be
included in a payment batch.
TEMPLATE_OTC
This table stores the assignment of OTC values within a plan template. Each
record represents a specific OTC value within the OTC grid in the plan template.
The table is populated via the ICM Admin user interface or via data ports.
Table columns
Column name
Data type
Description
PLN_ID
Number(11,0)
OTC_TYPE
VarChar2(75)
The identifier for the OTC assignment.
OTC_VALUE
Number(15,2)
The OTC as a literal value.
OTC_PCNT
Number(20,8)
The OTC as a percentage of salary.
FIN_YEAR_ID
Number(11,0)
ID of the financial year for which the OTC applies.
SEQUENCE
Number(11,0)
Indicates the position of this OTC value in the list of values for the plan. The
value starts at 1 for the top value.
Primary key
PLN_ID + FIN_YEAR_ID + OTC_TYPE + SEQUENCE
Foreign keys
282
3
TEMPLATE_TARGETS
TEMPLATE_TARGETS
This table stores the assignment of target values within a plan template. Each
record represents a specific target value within the target grid in the plan
template. The table is populated via the ICM Admin user interface or via data
ports.
Table columns
Column name
Data type
Description
PLN_ID
Number(11,0)
The ID of the plan.
SEQUENCE
Number(11,0)
The sequence number of the target.
TARGET_TYPE
VarChar2(75)
The identifier for the target assignment.
TRGT_VALUE
Number(15,2)
The target value.
FIN_YEAR_ID
Number(11,0)
The ID of the financial year for which this target applies.
Primary key
PLN_ID + TARGET_TYPE
Foreign keys
TRAN_BULK_UPDATE_FILTER_FLDS
This table contains information about the events to find for a bulk update. Each
record defines a filter rule for a specific bulk update. The table is populated via
ICM Admin using the Records To Find section in the Update Events tab.
Table columns
Column name
Data type
Description
TBU_ID
Number(11,0)
The ID of the bulk update.
SEQUENCE
Number(11,0)
A sequence number to indicate the order in which the filter is applied. The
sequence starts at 1.
FILTER_TYPE
Number(11,0)
The type of filter to apply:
1 - Event Filter
2 - Assigned Events Filter
3 - Plan Filter
COMP_FIELD
VarChar2(50)
The database name of the field involved in the filter.
283
3
Column name
Data type
Description
COMP_HOW
Number(11,0)
The comparison operation involved in the filter:
1 - Is not equal to
2 - Is equal to
3 - Is greater than
4 - Is less than
5 - Is greater than or equal to
6 - Is less than or equal to
7 - Contains
8 - Does not contain
9 - Is Empty
10 - Is not empty
11 - Looks like
12 - Does not look like
13 - Is in list
14 - Is not in list
COMP_VALUE
VarChar2(2000)
The value that the field is to be compared with.
Primary key
TBU_ID + FILTER_TYPE + SEQUENCE
Foreign keys
TBU_ID = TRAN_BULK_UPDATES.TBU_ID
This table contains information about the columns to display in the preview of
a bulk update. Each record defines a column to display in the preview for a
specific bulk update. The table is populated via ICM Admin using the Preview
Configuration section in the Update Events tab.
Table columns
Column name
Data type
Description
TBU_ID
Number(11,0)
SEQUENCE
Number(11,0)
A sequence number to indicate the order in which the column is to be displayed
in the preview. The sequence starts at 1.
FIELD
VarChar2(50)
The database name of the column to be displayed in the preview.
SOURCE_TYPE
Number(11,0)
The source type.
284
3
Primary key
TBU_ID + SEQUENCE
Foreign keys
This table contains information about the fields to be updated by a bulk update.
Each record defines the value to be given to a field by a specific bulk update. The
table is populated via ICM Admin using the Value With Which To Update Matching
Records section in the Update Events tab.
Table columns
Column name
Data type
Description
TBU_ID
Number(11,0)
SEQUENCE
Number(11,0)
A sequence number to indicate the order in which the fields are to be updated.
The sequence starts at 1.
FIELD_NAME
VarChar2(50)
The database name of the column to be displayed in the preview.
FIELD_VALUE
VarChar2(50)
The value to be written to the field by the bulk update.
Primary key
TBU_ID + SEQUENCE
Foreign keys
TRAN_BULK_UPDATES
This table contains information about bulk updates. Each record defines an
instance of a bulk update. The table is populated via ICM Admin using the
Update Events Summary section in the Update Events tab.
Table columns
Column name
Data type
Description
TBU_ID
Number(11,0)
A system generated unique ID for the bulk update
NAME
VarChar2(50)
The name of the bulk update.
285
3
TRAN_EXT
Column name
Data type
Description
RECORD_GROUP
VarChar2(50)
The group to which the bulk update belongs.
DESCRIPTION
VarChar2(2000)
A description of the bulk update.
Primary key
TBU_ID
Foreign keys
None.
TRAN_EXT
This table contains the top level values within the event extension profile.
Table columns
Column name
Data type
Description
TX_ID
Number(11,0)
The ID of the event extension.
TX_DS
Number(11,0)
The field constant of this extension. This is allocated automatically on
save.
TX_NAME
VarChar2(100)
The name of the extension.
TX_TYPE
Number(11,0)
The return type of the extension:
0 - Count
1 - Total
2 - Average
3 - Maximum
4 - Minimum
5 - User specified SQL
TX_CURRENT
Number(1)
Flag indicating whether the match should include the current event.
TX_RETURN_FIELD
VarChar2(50)
The name of the event profile field being retrieved. This field is null if the
extension type specified in the TX_TYPE column is Count or User
specified SQL.
LAST_MODIFIED
Date
The date and time at which this record was last updated.
LAST_MODIFIED_BY
Number(11,0)
The ID of the user that last updated this record.
TX_SQL
VarChar2(2000)
The SQL to use if the extension type specified in the TX_TYPE column is
user-specified SQL.
Primary key
TX_ID
286
3
TRAN_EXT_MATCH
Foreign keys
TRAN_EXT_MATCH
This table contains the local and remote match fields used by the event
extension.
Table columns
Column name
Data type
Description
TX_ID
Number(11,0)
The ID of the event extension.
TX_SEQ
Number(11,0)
The sequence number of this entry within the match field.
TX_LOCAL
VarChar2(50)
The name of the field in the event currently being processed, that will be used
to match with.
TX_OPERATION
Number(11,0)
The operation code of the match line.
TX_REMOTE
VarChar2(50)
The name of the field to compare the local field to for the purposes of
matching.
Primary key
TX_ID + TX_SEQ
Foreign keys
None.
TRAN_RECALC
TRAN_SUM_ITEMS
This table contains the fields within a value definition. Each record represents a
field and its associated mathematical operator within a value definition. The
table is populated via the ICM Admin user interface.
287
3
TRAN_SUMS
Table columns
Column name
Data type
Description
SUM_ID
Number(11,0
)
The ID of the value definition.
SUM_SEQUENCE
Number(11,0
)
The sequence number of the value definition item.
SUM_OPERATION
Number(11,0
)
The operation code for the following field:
1 - Plus
2 - Minus
3 - Multiply
4 - Divide
SUM_FIELD_NAME
VarChar2(30)
The event field name for this value definition field.
Primary key
SUM_ID + SUM_SEQUENCE
Foreign keys
SUM_ID = TRAN_SUMS.SUM_ID
TRAN_SUMS
This table contains value definitions. Each record represents a value definition.
The table is populated through the ICM Admin user interface.
Table columns
Column name
Data type
Description
SUM_ID
Number(11,0)
The internally generated unique identifier for the value definition.
SUM_NAME
VarChar2(50)
The name of the value definition.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
Primary key
SUM_ID
Foreign keys
None.
288
3
TRANSACTIONS
TRANSACTIONS
This table contains events. Each record represents an event. The table is
normally populated via data ports.
Table columns
Column name
Data type
Description
TRN_ID
Number(11,0)
The internally generated unique ID of the event.
TRN_ORDER_DATE
Date
The date.
TRN_REFERENCE_DATE
Date
The reference date.
CUR_ID
Number(11,0)
The ID of the event currency.
TRN_CUR_VALUE
Number(15,2)
The event value in base currency, calculated on loading into the
system.
TRN_ORDER_VALUE
Number(15,2)
The event value in currency of sale.
TRN_COST_OF_SALE
Number(15,2)
The event cost of sale.
TRN_ORDER_QTY
Number(11,0)
The quantity of items associated with this event.
TRN_PARTNER_NAME
VarChar2(100)
The partner name, if any.
TRN_PARTNER_GROUP
VarChar2(50)
The partner group, if any.
TRN_PARTNER_TYPE
VarChar2(50)
No longer used.
TRN_PRODUCT_CODE
VarChar2(50)
The product code.
TRN_PRODUCT_TYPE
VarChar2(50)
The product type.
TRN_PRODUCT_GROUP
VarChar2(50)
The product group.
TRN_PRODUCT_CATEGORY
VarChar2(50)
The product category.
TRN_TYPE
VarChar2(50)
The event type.
DS_ID
Number(11,0)
The ID of the data port that loaded the event.
ADJ_DESCRIPTION
VarChar2(255)
No longer used.
ADI_CREATED
Date
No longer used.
FIN_YEAR_ID
Number(11,0)
The ID of the year that this event relates to.
FP_PERIOD_SEQ
Number(11,0)
The ID of the period that this event relates to.
TRN_UD1 to TRN_UD10
VarChar2(50)
The event custom fields 1 to 10 values as defined in the shared
profile.
TRN_UD1_GROUP to
TRN_UD10_GROUP
VarChar2(50)
The event custom fields 1 to 10 group values. Used if Ref Table
and Group are selected in the shared profile and a group defined
in reference data.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
VarChar2(50)
TRN_PCNT
Number(20,8)
The event percentage.
TRN_CREDIT_PCNT
Number(20,8)
The event credit percentage.
QUARTER
Number(11,0)
The ID of the quarter related to this event.
TRN_RESELLER_NAME
VarChar2(75)
The Reseller name.
TRN_RESELLER_GROUP
VarChar2(75)
The Reseller group.
289
3
TRANSACTIONS
Column name
Data type
Description
TRN_RESELLER_TYPE
VarChar2(75)
No longer used.
TRN_PO_NUMBER
VarChar2(50)
No longer used.
TRN_PROFILE_1 to
TRN_PROFILE_8
VarChar2(50)
Profile fields TRN_PROFILE_1 to TRN_PROFILE_200 are set up
by choosing Administration > System Configuration > Event in
ICM Admin and adding fields to the Profile fields section.
The event profile fields 1 to 8.
TRN_PROFILE_9 to
TRN_PROFILE_10
VarChar2(250)
TRN_PROFILE_11to
TRN_PROFILE_15
Number(15,2)
TRN_PROFILE_16 to
TRN_PROFILE_20
Number(1)
TRN_PROFILE_21 to
TRN_PROFILE_22
Date
TRN_FAIL_COUNT
Number(11,0)
No longer used.
FAIL_TYPE
Number(11,0)
No longer used.
TRN_RESOLVED
Number(11,0)
No longer used.
TRN_PROFILE_23 to
TRN_PROFILE_32
VarChar2(50)
TRN_PROFILE_33 to
TRN_PROFILE_37
Number(15,2)
TRN_PROFILE_38 to
TRN_PROFILE_42
Number(1)
TRN_PROFILE_43 to
TRN_PROFILE_48
Date
TRN_WEEK_NO
Number(11,0)
The week of period.
TRN_DISABLED
Number(1)
Flag indicating whether the event is disabled.
TRN_JOB_ID
Number(11,0)
The ID of the job that loaded the event.
TRN_DATA_SET
Number(11,0)
The data set to which the event belongs.
TRN_PROFILE_49 to
TRN_PROFILE_60
VarChar2(50)
TRN_UD1_TYPE to
TRN_UD6_TYPE
VarChar2(50)
No longer used.
TRN_YEAR_WEEK
Number(11,0)
The week of year.
TRN_PERIOD_WEEK
Number(11,0)
The week of the period.
TRN_DAY
Number(11,0)
The day of the period.
TRN_PRODUCT_CLASS_1 to
TRN_PRODUCT_CLASS_10
VarChar2(50)
The product classification fields 1 to 10.
TRN_PROFILE_61 to
TRN_PROFILE_75
VarChar2(50)
TRN_PROFILE_76 to
TRN_PROFILE_80
Number(15,2)
TRN_UD7_TYPE to
TRN_UD10_TYPE
VarChar2(50)
No longer used.
290
3
TRANSACTIONS_CLOSED_LEG
Column name
Data type
Description
TRN_UD1_NAME to
TRN_UD10_NAME
VarChar2(100)
The event custom fields 1 to 10 name values.
TRN_PROFILE_81 to
TRN_PROFILE_86
Date
TRN_PROFILE_87 to
TRN_PROFILE_92
Number(15,2)
TRN_PROFILE_93 to
TRN_PROFILE_94
Number(1)
TRN_PROFILE_95 to
TRN_PROFILE_100
VarChar2(50)
TRN_TYPE_NAME
VarChar2(75)
The event type name, if any.
TRN_TYPE_GROUP
VarChar2(75)
The event type group, if any.
TRN_PARTNER
VarChar2(50)
The partner code.
TRN_RESELLER
VarChar2(50)
The Reseller code.
TRN_CUSTOMER
VarChar2(50)
The customer code.
TRN_CUSTOMER_NAME
VarChar2(75)
The customer name.
TRN_CUSTOMER_GROUP
VarChar2(50)
The customer group.
TRN_PRODUCT_NAME
VarChar2(100)
The product name.
TRN_PROFILE_101 to
TRN_PROFILE_180
VarChar2(255)
TRN_PROFILE_181 to
TRN_PROFILE_200
Number(15,2)
TRN_INIT_JOB_ID
Number(11,0)
The ID of the server job that initially loaded this event.
TRN_PRICE_LIST
Number(1)
The ID of the associated price list.
Primary key
TRN_ID
Foreign keys
FP_PERIOD_SEQ]
TRN_JOB_ID = JOBS.JOB_ID
TRANSACTIONS_CLOSED_LEG
This table is a legacy table used when updating from versions of NICE ICM prior
to 3.0. The table is no longer used.
291
3
TRANSACTIONS_MANAGED_LEG
TRANSACTIONS_MANAGED_LEG
This table is a legacy table used when updating from versions of NICE ICM prior
to 3.0. The table is no longer used.
TRANSACTIONS_PENDING
TRANSACTIONS_S_CLOSED
This table is an internal table used to store event changes since the last
statement batch. The table is used via a view called TRANSACTIONS_CLOSED to
provide statement zoom for payees.
TRANSACTIONS_S_MANAGED
statement batch. The table is used via a view called TRANSACTIONS_MANAGED to
provide statement zoom for managers.
TRN_S_MANAGED_ID
statement batch.
UP_DRAW_AMOUNTS
This table is used when modelling and contains values to use to update a draw.
UPD_EMPLOYEE_DRAW_AMOUNTS
This table is used to store the specific draw values associated with any draw
being added as part of a model. The table is populated by the ICM Admin user
interface.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The user ID, if any.
TEM_ID
Number(11,0)
The model ID, if any.
292
3
Column name
Data type
Description
VALUE_ID
Number(11,0)
The model section ID, if any.
FP_PERIOD_SEQ
Number(11,0)
DRAW_AMOUNT
Number(15,2)
The draw amount.
Primary key
USR_ID + TEM_ID + VALUE_ID + FP_PERIOD_SEQ
Foreign keys
TEM_ID + VALUE_ID = FORECAST_VALUES.[TEM_ID + VALUE_ID]
This table is used to store a draw being added to plans as part of a model. The
table is populated by the ICM Admin user interface.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user, if any.
TEM_ID
Number(11,0)
The ID of the model, if any.
VALUE_ID
Number(11,0)
The ID of the model section, if any.
DRAW_NAME
VarChar2(75)
The name of the draw.
DRAW_TYPE
Number(11,0)
The type of the draw.
1 - Recoverable Draw
2 - Non Recoverable Draw
3 - Recoverable Guarantee
4 - Non Recoverable Guarantee
5 - Additional Payment
6 - Suspended Payment
8 - Recoverable Cap
9 - Non Recoverable Cap
FIN_YEAR_ID
Number(11,0)
The ID of the year.
EMP_ID
Number(11,0)
No longer used.
DRAW_FROM
Number(11,0)
The ID of the start period of the draw.
DRAW_TO
Number(11,0)
The ID of the end period of the draw.
DRAW_PCNT
Number(20,8)
The percentage of the specified type of value associated with the
draw.
293
3
UPDATE_PLAN_CALC_INPUTS
Column name
Data type
Description
DRAW_PAYMENT_TYPE
Number(11,0)
The payment type of the draw.
1 - % of Salary
2 - % of OTC
3 - % of OTE
4 - Specified Amounts
5 - % of period salary
6 - % of period OTC
7 - % of period OTE
PLN_NAME
VarChar2(75)
The plan name.
DRAW_TAX_GROUP
Number(11,0)
The ID of the tax group for the draw.
DRAW_TAX_CODE
Number(11,0)
The ID of the tax band for the draw.
DRAW_RECOVER_AFTER
Number(11,0)
No longer used.
Primary key
USR_ID + TEM_ID + VALUE_ID
Foreign keys
EMP_ID = EMPLOYERS.EMP_ID
FIN_YEAR_ID + DRAW_FROM = FIN_PERIODS.[FIN_YEAR_ID + FP_PERIOD_SEQ]
FIN_YEAR_ID + DRAW_TO = FIN_PERIODS.[FIN_YEAR_ID + FP_PERIOD_SEQ]
DRAW_TAX_GROUP = TAX_GROUPS.TAX_GROUP_ID
DRAW_TAX_CODE = TAX_BANDS.TAX_ID
UPDATE_PLAN_CALC_INPUTS
This table is used to store changes applied to ASK input values by users as part of
a model section. The table is populated by the ICM Admin user interface.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
TEM_ID
Number(11,0)
VALUE_ID
Number(11,0)
CALC_ID
Number(11,0)
INPUT_NAME
VarChar2(100)
The name of the ASK input.
INPUT_VALUE
VarChar2(100)
The value of the ASK input.
294
3
UPDATE_PLAN_ITEMS
Primary key
USR_ID + TEM_ID + VALUE_ID + CALC_ID + INPUT_NAME + INPUT_VALUE
Foreign keys
UPDATE_PLAN_ITEMS
This table stores identifiers for each change to make to plans as part of a model
section. Each record represents a specific change to apply. The table is populated
via the ICM Admin user interface.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
SEQUENCE
Number(11,0)
The sequence number of the update item.
UPDATE_FIELD
VarChar2(50)
The code of the update type.
UPDATE_VALUE
VarChar2(50)
The value of the update type.
TEM_ID
Number(11,0)
VALUE_ID
Number(11,0)
UPDATE_OPTIONS
VarChar2(2000)
The options associated with the update type, if any.
ELEMENT_ID
Number(11,0)
The ID of the plan addition record.
ELEMENT_TYPE
Number(11,0)
Indicator as to the type of plan addition:
3 - SPIF
4 - Calculator
5 - Clawback
Primary key
USR_ID + TEM_ID + VALUE_ID + SEQUENCE
Foreign keys
295
3
UPDATE_PLANS
UPDATE_PLANS
This table stores the changes to make to plans as part of a model section. Each
record represents the plan level field values to change. The table is populated via
the ICM Admin user interface.
UPDATE_TARGETS
This table is used to store changes applied to target values by user as part of a
model section. The table is populated by the ICM Admin user interface.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
SEQUENCE
Number(11,0)
The target sequence number.
TRGT_VALUE
Number(15,2)
The target value.
TEM_ID
Number(11,0)
VALUE_ID
Number(11,0)
The ID of the model section.
Primary key
USR_ID + TEM_ID + VALUE_ID + SEQUENCE
Foreign keys
USER_ACCESS
This table contains the user access rights. Each record represents the access rights
of a user to a specific data area and any associated authorization rules. The table
is populated via the ICM Admin user interface.
Every type of user has records in this table, even if the user is an Admin user or
an Editor/Reviewer user with unrestricted access. For Editor users, the record
includes the ID of any associated authorization rule.
296
3
USER_OPTIONS
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user.
OPTION_CODE
VarChar2(50)
The code of the data area.
OPTION_ACCESS
Number(1)
Flag indicating whether the user has read access to the data area.
OPTION_WRITE
Number(1)
Flag indicating whether the user has write access to the data area.
NEEDS_AUTHORITY
VarChar2(50)
Flag indicating whether the user requires authorization to perform the
action
-1 - Authorization required
AUTH_ID
Number(11,0)
The ID of the authorization rule against the user and data area, if any.
Primary key
USR_ID + OPTION_CODE
Foreign keys
USER_OPTIONS
This table contains the names of all the user options that access can be granted
to, and is used for reporting and display purposes. Each record represents a data
area to which access can be granted. The table is populated by the ICM server.
Table columns
Column name
Data type
Description
OPTION_CODE
VarChar2(50)
The code of the data area.
OPTION_NAME
VarChar2(255)
The name of the data area.
OPTION_LANGUAGE_ID
VarChar2(10)
The ID of the language.
Primary key
OPTION_CODE + OPTION_LANGUAGE_ID
Foreign keys
None.
297
3
USER_SETTINGS
USER_SETTINGS
This table contains user setting information. Currently the only information
held in the table is to do with the position of the row links such as Show Details
on the Payees, Events, and custom screens in ICM Admin. By default the table is
entry in a new NICE ICM installation, indicating the links are on the right for all
users.
This table is populated when the user selects Configure column order in the
action bar of one of these screens.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user.
PAGE_NAME
VarChar2(50
The name of the underlying table for the
screen (EMPLOYEES, TRANSACTIONS, or
custom table name).
SETTING_NAME
VarChar2(50)
Has the value LINK_ORDER to indicate the
setting is for the position of the row links such
as Show Details.
SETTING_VALUE
VarChar2(4000)
For the LINK_ORDER setting:
true - The links are on the left of the columns.
false - The links are on the right of the
columns.
Primary key
None.
Foreign keys
None.
298
3
USER_SETTINGS_COL_ORDER
USER_SETTINGS_COL_ORDER
This table contains the user setting information. Currently the only information
held in the table is to do with the ordering of the columns on the Payees, Events,
and custom screens in ICM Admin.
This table is populated when the user selects Configure column order in the
action bar of one of these screens.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The ID of the user.
LIST_TYPE
VarChar2(200
The name of the underlying table for the
screen (EMPLOYEES, TRANSACTIONS, or
custom table name).
SORT_ORDER
Number(11,0)
The display position of the column specified
in the VALUE. The position is numbered from
the left starting at 1 for the left-most column.
VALUE
VarChar2(200)
The name of a column to be displayed.
Primary key
None.
Foreign keys
None.
USER_WIDGETS
This table contains the widgets to be displayed on the ICM Admin user landing
page of each user. User specified settings for the widgets are stored in the
USER_WIDGETS_SETTINGS table.
Table columns
Column name
Data type
Description
WIDGET_ID
Number(11,0)
A system generated unique ID.
299
3
USER_WIDGETS
Column name
Data type
Description
WIDGET_TYPE
Number(11,0)
The type of widget:
1 - Server Information
2 - Report
3 - Active Jobs
4 - Queued Jobs
5 - Aborted Jobs
6 - Data port Warning
8 - Report Usage
9 - Payee Usage
10 - Integration
13 - Utilities
14 - Logged in Users
15 - Health Monitor
USER_ID
Number(11,0)
The ID of the user for which this widget is to appear.
WIDGET_TITLE
VarChar2(255)
The title of the widget. For a list of possible titles, see the
WIDGET_TYPE column.
REFRESH_INTERVAL
Number(11,0)
The refresh interval in seconds for this widget.
0 indicates the widget is not refreshed automatically.
DASHBOARD_TYPE
Number(11,0)
The type of dashboard being viewed:
1 - Control panel
2 - Landing page
WIDGET_POSITION
Number(11,0)
The position of the widget on the user landing page. Numbering starts
at 0 for the top left widget and then numbers across and down. Initially
when the user landing page is set up, the position is set to 0 for all
widgets to indicate they are in the default position.
WIDGET_MINIMIZED
Number(11,0)
A flag to indicate whether the widget is to be displayed minimized.
-1 - Display widget minimized
Primary key
WIDGET_ID
Foreign keys
300
3
This table contains user settings for the widgets to be displayed on the ICM
Admin user landing page of each user.
Table columns
Column name
Data type
Description
WIDGET_SETTINGS_ID
Number(11,0)
A system generated unique ID.
WIDGET_ID
Number(11,0)
The ID of the widget to which this setting applies.
SETTING_TYPE
VarCHar2(255)
The type of setting.
SETTING_VALUE
Blob
The value of the setting.
Primary key
None.
Foreign keys
WIDGET_ID = USER_WIDGETS.WIDGET_ID
USERS
This table contains user information. Each record represents a user account or
template. The table is populated via the ICM Admin user interface or via data
ports.
Table columns
Column name
Data type
Description
USR_ID
Number(11,0)
The internally generated unique ID for the user.
USR_USER_ACCOUNT
VarChar2(50)
The user account name.
USR_USER_NAME
VarChar2(50)
The user name.
USR_EMAIL
VarChar2(100)
The user email address.
USR_APPROVE_STATEMENT
Number(1)
No longer used.
USR_ACCESS_LEVEL
Number(11,0)
The main user access level.
1 - Admin
2 - Reviewer
3 - Editor
4 - Access Controller
5 - Payee
301
3
USERS
Column name
Data type
Description
USR_SECURITY_CODE
VarChar2(50)
The current active security code for the user.
USR_DELETED
Number(1)
Flag indicating whether this used has been deleted.
LAST_MODIFIED
Date
LAST_MODIFIED_BY
Number(11,0)
USR_EMPLOYEE_MRU
VarChar2(255)
The MRU list for the Payee menu.
-1 - This record has been deleted
USR_USER_GROUP
VarChar2(50)
The user group.
USR_DATA_RESTRICTED
Number(1)
Flag indicating whether data access is restricted for this
user.
USR_OPTIONS_RESTRICTED
Number(1)
Flag indicating whether option access is restricted for this
user.
USR_EMP_1 to USR_EMP_4
VarChar2(30)
The first to fourth column field name for payee lists.
USR_EMP_TERM
Number(1)
Flag indicating whether the user can view terminated
payees.
-1 - Access to data is restricted
-1 - Option access is restricted
-1 - Can view terminated payees
USR_MAX_LIST_SIZE
Number(11,0)
The maximum list size for lists.
USR_ADD_REPORTS
Number(11,0)
No longer used.
USR_DELETE_TRANS
Number(1)
Flag indicating whether this user can delete events.
-1 - User can delete events
USR_PRODUCTS_CAT
Number(1)
Flag indicating whether reference data areas should be
categorized by default for the user.
-1 - Reference data areas should be categorized
USR_SYSTEM_STATUS
Number(1)
Flag indicating whether the user can access the server
status options.
-1 - User has access to server status options
USR_RECOMMENDATION_AUTH
Number(11,0)
No longer used.
USR_APPROVE_
PAYMENT
Number(11,0)
No longer used.
USR_SHOW_CLOSED
Number(1)
Flag indicating whether the user can view data from
closed years.
-1 - User can view closed years
USR_PERFORMANCE_ONLY
Number(1)
Flag indicating whether this user is denied access to
payment related data.
-1 - User cannot access payment related data
USR_SHOW_NON_PAID
Number(1)
Flag indicating whether the user can view non-paid
payees.
-1 - User can view non-paid payees
USR_ACCESS_EMP
Number(1)
No longer used.
USR_CONTACT_VIEW
Number(1)
Flag indicating whether the user has currently selected the
contact view of the payees.
-1 - Contact view is currently selected
USR_PG_OPEN
VarChar2(255)
Contains all currently expanded plan groups for the user.
302
3
USERS
Column name
Data type
Description
USR_HIDE_PLANS
Number(1)
Flag indicating whether the user can hide plans on the
payee screen.
USR_UD1 to USR_UD6
VarChar2(50)
The value of user custom field 1 to 6, if any.
USR_TRAN_1 to USR_TRAN_4
VarChar2(50)
The first to fourth event field to show in the event list.
USR_QDE_ID
Number(11,0)
The ID of the QDE profile used by the user, if any.
USR_IS_TEMPLATE
Number(1)
Flag indicating whether the user is a template.
-1 - User can hide plans
-1 - User is a template
USR_USER_PASS
VarChar2(250)
The encrypted user password. Only used when migrating
users from NICE ICM version 3.2. When a migrated user
logs in to NICE ICM for the first time, the user must reset
the password and this field is not used for subsequent log
ins.
USR_QUERIES
Number(11,0)
Indicator as to the level of query system access that this
use has:
0 - None
1 - Global
2 - Personal
USR_SHOW_MODEL
Number(1)
Flag indicating whether the user can view model payees.
-1 - User can view model payees
USR_EMP_GRP_1 to
USR_EMP_GRP_3
VarChar2(30)
The payee fields to be used to group payees.
USR_MAX_NAV_LINES
Number(11,0)
The maximum number of rows that ICM Admin uses to
build the Payee Navigator and the Table Calculator grid.
USR_REF_WORKSHEET
Number(1)
Flag indicating whether reference data should be
displayed in a worksheet rather than in a list.
-1 - Reference data should be displayed in a worksheet
USR_SYNCH_DATE
Date
No longer used.
USR_HIDE_NONPUBLIC
Number(1)
Flag indicating whether information for financial years
that are not marked as public should be hidden.
-1 Information not marked as public is hidden.
USR_REGION
Number(11,0)
The ID of the region to which this user belongs.
USR_CREATED_DATE
Date
The date and time the user was created.
USR_PREF_NUM_DASH_COLS
Number(11,0)
The number of columns to display for the User Landing
page and the Administrator Control Panel in ICM Admin.
USR_DISPLAY_USER_LANDING
Number(1)
Flag indicating whether the user landing page should be
displayed when the user accesses ICM Admin.
-1 - User landing page is displayed
USR_CLOSE_TABS_ON_EXIT
Number(1)
Flag indicating whether ICM Admin should close all the
open tabs when a user closes the ICM Admin window or
signs out of the system The field is set by the Reset Tabs
Between User Sessions check box on the user preferences
page of NICE ICM.
-1 - NICE ICM closes all tabs when user closes NICE ICM
window
USR_PROMPT_ON_EXIT
Number(1)
No longer used.
303
3
VAT_RATES_HEADER
Column name
Data type
Description
ENTITY_ID
VarChar2(4000)
The unique reference ID for this user.
SYNC_DATE
Date
MOBILE_ACCESS
Number(11,0)
Flag indicating whether this user is able to access the
mobile SCA application.
-1 - User can access mobile SCA
SYNC_STATUS_CODE
VarChar2(255)
Possible codes are:
•
SUCCESS
•
NOT_FOUND
•
DUPLICATE_FOUND
•
BAD_DATA
•
INTERNAL_ERROR
A value of null indicates synchronization has not yet
started for the user.
SYNC_STATUS_INFO
VarChar2(4000)
Details of the synchronization result. For example, an
error description if the synchronization failed.
Primary key
USR_ID
Foreign keys
USR_QDE_ID = QDE_PROFILES.QDE_ID
USR_REGION = REGIONS.REGION_ID
VAT_RATES_HEADER
VAT_RATES_ITEMS
WIZ_ ...
These tables are used internally by the system to define a unique ID for each
system parameter group.
WIZARD_NAMES
This table is used internally by the system to hold a list of the system parameter
group names.
304
3
WIZARD_NAMES
305
3
WIZARD_NAMES
306
4
Service Platform Schema Reference
This chapter provides the following information about each table in the service
platform schema:
•
user interface, and a brief description of its use.
•
•
P_NOTIFICATION_LOG
This table holds a record for each email notification that is sent by the service
platform.
Table columns
Column name
Data type
Description
ID
Number(19)
Unique identifier of the log entry.
DETAIL
VarChar2(4000)
Body of the email notification.
EMAIL_ADDRESS
VarChar2(256)
Recipient email address for the notification
ENTITY_ID
VarChar2(256)
Entity ID for the recipient user account.
FAILED
Number(1)
Flag indicating whether the email was not successfully delivered:
1 - Not successfully sent
0 - Sent OK
LOG_TIME
Timestamp(6)
Time stamp of when the notification was sent.
SUBJECT
VarChar2(256)
Subject of the email notification.
Primary key
ID
Foreign key
None.
307
4
P_SLAVE_APP_USER_TO_DELETE
P_SLAVE_APP_USER_TO_DELETE
This table is holds details of slave application accounts that are due to be
deleted. When an account is deleted at the slave application, the service
platform removes its entry from this table.
Table columns
Column name
Data type
Description
ID
Number(19)
Unique identifier for the record.
APP_KEY
VarChar2(256)
Key identifying the slave application where the account is to be
deleted. For example:
mps
icm-users
icm-employees
icm-contacts
ENTITY_ID
VarChar2(256)
Entity ID of the account to be deleted.
Primary key
ID
Foreign key
None.
P_SCHEDULED_NOTIFICATION
This table holds notifications that have been scheduled for being sent at a
particular date and time.
Table columns
Column name
Data type
Description
ID
Number(19)
Unique ID for the record.
BODY
VarChar2(2048)
The body of the email notification.
ENTITY_ID
VarChar2(256)
Entity ID for recipient of the notification.
NOTIFIED
Number(1)
Flag indicating whether the notification has been sent:
1 - Sent
0 - Not yet sent
NOTIFY_ON
Timestamp(6)
Time stamp of the date and time when the service platform is to
send the notification.
308
4
PLATFORM_FIELD_DEFINITION
Column name
Data type
Description
SEND_TO_PROFILE
VarChar2(256)
The portal profile to which the notification is to be sent. All users
belonging to this profile receive the message. If this field is null.
the SEND_TO value is used.
SUBJECT
VarChar2(256)
The subject of the email notification.
SEND_TO
VarChar2(256)
The recipient email address. Not used if SEND_TO_PROFILE has a
value.
Primary key
ID
Foreign key
None.
PLATFORM_FIELD_DEFINITION
This table defines the custom fields that are associated with user objects. The
actual values of the fields are held in the PLATFORM_FIELD_VALUE table.
The service platform automatically creates these field definitions using the field
mappings defined for the service.usermanagement.mapping.details
configuration key. For more on these configuration keys, see the System
Table columns
Column name
Data type
Description
ID
Number(19)
A unique identifier automatically generated by the system.
FIELD_NAME
VarChar2(256)
FIELD_TYPE
Number(10)
The type of the field:
1- String
2 - Long
3- Boolean
4 - Date
5 - Historical
6 - Object
Primary key
ID
309
4
PLATFORM_FIELD_VALUE
Foreign key
None.
PLATFORM_FIELD_VALUE
This table contains the values for the user object custom fields.
One of the BOOLEAN_VALUE, DATE_VALUE, STRING_VALUE, or STRING_VALUE
columns in the table contains the field value depending on the field type as
defined in the PLATFORM_FIELD_DEFINITIONS table.
Table columns
Column name
Data type
Description
ID
Number(19)
A unique identifier automatically generated by the
system.
BOOLEAN_VALUE
Number(1)
The value of the field if the field type is boolean.
DATE_VALUE
Timestamp(6)
The value of the field if the field type is date.
NUMBER_VALUE
Number(19)
STRING_VALUE
VarChar2(1000)
PLATFORM_FIELD_DEFINITION_ID
Number(19)
The ID of the field as defined in the
PLATFORM_FIELD_DEFINITION table.
PLATFORM_USER_ID
Number(19)
The ID of the user object to which this field value
applies.
Primary key
ID
Foreign key
PLATFORM_FIELD_DEFINITION_ID = PLATFORM_FIELD_DEFINITION.ID
PLATFORM_USER_ID = PLATFORM_USER.ID
310
4
PLATFORM_SERVICE_CONFIG
PLATFORM_SERVICE_CONFIG
This table contains the configuration information for the service platform.
The table is normally populated by the service platform reading a configuration
file from a drop directory. For more on user management configuration, see the
System Administration Guide
Table columns
Column name
Data type
Description
CONFIG_KEY
VarChar2(256)
The key identifying the service for which this configuration record
applies.
LAST_MODIFIED
Timestamp(6)
Timestamp for when this key was last modified.
OOB_CONTENT
Number(1)
Flag indicating whether the key has been modified from the initial
out-of-the-box settings.
1 - Key has not been modified
0 - Key has been modified
If the column is set to 1, the service platform knows that it can
safely overwrite the value with the default setting during an
upgrade.
SETTING
Blob
The configuration settings in XML format for the key.
Primary key
KEY
Foreign key
None.
PLATFORM_SLAVE_APPLICATION
This table defines each slave application that is to use the service platform.
Table columns
Column name
Data type
Description
ID
Number(19)
ACTIVE
Number(1)
A flag indicating whether this application is active:
0 - Passive
1 - Active
311
4
PLATFORM_TO_DELETE
Column name
Data type
Description
APP_KEY
VarChar2(256)
The key identifying the application configuration area for which
the settings in the SETTINGS field apply.
SETTINGS
Blob
The configuration settings in XML format for the key.
Primary key
ID
Foreign key
None.
PLATFORM_TO_DELETE
This table contains an entry for each user, contact, or payee that has been
deleted from the ICM database but the corresponding user object entries have
not yet been deleted from the user management database.
This table is part of the ICM database schema and is described on page 239.
PLATFORM_USER
This table contains a record for each user object known to the service platform.
The table defines a standard set of attributes for the user objects. Additional
attributes can also be associated with users and this additional information is
held in the PLATFORM_FIELD_VALUE table.
Table columns
Column name
Data type
Description
ID
Number(19)
EMAILADDRESS
VarChar2(255)
The email address for the user.
ENTITY_ID
VarChar2(256)
The unique identifier for the user that is used by the service platform and each slave application to refer to the user.
FAILED_LOGIN_ATTEMPTS
Number(19)
The number of failed attempts to log in since the last successful
log in.
FIRST_NAME
VarChar2(256)
The first name of the user.
FORCE_CHANGE
Number(1)
Flag indicating whether the user must change the password the
next time the user logs in.
LAST_MODIFIED
Timestamp(6)
The data and time that the user was last modified.
LAST_NAME
VarChar2(256)
The last name of the user.
LOCALE
VarChar2(10)
The locale for the user. For example, en_US.
312
4
PLATFORM_USER_PASSWORD_HIST
Column name
Data type
Description
LOCKED
Number(1)
A number indicating whether this user is enabled or disabled. A
disabled user is sometimes termed a locked user.
MIDDLE_NAME
VarChar2(256)
The middle name of the user.
PASSWORD
VarChar2(256)
The user password. The password is stored as an encrypted
value.
PASSWORD_ENC
Number(19,0)
Flag indicating the type of encryption used for the password in
the PASSWORD field.
0 - DES encryption
1 - No encryption
2 - SHA2 encryption
PASSWORD_SET_DATE
Timestamp(6)
The date and time the password was last set.
SYNC_DATE
Timestamp(6)
The data and time that the user was last synchronized with the
user information stored at the slave applications.
USER_NAME
VarChar2(256)
The user name used for logging in. to the system.
Primary key
ID
Foreign key
None.
PLATFORM_USER_PASSWORD_HIST
This table a history of the password changes for each user.
Table columns
Column name
Data type
Description
ID
Number(19)
CHANGE_DATE
Timestamp(6)
The date and time that the password was changed.
PASSWORD
VarChar2(256)
The new password value. The password is stored as an encrypted
value.
PLATFORM_USER_ID
Number(19)
The ID of the user object.
Primary key
ID
Foreign key
PLATFORM_USER_ID = PLATFORM_USER.ID
313
4
PLATFORM_USER_SLAVE_APPS
PLATFORM_USER_SLAVE_APPS
This table defines which slave applications are used by each user. A user has a
record in this table for each slave application they are associated with and so
there can be more than one record for each user.
Table columns
Column name
Data type
Description
USER_ID
Number(19)
The ID of the user object.
SLAVE_APP_ID
Number(19)
The ID of the slave application.
Primary key
None.
Foreign key
USER_ID = PLATFORM_USER.ID
SLAVE_APP_ID = PLATFORM_SLAVE_APPLICATION.ID
314
Index
BULLETIN_ACKNOWLEDGED 109
BULLETIN_SETTINGS 109
BULLETINS 110
A
ACCESS_LOG 77
ACTIVITY_AUDIT 78
ACTUAL_PAYMENTS 79
ACTUAL_PLAN_PAYMENTS 80
ACTUAL_TRAN_PAYMENTS 81
API_PARAMETERS 82
ASSIGNED_TRANS 82
ASSIGNED_TRANS_CLOSED_DELTA 83
ASSIGNED_TRANS_CLOSED_ID 83
ASSIGNED_TRANS_CLOSED_LEG 84
ASSIGNED_TRANS_HISTORY 84
ASSIGNED_TRANS_MANAGED_DELTA 86
ASSIGNED_TRANS_MANAGED_ID 87
ASSIGNED_TRANS_MANAGED_LEG 87
assistance 59
AT_CLOSED_ACTUAL_PAID 88
AT_CLOSED_DELTA_ID 88
AT_MANAGED_ACTUAL_PAID 89
AT_MANAGED_DELTA_ID 89
AUDIT_TRAIL 89
auditing tables 51
AUTH_BUFFER 91
AUTH_BUFFER_DELETE 92
AUTH_BUFFER_NOTE_ATTACHMENTS 92
AUTH_BUFFER_NOTES 93
AUTH_REQUEST_USERS 94
AUTH_REQUESTS 95
AUTH_RULES 97
AUTH_RULES_DELETED 99
AUTH_WORKSHEET 99
AUTH_WORKSHEET_JOBS 100
AUTH_WORKSHEET_REMOVED 100
authorization tables 30
C
CALC_DEP_BATCHES 111
CALC_DEP_BATCHES_ITEMS 112
CALC_DEP_PLAN_LOOPS 113
CALC_JOB 114
calculating data 17
CALCULATION_BATCH 114
CALCULATION_BATCH_JOBS 115
CALCULATION_DEPENDENTS 115
CALCULATOR_CELLS 118
CALCULATOR_COLUMN_DETAILS 119, 119
CALCULATOR_FILTERS 119
CALCULATOR_REFERENCES 120
CALCULATOR_SETTINGS 121
CALCULATOR_TEST_VALUES 122
CALCULATORS 123
calculators tables 42, 43
calendar tables 33
CLAWBACK_BANDS 124
CLAWBACKS 125
CLEAN_AT_CALC_JOB_ID 126
COMPILED_QUERY 127
CONTACTS 127
CONTENT_ITEMS 129
CONVERSION_LIST_HEADER 129
CONVERSION_LIST_ITEMS 130
COPY_PLANS 131
CORP_TARGET_CASCADE_VALUES 132
CORP_TARGET_CASCADES 133
CORP_TARGET_PLANS 133
CORP_TARGET_VALUES 134
CORP_TARGETS 135
CUBE_ ... tables 135
CURRENCIES 136
CURRENT_ASSIGNED_TRANSn 136
CURRENT_LEDGER_PLAN_ARCHIVEn 138
CURRENT_LEDGER_PLANn 139
CURRENT_LEDGER_TRAN_ARCHIVEn 140
CURRENT_LEDGER_TRANn 141
CUSTOMERS 143
customization tables 53
B
BASE_DATA 100
BASE_SALARIES 101
BATCH_RECALCS 102
BigString portal data type 61
BOOKMARK_ENTRIES 102
BOOKMARKS 103
Boolean portal data type 61
BUFFER 104
BUFFER_AUTH 105
BUFFER_DELETE 105
BUFFER_NOTE_ATTACHMENTS 106
BULK_DATA_FAILURE_UPDATE_FLDS 107
BULK_DATA_FAILURE_UPDATES 108
D
data encryption 55
data flow 16–27
315
Index
FLAT_FILES 185
FORECAST_ACHIEVEMENT 186
FORECAST_TEMPLATES 186
FORECAST_VALUES 187
authorizing payments 24
calculating data 17
creating payment file 26
creating statement data 20
loading data 16, 26
releasing payments 22
data ports tables 31
data types
portal database 61
DATA_SOURCE_SETTINGS 144
DATA_SOURCES 144
Database file system partitions 56
Database settings 56–57
table spaces 57
DATABASE_ERRORS 148
Date portal data type 61
DBMS_STATS_OBJECTTAB 148
DELETE_EMPLOYEES 148
DELETE_PLANS 149
DELETED_EMPLOYEES 149
DRN_CUSTOM_LIST_VALUES 150
DRN_CUSTOM_LISTS 150
DRN_FIELD_ALIAS 151
DRN_LOOKUP_ALIAS 152
DRN_PIVOT_STATE 152
DRN_REPORT_ACCESS 153
DRN_REPORT_ALIAS 153
DRN_REPORT_EMAIL 154
DRN_REPORT_HISTORY 155
DRN_REPORT_PARAMETERS 156
DRN_REPORT_SETTINGS 157
DRN_REPORT_USER_INPUT 157
DRN_REPORTS 158
DRN_SOURCES 163
DRN_VALUE_ALIAS 164
I
IMPORT_FILES 188
IMPORT_MAPPING 189
INCENTIVES 190
Integer portal data type 61
Introduction 13–59
J
JBPM_ ... 62
JOB_MEASUREMENT 191
JOB_TYPES 192
JOBS 193
Jobs tables 49
L
LEDGER_EMP 195
LEDGER_EMP_ARCHIVE 196
LEDGER_EMP_CALC_JOB 197
LEDGER_PLAN 198
LEDGER_PLAN_ARCHIVE 199
LEDGER_PLAN_ARCHIVE_HISTORY 199, 199
LEDGER_PLAN_CALC_JOB 200
LEDGER_PLAN_HISTORY 201
LEDGER_TRAN 202
LEDGER_TRAN_ARCHIVE 202
LEDGER_TRAN_ARCHIVE_HISTORY 203
LEDGER_TRAN_CALC_JOB 204
LEDGER_TRAN_CLOSED 204
LEDGER_TRAN_HISTORY 205
LEDGER_TRAN_MANAGED 206
loading data 16
localization tables 52
LOCKS 206
LOG_FILES 206
logging tables 51
Long portal data type 61
E
ELEMENT_GROUPS 165
ELEMENT_ITEMS 165
EMP_CURRENCIES 166
EMPLOYEE_CALC 167
EMPLOYEE_DRAW 168
EMPLOYEE_DRAW_AMOUNTS 170
EMPLOYEE_HIST 170
EMPLOYEE_RESULTS 171
EMPLOYEE_RESULTS_CLOSED 173
EMPLOYEE_RESULTS_MANAGED 174
EMPLOYEE_YEAR 174
EMPLOYEES 175
encrypting data 55
events tables 36
EXCHANGE_RATES 180
M
M_CBEAN 62
M_EXECUTIONMESSAGE 64
M_EXECUTIONSTATUSSUMMARY 66
M_GROUPTYPE 67
M_ICM... 66
M_INQUIRY... 66
M_LOGINRECORD 67
M_LOGINTICKET 68
M_METABEANREFERENCE 69
M_MGROUP 70
M_MUSER 71
M_PERSON 72
M_TITLETYPE 73
M_USERGROUP 74
M_WORKFLOW... 75
MANAGEMENT_STATEMENTS 206
MANAGER_APPROVALS 207
MANUAL_PLAN_RESULTS 207
MI_ ... 207
F
FAVOURITE_REPORT 180
FILTER_CRITERIA 180
FILTER_VALUES 182
FIN_DAYS 183
FIN_PERIODS 183
FIN_YEARS 184
financial calendar tables 33
financial data for payees 34
316
Index
PLATFORM_FIELD_VALUE 310
PLATFORM_SERVICE_CONFIG 311
PLATFORM_SLAVE_APPLICATION 311
PLATFORM_TO_DELETE 239, 312
PLATFORM_USER 312
PLATFORM_USER_PASSWORD_HIST 313
PLATFORM_USER_SLAVE_APPS 314
PLN_GUESTS 239
Pointer portal data type 61
POSTING_PLAN 240
POSTING_PLAN_CLOSED 241
POSTING_PLAN_MANAGED 241
POSTING_TRAN 242
POSTING_TRAN_CLOSED 243
POSTING_TRAN_MANAGED 243
PRICE_LIST_ITEMS 244
PRICE_LIST_PREVIOUS_ITEMS 245
PRICE_LISTS 245
process manager tables 50
PROCESS_SEMAPHORES 246
PROCESS_SEMAPHORES_ACTIVITY 246
PRODUCT_SPIF 246
PRODUCT_SPIF_PRODUCTS 247
PRODUCTS 248
PROF_FLD_TIDY 248
PROFILE_DEFINITION 249
MIGRATION_LOG 208
MODEL.. tables 208
models tables 41
MOST_RECENTLY_USED 208
MRU 209
N
NON_WORKING_DAYS 209
NOT_AGAIN 210
NOTE_ATTACHMENTS 210
NOTES 211
O
OPTIMISER_ ... 211
Oracle database settings 56
OTE_WORKSHEET 211
P
P_NOTIFICATION_LOG 307
P_SCHEDULED_NOTIFICATION 308
P_SLAVE_APP_USER_TO_DELETE 308
PAL_COUNTER 212
PARAMETER_LANGUAGES 212
PAY_ADJUST 213
PAY_RECOVERY 214
payee financial data 34
payee selection filter tables 35
payment authorization 24
payment batches tables 46
payment file creation 26
payment release 22
PAYMENT_BATCH_AUTH 214
PAYMENT_BATCH_EMP_PREVIEW 215
PAYMENT_BATCH_EMPLOYEES 216
PAYMENT_BATCH_PLANS 216
PAYMENT_BATCH_PLANS_PREVIEW 217
PAYMENT_BATCH_TRANSACTIONS 218
PAYMENT_BATCHES 219
payments tables 45
PAYROLL 222
plan tables
plan contents 38
plan management 39
plan results 41
targets 40
PLAN_CALC_INPUTS 223
PLAN_COMPONENT 224
PLAN_ELEMENTS 224, 224
PLAN_GROUP_ORDER 224
PLAN_GROUPS 225
PLAN_ORDER 225
PLAN_RELATIONS 225
PLAN_RESULTS 226
PLAN_RESULTS_CLOSED 230
PLAN_RESULTS_MANAGED 230
PLAN_TABLE 231
PLAN_TRANSACTION_MATCH 231
PLAN_TRANSACTION_UPDATE 231
PLANS 232
PLANS_CLOSED 237
PLANS_MANAGED 238
PLATFORM_FIELD_DEFINITION 309
Q
QDE_ITEMS 249
QDE_PROFILES 250
QRY_ACTIVITIES 250
QRY_ATTACHMENTS 251
QRY_HEADER 252
QRY_UPLOADS 254
query tables (superseded feature) 35
R
RANK_PLANS 254
real-time statements 20
RECEIVE_EMAIL 255
reference data tables 32
REGIONS 255
REJECTIONS 256
released statements 21
RELEASED_STATEMENTS 257
RENAMABLE_RESULTFIELD_ALIAS 257
report execution tables 48
REPORT_HISTORY 257
reports tables 47
S
SALES_STRUCTURE 258
schema updates 55
SCHEMA_DOC 259
SCREEN_FIELDS 259
SEL_DESCRIPTIONS 260
SEL_FILTERS 261
SEND_EMAIL 262
SEND_EMAIL_ATTACHMENTS 263
SERVER_CONSOLE 263
SERVER_CONSOLE_LOG 265
SERVER_CONSOLE_PARAMS 266
317
Index
TRAN_BULK_UPDATE_PREVIEW_CFG 286
TRAN_BULK_UPDATE_SET_TO_FLDS 287
TRAN_BULK_UPDATES 287
TRAN_EXT 288
TRAN_EXT_MATCH 289
TRAN_RECALC 289
TRAN_SUM_ITEMS 289
TRAN_SUMS 290
TRANSACTIONS 291
TRANSACTIONS_CLOSED_LEG 293
TRANSACTIONS_MANAGED_LEG 294
TRANSACTIONS_PENDING 294
TRANSACTIONS_S_CLOSED 294
TRANSACTIONS_S_MANAGED 294
TRN_S_MANAGED_ID 294
SERVER_STATUS 267
Service portal data type 61
SKETCH_AUDIT 267
SKETCH_INSTANCES 268
SKETCH_STEPS 269
SKETCHES 269
SQL_HISTORY 270
SS_MAPPING_D 271
STANDARD_CONNECTOR_CONFIG 272
STAT_COMMENT_HEADER 273
STAT_COMMENT_VALUES 273
STAT_PLANS 273
STAT_SECT_FIELDS 273
STAT_ZOOM_FIELDS 273
statement batches tables 44
statement data, creating 20
STATEMENT_BATCH_AUTH 273
STATEMENT_BATCH_EMPLOYEES 274
STATEMENT_BATCHES 275
STATEMENT_GRAPH_ITEMS 277
STATEMENT_GRAPHS 277
STATEMENT_ITEMS 277
STATEMENT_PLAN_SPECIFIC 277
STATEMENT_TITLES 277
STATEMENT_TYPES 277
STATEMENTS 277
String portal data type 61
SYSTEM_PARAMETERS 277
U
UP_DRAW_AMOUNTS 294
UPD_EMPLOYEE_DRAW_AMOUNTS 294
UPDATE_EMPLOYEE_DRAW 295
UPDATE_PLAN_CALC_INPUTS 296
UPDATE_PLAN_ITEMS 297
UPDATE_PLANS 297
UPDATE_TARGETS 298
upgrading schema 55
user management tables
contacts 29
payees 27
users 28
USER_ACCESS 298
USER_OPTIONS 299
USER_SETTINGS 299
USER_SETTINGS_COL_ORDER 301
USER_WIDGETS 301
USER_WIDGETS_SETTINGS 303
USERS 303
T
TAB_STATE 279
table spaces 57
TABLES 279
TARGET_WORKSHEET 280
TARGETS 281
targets tables 40
TASK_MANAGER 281
TAX_BANDS 282
TAX_GROUPS 282
TAX_RATES 283
TEMP_EMP_LIST 284
TEMPLATE_OTC 284
TEMPLATE_TARGETS 285
Timestamp portal data type 61
TRAN_BULK_UPDATE_FILTER_FLDS 285
V
VAT_RATES_HEADER 306
VAT_RATES_ITEMS 306
W
WIZ_ ... tables 306
WIZARD_NAMES 306
318

Database Schema Guide

Transcription

Similar documents

ICM Newsletter - International Christian Ministries

FARREL-MCWHIRTER PARK - Cascade Orienteering Club

Application guide for APL (housing aid) from caf.

icm in detail - Messe München

entertainment reimbursement claim form

Trabeation (from latin trabs a beam) is not simply the technical fact of

Chase Online Bill Pay Guide

g12 century vintage

Horoscope Day Information - Astrological Lodge of London

STEP-1 >> GO TO https://www.onlinesbi.com