Table Name |
Table Comment |
 
|
ca_asset_source |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
asset_source_uuid |
byte varying(16) |
NOT NULL |
  |
 
|
logical_asset_uuid |
byte varying(16) |
NULL |
  |
 
|
source_location_uuid |
byte varying(16) |
NULL |
  |
 
|
subschema_id |
integer |
NOT NULL |
  |
 
|
creation_user |
varchar(64) |
NULL |
  |
 
|
creation_date |
integer |
NULL |
  |
 
|
last_update_user |
varchar(64) |
NULL |
  |
 
|
last_update_date |
integer |
NULL |
  |
 
|
version_number |
integer |
NULL |
  |
ca_company |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
company_uuid |
byte varying(16) |
NOT NULL |
  |
 
|
parent_company_uuid |
byte varying(16) |
NULL |
  |
 
|
company_name |
varchar(100) |
NULL |
  |
 
|
inactive |
integer |
NULL |
  |
 
|
description |
varchar(400) |
NULL |
  |
 
|
company_type |
integer |
NULL |
  |
 
|
alias |
varchar(30) |
NULL |
  |
 
|
month_fiscal_year_ends |
integer |
NULL |
  |
 
|
web_address |
varchar(50) |
NULL |
  |
 
|
bbs |
varchar(30) |
NULL |
  |
 
|
creation_user |
varchar(64) |
NULL |
  |
 
|
creation_date |
integer |
NULL |
  |
 
|
last_update_user |
varchar(64) |
NULL |
  |
 
|
location_uuid |
byte varying(16) |
NULL |
  |
 
|
primary_contact_uuid |
byte varying(16) |
NULL |
  |
 
|
version_number |
integer |
NULL |
  |
 
|
last_update_date |
integer |
NULL |
  |
ca_contact |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
contact_uuid |
binary |
NOT NULL |
  |
 
|
middle_name |
nvarchar(200) |
NULL |
  |
 
|
alias |
nvarchar(60) |
NULL |
  |
 
|
last_name |
nvarchar(200) |
NOT NULL |
  |
 
|
first_name |
nvarchar(200) |
NULL |
  |
 
|
pri_phone_number |
nvarchar(80) |
NOT NULL |
  |
 
|
alt_phone_number |
nvarchar(80) |
NULL |
  |
 
|
fax_number |
nvarchar(80) |
NULL |
  |
 
|
mobile_phone_number |
nvarchar(80) |
NULL |
  |
 
|
pager_number |
nvarchar(80) |
NULL |
  |
 
|
email_address |
nvarchar(240) |
NULL |
  |
 
|
location_uuid |
binary |
NULL |
  |
 
|
floor_location |
nvarchar(60) |
NULL |
  |
 
|
pager_email_address |
nvarchar(240) |
NULL |
  |
 
|
room_location |
nvarchar(60) |
NULL |
  |
 
|
contact_type |
int |
NULL |
  |
 
|
inactive |
int |
NOT NULL |
  |
 
|
creation_user |
nvarchar(128) |
NULL |
  |
 
|
creation_date |
int |
NULL |
  |
 
|
last_update_user |
nvarchar(128) |
NULL |
  |
 
|
last_update_date |
int |
NULL |
  |
 
|
version_number |
int |
NULL |
  |
 
|
department |
int |
NULL |
  |
 
|
comments |
nvarchar(510) |
NULL |
  |
 
|
company_uuid |
binary |
NULL |
  |
 
|
organization_uuid |
binary |
NULL |
  |
 
|
admin_organization_uuid |
binary |
NULL |
  |
 
|
alternate_identifier |
nvarchar(60) |
NULL |
  |
 
|
job_title |
int |
NULL |
  |
 
|
job_function |
int |
NULL |
  |
 
|
mail_stop |
nvarchar(60) |
NULL |
  |
 
|
cost_center |
int |
NULL |
  |
 
|
userid |
nvarchar(60) |
NULL |
  |
 
|
supervisor_contact_uuid |
binary |
NULL |
  |
 
|
exclude_registration |
int |
NULL |
  |
 
|
delete_time |
int |
NULL |
  |
 
|
inrdid |
int |
NULL |
  |
 
|
tenant |
binary |
NULL |
  |
ca_currency_type |
Holds the different currency information, Eg: United States Dollor, Euro etc |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
currency_type_code |
varchar(3) |
NOT NULL |
Type code is the code for a particular currency, Eg- USD, EURO etc
|
 
|
name |
varchar(64) |
NOT NULL |
Descriptive name of the currency Eg- United States Dollor |
 
|
symbol |
varchar(4) |
NOT NULL |
The actual symbol of currency, Eg- $ |
 
|
in_use |
int |
NULL |
  |
 
|
country |
nvarchar(512) |
NOT NULL |
  |
 
|
description |
varchar(128) |
NOT NULL |
A detailed description of this currency, Eg- US dollor is universal currency and is taken as a base for all other currency conversions |
ca_locale |
Holds the different locales, locales are used for localization Eg: us_en, cn_zh |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
locale_code |
varchar(4) |
NOT NULL |
locale code is the code for particular locale, Eg- us_en for united states english, cn_zh for simplified chinese |
 
|
name |
varchar(64) |
NOT NULL |
Descriptive name of the locale like, United States English etc |
 
|
language_code |
nvarchar(2) |
NULL |
  |
 
|
country_code |
nvarchar(2) |
NOT NULL |
  |
 
|
language_name |
nvarchar(32) |
NULL |
  |
 
|
country_name |
nvarchar(32) |
NOT NULL |
  |
 
|
description |
varchar(128) |
NOT NULL |
A detailed description of the locale and how it is used |
ca_location |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
location_uuid |
byte varying(16) |
NOT NULL |
  |
 
|
location_name |
varchar(100) |
NULL |
  |
 
|
inactive |
integer |
NULL |
  |
 
|
location_type |
integer |
NULL |
  |
 
|
pri_phone_cc |
integer |
NULL |
  |
 
|
pri_phone_number |
varchar(32) |
NULL |
  |
 
|
fax_cc |
integer |
NULL |
  |
 
|
fax_number |
varchar(32) |
NULL |
  |
 
|
address_1 |
varchar(50) |
NULL |
  |
 
|
address_2 |
varchar(50) |
NULL |
  |
 
|
mail_address_1 |
varchar(50) |
NULL |
  |
 
|
mail_address_2 |
varchar(50) |
NULL |
  |
 
|
mail_address_3 |
varchar(50) |
NULL |
  |
 
|
city |
varchar(50) |
NULL |
  |
 
|
state |
integer |
NULL |
  |
 
|
address_3 |
varchar(50) |
NULL |
  |
 
|
mail_address_6 |
varchar(50) |
NULL |
  |
 
|
mail_address_5 |
varchar(50) |
NULL |
  |
 
|
mail_address_4 |
varchar(50) |
NULL |
  |
 
|
address_6 |
varchar(50) |
NULL |
  |
 
|
address_5 |
varchar(50) |
NULL |
  |
 
|
address_4 |
varchar(50) |
NULL |
  |
 
|
primary_contact_uuid |
byte varying(16) |
NULL |
  |
 
|
zip |
varchar(20) |
NULL |
  |
 
|
country |
varchar(50) |
NULL |
  |
 
|
county |
varchar(50) |
NULL |
  |
 
|
geo_coord_type |
integer |
NULL |
  |
 
|
geo_coords |
varchar(40) |
NULL |
  |
 
|
company_uuid |
byte varying(16) |
NULL |
  |
 
|
contact_address_flag |
integer |
NULL |
  |
 
|
creation_user |
varchar(64) |
NULL |
  |
 
|
site_id |
integer |
NULL |
  |
 
|
creation_date |
integer |
NULL |
  |
 
|
COMMENT |
varchar(255) |
NULL |
  |
 
|
last_update_user |
varchar(64) |
NULL |
  |
 
|
last_update_date |
integer |
NULL |
  |
 
|
version_number |
integer |
NULL |
  |
ca_location_type |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
  |
 
|
inactive |
integer |
NULL |
  |
 
|
name |
varchar(100) |
NULL |
  |
 
|
creation_user |
varchar(64) |
NULL |
  |
 
|
creation_date |
integer |
NULL |
  |
 
|
last_update_user |
varchar(64) |
NULL |
  |
 
|
last_update_date |
integer |
NULL |
  |
 
|
version_number |
integer |
NULL |
  |
 
|
description |
varchar(255) |
NULL |
  |
ca_organization |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
organization_uuid |
byte varying(16) |
NOT NULL |
  |
 
|
parent_org_uuid |
byte varying(16) |
NULL |
  |
 
|
description |
varchar(255) |
NULL |
  |
 
|
org_name |
varchar(100) |
NOT NULL |
  |
 
|
abbreviation |
varchar(30) |
NULL |
  |
 
|
pri_phone_cc |
integer |
NULL |
  |
 
|
pri_phone_number |
varchar(32) |
NOT NULL |
  |
 
|
alt_phone_cc |
integer |
NULL |
  |
 
|
alt_phone_number |
varchar(32) |
NOT NULL |
  |
 
|
fax_cc |
integer |
NULL |
  |
 
|
fax_number |
varchar(32) |
NOT NULL |
  |
 
|
email_address |
varchar(120) |
NOT NULL |
  |
 
|
location_uuid |
byte varying(16) |
NOT NULL |
  |
 
|
pager_email_address |
varchar(120) |
NOT NULL |
  |
 
|
inactive |
integer |
NOT NULL |
  |
 
|
creation_user |
varchar(64) |
NULL |
  |
 
|
creation_date |
integer |
NULL |
  |
 
|
last_update_user |
varchar(64) |
NULL |
  |
 
|
last_update_date |
integer |
NULL |
  |
 
|
version_number |
integer |
NULL |
  |
 
|
company_uuid |
byte varying(16) |
NULL |
  |
 
|
COMMENT |
varchar(255) |
NULL |
  |
 
|
contact_uuid |
byte varying(16) |
NULL |
  |
 
|
cost_center |
varchar(50) |
NULL |
  |
ca_time_zone |
Holds the settings for different timezones, Eg: EST, PST |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
time_zone_code |
varchar(64) |
NOT NULL |
time zone code is the code for a particular time zone, Eg- EST, PST etc |
 
|
name |
varchar(64) |
NULL |
Descriptive name of the time zone, Eg- Eastern Standard Time( US & Canada) |
 
|
description |
varchar(128) |
NOT NULL |
A description of time zone |
 
|
dst_flag |
int |
NULL |
Flag to indicate if day light savings time is used or not |
 
|
dst_id |
varchar(128) |
NULL |
  |
usm_account |
The entity which defines the enterprise level account.
Account drives the USM Model and is a key entity in the system.
Account is entity which can be billed. Service Level Contracts can be defined
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
account_id |
varchar(50) |
NOT NULL |
Unique ID of the account |
 
|
status |
int |
NOT NULL |
account status - 0 open, 1 close |
 
|
name |
varchar(64) |
NOT NULL |
Readable account name |
 
|
label |
nvarchar(64) |
NOT NULL |
Readable account label |
 
|
opened_date |
datetime |
NOT NULL |
account open date, recorded date when opening the account |
 
|
closed_date |
datetime |
NULL |
account close date, recorded date when closing the account |
 
|
email |
varchar(128) |
NULL |
email contact for the account |
 
|
website |
varchar(128) |
NULL |
website of the account |
 
|
data1 |
nvarchar(32) |
NULL |
for integration |
 
|
data2 |
nvarchar(32) |
NULL |
for integration |
 
|
data3 |
nvarchar(32) |
NULL |
for integration |
 
|
data4 |
nvarchar(64) |
NULL |
for integration |
 
|
data5 |
nvarchar(64) |
NULL |
for integration |
 
|
data6 |
nvarchar(64) |
NULL |
for integration |
 
|
data7 |
nvarchar(128) |
NULL |
for integration |
 
|
tenant_id |
varchar(50) |
NOT NULL |
tenant ID, the handle to the tenant which is the holder of this account |
 
|
time_zone_code |
varchar(64) |
NULL |
time zone, for billing caluclations EG: EST, PST |
 
|
location_uuid |
tinyint(16) |
NULL |
location, handle to the location table |
 
|
single_user_mode |
integer |
NULL |
If it is true, then an account can have only one user associated with it. For request account, the account is created along with user and this account is set with the column single_user_mode as true |
 
|
contact_uuid |
tinyint(16) |
NULL |
Contact UUID |
usm_account_app_user |
This table is used by the configuration manager to map users for an application to an USM login account. It is populated upon startup, and scheduled to repopulate each hour.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
app_user_id |
varchar(50) |
NOT NULL |
The application user for this mapping |
 
|
account_id |
varchar(50) |
NOT NULL |
The ican account for this mapping |
 
|
app_login_id |
varchar(50) |
NULL |
application login name for the application |
 
|
schema_id |
int |
NULL |
index to the application type |
 
|
user_id |
varchar(50) |
NULL |
user login id associated with this application and applogin |
usm_account_domain |
Persists every usm_billing_account with the complete path from it's domain up to the service provider. In other words, this table will store the complete tenant hierarchy for any account that also has a billing profile (i.e.: usm_billing_account record) |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
account_no |
varchar(50) |
NOT NULL |
pointer back to the billing_account record. |
 
|
path |
varchar(346) |
NOT NULL |
string representing the full path of tenants leading from the accounts tenant id to the service provider’s tenant id. The format is SP/PST1/…/CST/…/Tenant |
 
|
domain_type |
varchar(4) |
NULL |
type of domain the account belongs to. Ex: SP, ST, TE, etc. |
usm_acl |
Defines the access control list which is used to control access to different entities like, the dynamic links, reports etc
This is being replaced by eiam security model and will be deprecated in R11
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
acl_id |
varchar(50) |
NOT NULL |
Unique id for the access control list |
 
|
create_permit |
int |
NULL |
Flag for create permissions, 1 is permit, 0 is not permit |
 
|
delete_permit |
int |
NULL |
Flag for delete permissions, 1 is permit, 0 is not permit |
 
|
domain |
varchar(50) |
NULL |
The domain/organization for this ACL |
 
|
modify_permit |
int |
NULL |
Flag for modify permissions, 1 is permit, 0 is not permit |
 
|
read_permit |
int |
NULL |
Flag for read permissions, 1 is permit, 0 is not permit |
 
|
execute_permit |
int |
NULL |
Flag for execute permissions, 1 is permit, 0 is not permit |
 
|
mod_permit |
int |
NULL |
Flag for permission for modifying permissions, 1 is permit, 0 is not permit |
 
|
list_permit |
int |
NULL |
Flag for list permissions, 1 is permit, 0 is not permit |
 
|
is_system |
bit |
NULL |
flag for whether access control group is system defined |
 
|
description |
varchar(128) |
NULL |
Description of the access control group |
 
|
roles |
varchar(512) |
NULL |
the access control group name |
usm_adjustment |
All adjustments are recorded here and then applied to the accounts when they are invoiced in a bill run.
When adjustment_type=0 (general adjustment) and value_type=0 (fixed amount):
" enum_1 = billing cycle (0=onetime, 1=periodic, 2=every invoice)
" enum_2 = periodic type (0=NA,1=daily,2=weekly,3=monthly,4=quarterly,5=yearly)
When adjustment_type=0 (general adjustment) and value_type=1 (percentage):
" enum_1 = billing cycle (0=onetime, 2=every invoice)
" enum_2 = periodic type (0=NA)
" enum_3 = apply adjustment to (1=offering,2=rate column, 3=all charges, 4=total invoice amount)
" enum_4 = select offering ( when enum_3=1 or 2, then this is the offering_id )
" enum_5 = select rate column ( when enum_3=2, then this is the item_id of the column header rate item)
" enum_6 = percent of ( when enum_3=2, then 0=Quantity, 1=UnitCost, 2=Cost)
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
adjustment_id |
integer |
NOT NULL |
unique identifier that identifies each adjusment. |
 
|
adjustment_name |
nvarchar(50) |
NULL |
the name of the adjustment that appears in the adjustment gui, and on the invoice. |
 
|
domain |
varchar(50) |
NOT NULL |
This is the tenant ID of the account |
 
|
parent_domain |
varchar(50) |
NOT NULL |
This is the parent tenant ID, the value of this field is always either a Supert Tenant, Service Provider, or empty in the case when domain is the value of the Service Provider. |
 
|
charge_type |
integer |
NULL |
0=apply as credit, 1=apply as debit |
 
|
adjustment_type |
integer |
NULL |
0=general adjustment, 1=violation adjustment |
 
|
value |
float |
NULL |
the amount of the adjustment (this is either a fixed amount or a percentage). |
 
|
value_type |
integer |
NULL |
0=fixed amount, 1=percentage, 2=association (for violation adjustment that will do a tiered lookup into a rate plan to determine the adjustment), 3=SLO association, 4=SLO value association, 5=catalog percentage. For most purposes, any integrated components will almost always use fixed amount or percentage. |
 
|
description |
nvarchar(128) |
NULL |
appended to the adjusment_name and display on the invoice if there is a value for this field. |
 
|
status |
integer |
NULL |
0=not active 1=active |
 
|
active_date |
date |
NULL |
this is populated with the date of when the status field is set to 0 |
 
|
inactive_date |
date |
NULL |
this is populated with the date of when the status field is set to 1 |
 
|
global_adjustment |
integer |
NULL |
0=applied to a single account, 1=applied to all accounts |
 
|
account_no |
varchar(50) |
NULL |
if global_adjustment=0 then this is a pointer to the billing_account record. |
 
|
account_label |
nvarchar(128) |
NOT NULL |
if global_adjustment=0 then this is the displayable label of the billing_account. |
 
|
start_date |
date |
NULL |
currently not used. |
 
|
end_date |
date |
NULL |
currently not used. |
 
|
enum_1 |
integer |
NULL |
See Table Comment |
 
|
enum_2 |
integer |
NULL |
See Table Comment |
 
|
enum_3 |
integer |
NULL |
See Table Comment |
 
|
enum_4 |
integer |
NULL |
See Table Comment |
 
|
enum_5 |
integer |
NULL |
See Table Comment |
 
|
enum_6 |
integer |
NULL |
See Table Comment |
 
|
text_1 |
nvarchar(50) |
NULL |
reference to SLA when adjustment is for SLA |
 
|
text_2 |
nvarchar(50) |
NULL |
·text_2: too detailed to describe here. |
 
|
text_3 |
nvarchar(50) |
NULL |
·text_3: too detailed to describe here. |
usm_analysis |
This table represents the analysis repository.
It contains a summary of the analysis created as xml.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analysis_id |
integer |
NOT NULL |
Unique identity for the analysis |
 
|
report_group_id |
int |
NULL |
Unique identity for the report group |
 
|
category |
nvarchar(255) |
NULL |
The category of the analysis |
 
|
access_group |
nvarchar(255) |
NULL |
The access group to which the analysis belongs |
 
|
commandLineArgs |
varchar(255) |
NULL |
Identifies the command line arguments needed to rerun the command in addition to the class and metric scopes.
Syntax: A:B:C
A - command line args
B - class scope
C - metric scope
class and metric scope is not used anymore.
|
 
|
analyze_period |
varchar(50) |
NULL |
Identifies the period for the report.
For example, Monday, Tuesday, ...
|
 
|
analyze_title |
nvarchar(255) |
NULL |
The title of the analysis |
 
|
analyze_job_id |
integer |
NULL |
Unique identity for the analyze job |
 
|
url |
varchar(20) |
NULL |
The file name for the file containing the report for this analysis. ".html" is stripped from the filename. |
 
|
created |
integer |
NULL |
Epoch time of creation |
 
|
modified |
integer |
NULL |
Epoch time of modification |
 
|
analyze_status |
integer |
NULL |
Overall status of the analysis:
Which statuses are supported is TBD.
|
 
|
release_status |
integer |
NULL |
Indicates whether the analysis in a release cycle is released or not. |
 
|
period_start |
integer |
NULL |
The start time of the analysis in epoch |
 
|
period_stop |
integer |
NULL |
Then end_time of the analysis in epoch |
 
|
period_type |
varchar(20) |
NULL |
Defines the interval of the analyzis relative to the time of the analyze job.
For example today.
|
 
|
analysis_layout_set_id |
int |
NULL |
  |
usm_analysis_layout_set |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analysis_layout_set_id |
int |
NOT NULL |
  |
 
|
report_layout_id |
varchar(50) |
NOT NULL |
Specifies the Unique identifier for the report layout. It is created when the layout is saved |
 
|
is_default |
varchar(1) |
NOT NULL |
  |
usm_analyze_export_option |
Attributes used for export to Portal. Previosly this was also used for ftp export, but this will functionality will not be supported in r11. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analyze_export_option_id |
integer |
NOT NULL |
Unique identity for this option |
 
|
name |
varchar(50) |
NOT NULL |
The name of the attribute |
 
|
value |
nvarchar(255) |
NOT NULL |
Value of the attribute |
 
|
analyze_job_id |
integer |
NOT NULL |
Unique identity for the analyze job |
usm_analyze_function |
Describes the available SLM analyzer functions.
Supported functions are--
- real
- downtime
- availability
- stateHistory
- sum
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analyze_function_id |
integer |
NOT NULL |
Unique identifyer for the analyze function |
 
|
name |
varchar(50) |
NULL |
The name of the function |
usm_analyze_job |
Represents an analyze job, that may be scheduled to be executed at regular interval specified in usm_analyze_schedule.
Each job is associated with a scope and a set of report groups. The scope analyze function will be executed on the metric instances within the associated report groups that matches the scopes metrics and also the analyze function metrics.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analyze_job_id |
integer |
NOT NULL |
Unique identity for the analyze job |
 
|
title |
nvarchar(255) |
NULL |
The title for the job and the created analyses/reports. |
 
|
scope_id |
integer |
NULL |
Unique identity for the scope |
 
|
recent_analysis_status |
integer |
NULL |
The status of the most recent analysis available for this analyze job.
The most recent is not necessarilty the last run analysis
|
 
|
created |
int |
NULL |
  |
 
|
updated |
int |
NULL |
  |
 
|
analysis_layout_set_id |
int |
NULL |
  |
usm_analyze_job_option |
Optional attributes for an analyze job. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analyze_job_option_id |
integer |
NOT NULL |
Unique identity for this option |
 
|
name |
varchar(50) |
NOT NULL |
The name of the attribute |
 
|
value |
nvarchar(255) |
NOT NULL |
The value of the optional attribute |
 
|
analyze_job_id |
integer |
NOT NULL |
Unique identifier for the analyze job |
usm_analyze_schedule |
Specifies the job schedule using crontab expressions. The associated analyze job will be run according to the crontab expression. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analyze_job_id |
integer |
NOT NULL |
Unique identity for the analyze job |
 
|
time |
varchar(20) |
NULL |
Crontab expression for when the analyze job should be run |
 
|
period |
varchar(10) |
NULL |
Textual representation of the schedule period.
- hourly
- daily
- weekly
- monthy
- quarterly
- yearly
|
 
|
period_type |
varchar(6) |
NULL |
Defines the interval of the analyzis relative to the time of the analyze job.
h - This hour
H - Last hour
d - Today
D -Yesterday
w - This week
W - Last week
m - This month
M - Last month
q - This quarter
Q - Last quarter
y - This year
Y - Last year
last30 - Last 30 days
last90 - Last 90 days
|
usm_analyzed_event_data |
Contains analyzed event data received from SMA analyze jobs.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_instance_id |
int |
NOT NULL |
The unique identity of the event instance |
 
|
time_stamp |
integer |
NOT NULL |
The time_stamp in epoch for the data |
 
|
user_name |
varchar(64) |
NULL |
User name to which the data reflects |
 
|
value |
float |
NULL |
The measured value |
 
|
maximum |
float |
NULL |
The maximum value if reduction has been performed. Null orderwise |
 
|
minimum |
float |
NULL |
The minimum value if reduction has been performed. Null otherwise. |
 
|
reductionlevel |
bit |
NULL |
The reduction level. Null means no reduction |
 
|
interval |
integer |
NULL |
The sample interval
|
 
|
no_of_samples |
integer |
NULL |
The number of samples in the reduction. Null means no reduction |
 
|
insert_time |
integer |
NULL |
The inserted time in epoch |
usm_appuser |
Defines an application based user which is tied to user based on each application.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
appuser_id |
varchar(50) |
NOT NULL |
application user ID |
 
|
user_id |
nvarchar(100) |
NULL |
User ID of the user |
 
|
app_loginid |
varchar(50) |
NULL |
Place holder to store the login attribute for the external application |
 
|
schema_id |
int |
NULL |
handle to usm_schema table |
 
|
expire_time |
datetime |
NULL |
expiration time |
 
|
host_id |
varchar(50) |
NULL |
handle to usm_host |
 
|
label |
varchar(64) |
NULL |
Label for the application user |
 
|
param_input_user |
varchar(50) |
NULL |
For storing other user input data |
 
|
password |
varchar(128) |
NULL |
password for the external application in binary value |
 
|
runtime_application_id |
varchar(50) |
NULL |
handle to usm_runtime_application |
 
|
app_domain |
varchar(64) |
NULL |
Place holder to store the domain attribute for the external application |
 
|
use_password |
int |
NULL |
Flag indicating the ican user password should be used or not |
usm_asset |
Defines asset information by the user for the system, the asset can be file, folder etc |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
asset_id |
varchar(50) |
NOT NULL |
Asset ID |
 
|
asset_parent_id |
varchar(50) |
NULL |
Asset Parent ID |
 
|
is_folder |
int |
NULL |
Defines the asset type - true: folder asset, false: file asset |
 
|
path |
varchar(256) |
NULL |
file or folder path for the asset resource |
 
|
url |
varchar(256) |
NULL |
url for the asset resource, if it has one |
 
|
file_name |
varchar(64) |
NULL |
Defines the name for the asset |
 
|
description |
varchar(128) |
NULL |
Description of the asset |
 
|
created_date |
datetime |
NULL |
asset create date |
 
|
modified_date |
datetime |
NULL |
asset modified date |
 
|
is_system |
int |
NULL |
Defines wheither the asset is a system created one |
 
|
icon_used |
varchar(256) |
NULL |
Defines the icon information for the user defined. |
 
|
keywords |
varchar(64) |
NULL |
Keywords for the asset |
 
|
mime_type |
varchar(32) |
NULL |
information the type for the file asset |
 
|
file_size |
int |
NULL |
size of the file asset |
 
|
tenant_id |
varchar(50) |
NULL |
Tenant ID who created asset |
 
|
parent_tenant_id |
varchar(50) |
NULL |
Parent tenant ID of the tenant who created the asset |
 
|
user_id |
varchar(50) |
NULL |
User ID who created the asset |
 
|
locked |
int |
NULL |
Defines the lock status, whether the other user can claim the asset or not.
|
 
|
lockout_time |
datetime |
NULL |
Defines the lockout_time if the asset has been locked. |
 
|
owner |
varchar(50) |
NULL |
asset owner |
 
|
object_type |
integer |
NULL |
Indicates type of asset(usm document). Type=100 indicates a request attachment. |
 
|
object_id |
integer |
NULL |
If object type is 100(request), Object ID stores Request ID for request folder/attachments, -1 for root request folder. Object ID is null otherwise. |
 
|
lock_token |
varchar(256) |
NOT NULL |
Used to store WebDAV lock token when document is being edited |
usm_attr_reference_plugin |
Identifies the metric attribute plugins available.
A plugin is used to retrieve attributes from an external source. This may for example be other SQL tables, SNMP data or some other datasource.
Attributes to be retrieved by the plugin is identified by a reference_key.
For example, a plugin may exist that retrieves hostname from the usm_host table. The reference key in that case will typically be the host_id. If the hostname changes, it is not necessary to update the metric instances and metric definitions as long as the host_id is identical.
The plugin architecture may not be utilized in r11.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
attr_reference_plugin_id |
integer |
NOT NULL |
Unique identifier identifying the plugin |
 
|
name |
varchar(50) |
NULL |
Descriptive name of the plugin |
 
|
type |
varchar(20) |
NULL |
Identifies the type of plugin.
- Java
|
 
|
plugin |
varchar(255) |
NULL |
The java class implementing the plugin. Could possibly also be C++ libraries. |
usm_attr_reference_plugin_attr |
Attributes for a metric attribute reference plugin.
Attributes may for example be the table name where the data is retrieved from, the community string for SNMP lookups etc.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
attr_reference_plugin_attr_id |
integer |
NOT NULL |
Identifier for the metic_reference_plugin_attribute |
 
|
name |
varchar(100) |
NULL |
Name of the attribute |
 
|
value |
varchar(255) |
NULL |
The value |
 
|
attr_reference_plugin_id |
integer |
NULL |
Unique identifier identifying the plugin |
usm_billing_account |
All the information viewed through the billling profile in the UI is stored in this table. Except for the configuration table, all the other tables have some form of dependency on this table. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
account_no |
varchar(50) |
NOT NULL |
The account number associated to the billing_account. |
 
|
account_label |
nvarchar(128) |
NOT NULL |
This is the displayable name of the account |
 
|
parent_domain |
varchar(50) |
NOT NULL |
This is the parent tenant ID, the value of this field is always either a Supert Tenant, Service Provider, or empty in the case when domain is the value of the Service Provider. |
 
|
account_type |
integer |
NOT NULL |
0=Open Item, 1=Balance Forward |
 
|
billing_type |
integer |
NULL |
0=Billable, 1=Chargeback, 2= Resource |
 
|
credit_amount |
float |
NULL |
The account balance is derived from subtracting debit_amount from credit_amount |
 
|
debit_amount |
float |
NULL |
The account balance is derived from subtracting debit_amount from credit_amount |
 
|
opened_date |
date |
NOT NULL |
The date the billing_account record is created |
 
|
closed_date |
date |
NULL |
This really means the date the status of account changed |
 
|
billing_cycle |
nvarchar(50) |
NOT NULL |
Daily, Weekly, or Monthly |
 
|
billing_cycle_date |
date |
NOT NULL |
This now represents the billing period TO date. |
 
|
billing_cycle_interval |
integer |
NOT NULL |
An integer specifying the intervals of the billing cycle. For instance a billing_cycle=Monthly and billing_cycle_interval=1 would be a Monthly billing cycle, a billing_cycle=Monthly and billing_cycle_interval=3 would be a quaterly billing cycle, etc. A Daily billing cycle can only have 1 for its billing_cycle_interval |
 
|
last_invoice_date |
date |
NULL |
This now represents the billing period FROM date. |
 
|
invoice_sent_date |
date |
NULL |
This now represents the date of when the last time an invoice was generated for this account. |
 
|
bill_date |
date |
NULL |
The date that an invoice should be generated for this account for the billing period specified in billing_cycle_date and last_invoice_date. |
 
|
invoice_method |
nvarchar(50) |
NOT NULL |
Email, Fax, Postal, or Printer |
 
|
payment_method |
nvarchar(50) |
NULL |
PrePay is the only value we currently support |
 
|
status |
integer |
NOT NULL |
1=deleted, 0=closed, 1=open, 2=suspended, 3=closed requested. A status of deleted is a soft deleted, it simply means the account and all it |
 
|
status_reason |
nvarchar(128) |
NULL |
Generic item to state the reason for current state. |
 
|
days_due_default |
int |
NOT NULL |
The number of days that will be added to the invoice date of the account |
 
|
grace_days |
integer |
NOT NULL |
Currently not used. |
 
|
notification_days |
integer |
NOT NULL |
Currently not used. |
 
|
notification_method |
nvarchar(50) |
NOT NULL |
Currently not used. |
 
|
notify_stmt_sent |
integer |
NOT NULL |
Currently not used. |
 
|
notify_stmt_method |
nvarchar(50) |
NOT NULL |
Currently not used. |
 
|
notify_stmt_to |
integer |
NOT NULL |
Currently not used. |
 
|
notify_stmt_id |
nvarchar(50) |
NOT NULL |
Currently not used. |
 
|
automatic_invoicing |
integer |
NOT NULL |
a 1 indicates this account should be automatically invoiced by being picked up in the next bill run if all other billing criterias for the bill run are satisfied. Changing this field to 0 is the quickest and easiest way to exclude this account from all bill runs. |
 
|
summarize_statements |
integer |
NOT NULL |
Currently not used |
 
|
taxable |
integer |
NOT NULL |
Currently not used |
 
|
purchase_order_no |
nvarchar(30) |
NULL |
Generic item that can be used in integration. |
 
|
payment_applied_method |
integer |
NOT NULL |
Currently not used |
 
|
revenue_sharing_account |
integer |
NULL |
Currently not used. Not likely to ever really be used. |
 
|
aggregate |
integer |
NULL |
0=does not contribute it |
 
|
aggregation_type |
integer |
NULL |
if the aggregate value = 2, then this field would specify the type of aggregation that should occur. 0=Total accounts, 1=Total charges. |
 
|
text_1 |
nvarchar(100) |
NULL |
This column is not used |
 
|
text_2 |
nvarchar(50) |
NULL |
This column is not used |
 
|
enum_1 |
integer |
NULL |
This column is not used |
 
|
last_transaction_id |
integer |
NOT NULL |
id of last transaction. |
 
|
last_payment_id |
integer |
NOT NULL |
id of last payment. |
 
|
last_statement_id |
integer |
NOT NULL |
id of last statement generated. |
 
|
comments |
nvarchar(128) |
NULL |
used only in the billing profile gui |
 
|
sub_billing_info |
nvarchar(128) |
NULL |
Currently not used. Not likely to ever really be used. |
 
|
sub_billing_info_id |
integer |
NULL |
Currently not used. Not likely to ever really be used |
 
|
domain |
varchar(50) |
NULL |
Domain to which this account belongs. |
 
|
currency_type_code |
varchar(3) |
NULL |
The associated currency type. |
usm_billing_group |
Defines a billing group, billing group is a grouping of billing_accounts to achieve a billing related task, such as bill run, batch invoice printing etc |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
group_id |
int |
NOT NULL |
Unique id assigned to the group. |
 
|
domain |
varchar(50) |
NOT NULL |
The domain to which the group belongs. |
 
|
time_zone_code |
varchar(64) |
NOT NULL |
Timezone shared by all associated accounts. |
 
|
report_data_id |
varchar(50) |
NULL |
Unique identifier for the report data object. The unique identifier is assigned when the report data is saved. |
 
|
name |
nvarchar(64) |
NULL |
Display name for the group. |
 
|
type |
bit |
NULL |
0=account lists are statically generated.
1=account lists are dynamically generated.
|
 
|
automatic_invoicing |
bit |
NULL |
0=inactive
1=active
|
 
|
billing_cycle |
nvarchar(50) |
NOT NULL |
The billing cycle shared by all associated accounts. |
 
|
billing_cycle_interval |
int |
NULL |
The interval between cycles. |
 
|
last_invoice_date |
datetime |
NULL |
The period start date. |
 
|
billing_cycle_date |
datetime |
NULL |
The period end date. |
 
|
bill_date |
datetime |
NULL |
Bill run date. |
 
|
days_due_default |
int |
NULL |
Default days due for associated accounts. |
 
|
comment |
nvarchar(128) |
NOT NULL |
Text area for description. |
 
|
comments |
nvarchar(128) |
NULL |
Text area for description. |
usm_branding_template |
Defines a template for the Branding in UI. A branding template contains a list of branding variables which define the whole branding layout |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
branding_template_id |
varchar(50) |
NOT NULL |
branding template unique ID |
 
|
tenant_id |
varchar(50) |
NOT NULL |
Tenant ID, which is related to the branding template. |
 
|
is_default |
int |
NOT NULL |
whether the template is the default template for the tenant |
 
|
branding_template_parent_id |
varchar(50) |
NULL |
branding template unique ID |
 
|
is_shared |
int |
NULL |
Specifies if the branding template is shared a shared one or not private |
 
|
description |
varchar(128) |
NULL |
description for the template |
usm_branding_variable |
Defines a branding variable which is a part of branding template, a bunch of variable constitute a template |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
variable_id |
varchar(50) |
NOT NULL |
The unique id for the branding variable |
 
|
branding_template_id |
varchar(50) |
NOT NULL |
Handle to the branding template id |
 
|
tenant_id |
varchar(50) |
NOT NULL |
Tenant ID, which is related to the branding template. |
 
|
is_default |
int |
NOT NULL |
whether the template is the default template for the tenant |
 
|
type |
varchar(256) |
NOT NULL |
Type of variable, PASS1_PATH, PASS2_PATH, INLINE etc |
 
|
value |
nvarchar(256) |
NOT NULL |
Value for the branding variable |
usm_bus_queue |
Used to queue up metric requests which were unable to be sent over the sla bus. When a successful transmittion to SLA occurs, the sla bus queue will be flushed.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
time_stamp |
date |
NOT NULL |
time the real time event occurred. |
 
|
dest |
varchar(64) |
NULL |
destination of sla real time event. |
 
|
result_string |
varchar(1900) |
NULL |
encoded metric request class , with an embedded result in string format. |
 
|
metric_instance_id |
int |
NULL |
Unique identifier |
usm_cache |
Defines a caching mechanism which can be used to cache the data generated from the left and right hand pane nodes. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
cache_id |
varchar(50) |
NOT NULL |
Cache object unique ID |
 
|
use_cache |
int |
NULL |
flag for the cache is on or off |
 
|
args_critical |
int |
NULL |
Determines if the arguments are critical for caching |
 
|
refresh_time |
int |
NULL |
refresh duration time for the cache object |
 
|
timeout |
int |
NULL |
time duration for cache object |
 
|
hash_key |
varchar(64) |
NULL |
A system generated key for caching |
usm_cache_listener |
Defines cache listener objects that relates to cache object. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
cache_id |
varchar(50) |
NOT NULL |
cache object ID, handle to the usm_cache table |
 
|
cache_listener |
varchar(64) |
NOT NULL |
event listener names per the cache object |
usm_calendar |
Represents a calendar.
A calendar has multiple associated event categories that may contain events. Also, the calendar itself may contain events not related to any event categories.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
calendar_oid |
varchar(256) |
NOT NULL |
Unique identity of the calendar |
 
|
name |
nvarchar(50) |
NOT NULL |
Name of the calendar |
 
|
description |
nvarchar(255) |
NULL |
Description |
 
|
status |
c(1) |
NULL |
Status of the calendar. |
usm_calendar_category |
A link between a calendar and an event category. A event category may be associated with multiple calendars.
This is currently supported in the datamodel, but not in the business logic. So for r11, one event category will always belong to one calendar.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
calendar_category_oid |
varchar(20) |
NOT NULL |
Calendar category identity |
 
|
event_category_oid |
varchar(256) |
NULL |
The event category identity |
 
|
calendar_oid |
varchar(256) |
NULL |
The calendar identity |
usm_cat_application |
Defines an application type with version and other configuration. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
application_id |
int |
NOT NULL |
ID of the application metric package |
 
|
name |
varchar(64) |
NULL |
Name of the application metric package |
 
|
description |
varchar(128) |
NULL |
Description of the application metric package |
 
|
major_version |
varchar(20) |
NULL |
Major Version information |
 
|
minor_version |
varchar(20) |
NULL |
Minor Version information |
usm_cat_event_type |
The usm_event_type table represents all events supported by SLM r11. An event type identifies a type of measurement that can be performed by a collector.
The usm_event_type table represents the data in eventinfo.dat in Assure 2.2. In r11, the events may be represented both in eventinfo.dat and in this table.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_id |
int |
NOT NULL |
The unique identity of the event type.
event_id < 100 000 is statically defined
dynamically defined event_ids should start at 100 000
|
 
|
name |
nvarchar(256) |
NOT NULL |
The name of the event type |
 
|
label |
nvarchar(256) |
NOT NULL |
label of the event type |
usm_cat_link_app_metric |
Many - Many relationship between a schema and a metric category |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
application_id |
int |
NOT NULL |
ID of the application metric package |
 
|
metric_id |
integer |
NOT NULL |
Unique identity identifying the metric category |
usm_cat_link_event_metric |
link table linking an event type to a metric category |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_id |
integer |
NOT NULL |
Unique identity identifying the metric category |
 
|
event_id |
int |
NOT NULL |
The unique identity of the event type.
event_id < 100 000 is statically defined
dynamically defined event_ids should start at 100 000
|
usm_cat_metric |
A metric category specifies one type of metric data that can be measured and calculated for a set of associated metrics.
Examples of metric categories--
- Application Availability
- Platform availability
- Bandwidth percentage
One metric category may have an associated set of metrics. Which metric is used to measure the category is defined by the associated schema.
Typically, a metric category like Application Availability will have different metrics defined for different schemas. Each of these metrics will use a collector to collect data and may have different attribute specifications.
The Application Availabilty metric category has 4 types of metrics associated with separate schemas. Each of these metrics uses the same collector, but they have different attribute specifications in that the component attribute values for each metric is different. This is used during resource assignment so that the metric instance has all the associated components.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_id |
integer |
NOT NULL |
Unique identity identifying the metric category |
 
|
name |
varchar(64) |
NULL |
Name of the metric category |
 
|
comments |
nvarchar(256) |
NULL |
  |
 
|
metric_type |
int |
NULL |
metric cateogryattribute to control the metric request creation user interface restrictions for the metric.
Supported values are:
0 - Do not display component selection and display target host selection
1 - Allow only one component selection and display target host selection
2 - Allow multiple component selection and display target host selection
3 - Force all components to be selected and display target host selection
4 - (reserved)
5 - Do not display component and target host selections
6 - Allow only one component selection and do not display target host selection
7 - Allow multiple component selection and do not display target host selection
8 - Force all components to be selected and do not display target host selection
9 - Uses SMA metric attribute model
10 - SMA import metrics
|
 
|
metric_version |
int |
NULL |
Versioning info |
 
|
user_dependent |
int |
NULL |
attribute that identifies whether or not this metric is user-based. Supported values are:
1 - user dependent metric
0 - non - user dependent metric
|
 
|
charge_type |
int |
NULL |
attribute used by Accounting to determine if the metric provides for chargeback.
1 indicates chargeback metric
0 indicates non-chargeback metric.
|
 
|
unittype_id |
int |
NULL |
Unique identity for this unit type |
usm_cat_unittype |
Defines the specific unit for a given metric category.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
unittype_id |
int |
NOT NULL |
Unique identity for this unit type |
 
|
name |
nvarchar(128) |
NULL |
The name of the unit type |
 
|
description |
varchar(128) |
NULL |
A description |
 
|
metric_result |
varchar(20) |
NULL |
  |
usm_collection_profile |
Defines a collection profile |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
collection_profile_id |
int |
NOT NULL |
The identity of the collection profile |
 
|
name |
varchar(50) |
NOT NULL |
The name of the profile |
usm_collection_profile_attrs |
Attributes for one metric in a collection profile |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
collection_profile_metric_id |
integer |
NOT NULL |
Unique identity of the collection profile metric |
 
|
metric_attr_spec_id |
integer |
NOT NULL |
Unique identifier for the metric attribute specification for the given attribute |
 
|
value |
nvarchar(100) |
NULL |
The value of the attribute |
usm_collection_profile_metric |
Represents the collection profile element for one given metric on one given agent host. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
collection_profile_metric_id |
integer |
NOT NULL |
Unique identity of the collection profile metric |
 
|
collection_profile_id |
int |
NULL |
The identity of the collection profile |
 
|
metric_id |
int |
NULL |
The identity of the metric |
 
|
agent_host_id |
integer |
NULL |
Unique identifier for one slm server, which in this case should be a DC Hub. |
 
|
description |
nvarchar(128) |
NOT NULL |
  |
usm_collector |
Defines a service metering data collector. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
collector_id |
int |
NOT NULL |
Unique identity of the collector type |
 
|
name |
varchar(64) |
NULL |
Name of the collector type |
 
|
type |
varchar(20) |
NULL |
Type classification. Identifies whether the collector is OS specific, whether is monitors the local system or can monitor remote systems. OS, local, remote |
 
|
parent_collector |
int |
NULL |
Unique identity of the collector type |
usm_comp_instance |
A comp instance represents a component instance running on an installed instance of a schema, i.e It is the instance of a schema component running on a host. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
comp_instance_id |
varchar(50) |
NOT NULL |
Unique identity of the component instance. |
 
|
dest_host_id |
int |
NULL |
The target host used by the component |
 
|
comment |
varchar(64) |
NULL |
A comment, if available on the component instance. |
 
|
name |
varchar(64) |
NULL |
The name, if available, of the component instance |
 
|
sm_component_id |
varchar(50) |
NULL |
Identifies the schema & component to which this component instance belongs. |
 
|
inst_host_id |
integer |
NULL |
The host where this component instance is installed. |
 
|
schema_instance_id |
varchar(50) |
NULL |
The schema instance to which this component belongs |
 
|
comments |
nvarchar(64) |
NULL |
  |
usm_configuration |
All the configurable value for Accounting and the catalog are set in this table.
Primary keys are: domain, group_name, name
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
group_name |
nvarchar(50) |
NOT NULL |
configuration is split into the following groups: billingprofile=the default values for any new billing profiles created, statementengine=values that control how billing runs behave, scheduler=will soon be removed and replaced by billing groups, system=configuations defined at the system level (ex: posting events) these are only visible to the SP, invoicemethods=supported invoicing send methods, paymentmethods=supporte payment types, billingcycles=supported billing cycles, general=general configuration (ex: default post payment method) that are visible to all SP and ST. |
 
|
name |
nvarchar(50) |
NOT NULL |
the name of the configuration parameter |
 
|
domain |
varchar(50) |
NOT NULL |
domain group which is related to the configuration |
 
|
data_type |
int |
NOT NULL |
0=integer, 1=float, 2=boolean, 3=string, 4=object, 5=time stamp, 6=date stamp, 7=date/time stamp |
 
|
is_visible |
integer |
NOT NULL |
1=show in configuration gui, 0=hide |
 
|
value |
nvarchar(2000) |
NULL |
the value of the configuration parameter |
 
|
component_id |
integer |
NULL |
what component uses this configuration. ex: iCanBill, catalog, etc. Used only for maintenance as of now. |
 
|
aclinfo |
varchar(128) |
NULL |
Access Control List like 111,114 etc |
 
|
product_code |
nvarchar(64) |
NOT NULL |
Product Code like USV, USF etc |
 
|
widget_type |
int |
NULL |
This column is not used |
 
|
value_list |
ntext |
NOT NULL |
This column is not used |
usm_contact_domain |
Defines which domain, user is belongs to on what level of authentication. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
domain |
varchar(50) |
NOT NULL |
The unique tenantid that identifies this organization/tenant |
 
|
user_id |
nvarchar(100) |
NOT NULL |
  |
 
|
authorization_level |
integer |
NULL |
  |
usm_contact_domain_role |
Defines which domain and which role, user is belongs to with default domain information. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
domain |
varchar(50) |
NOT NULL |
The unique tenantid that identifies this organization/tenant |
 
|
role_id |
varchar(50) |
NOT NULL |
The unique identifier for the role, Eg: spadministrator, enduser etc |
 
|
user_id |
nvarchar(100) |
NOT NULL |
  |
 
|
default_domain |
int |
NOT NULL |
  |
usm_contact_extension |
Defines extended contact information for user. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
user_id |
nvarchar(100) |
NOT NULL |
  |
 
|
locale_code |
varchar(4) |
NULL |
locale code is the code for particular locale, Eg- us_en for united states english, cn_zh for simplified chinese |
 
|
time_zone_code |
varchar(64) |
NULL |
time zone code is the code for a particular time zone, Eg- EST, PST etc |
 
|
data1 |
nvarchar(512) |
NOT NULL |
  |
 
|
data2 |
nvarchar(512) |
NOT NULL |
  |
 
|
data3 |
nvarchar(512) |
NOT NULL |
  |
 
|
data4 |
nvarchar(512) |
NOT NULL |
  |
 
|
data5 |
nvarchar(512) |
NOT NULL |
  |
 
|
data6 |
nvarchar(512) |
NOT NULL |
  |
 
|
data7 |
nvarchar(512) |
NOT NULL |
  |
usm_content_pack |
To Store the list of content packs imported in the system |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
varchar(64) |
NOT NULL |
unique id of the content pack |
 
|
tenant_id |
varchar(50) |
NOT NULL |
The unique tenantid that identifies this organization/tenant |
 
|
name |
nvarchar(256) |
NOT NULL |
name of the content pack folder |
 
|
version |
varchar(32) |
NOT NULL |
version number of the content pack |
 
|
prompt |
nvarchar(2000) |
NOT NULL |
prompt message to be displayed during import of the content pack |
 
|
description |
nvarchar(2000) |
NOT NULL |
description of the content pack |
 
|
author |
nvarchar(512) |
NOT NULL |
author of the content |
 
|
status |
int |
NOT NULL |
Enabled -1 (Default), Disabled -0 |
usm_content_pack_tracking |
To store the tracking ids of the objects imported in the content pack |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
content_pack_id |
varchar(64) |
NOT NULL |
unique id of the content pack |
 
|
tracking_id |
binary |
NOT NULL |
tracking id which maps to the uuid in the usm_import_export_mapping table |
 
|
tenant_id |
varchar(50) |
NOT NULL |
The unique tenantid that identifies this organization/tenant |
usm_contract |
Defines an SLA contract, One are more contracts are tied to an account, basically contract is the primary entity to do service level assurance |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
contract_id |
int |
NOT NULL |
Unique identity for the contract |
 
|
expiredate |
datetime |
NULL |
Expire date for the contract |
 
|
report_interval |
int |
NULL |
Reporting interval.
SLO's are checked for breaches for each reporting interval.
|
 
|
report_offset |
varchar(256) |
NULL |
  |
 
|
start_date |
datetime |
NULL |
Start date of contract |
 
|
status |
int |
NULL |
Active, Pending, Cancelled |
 
|
description |
varchar(128) |
NULL |
Description of contract |
 
|
account_id |
varchar(50) |
NULL |
Associated account id |
 
|
tenant_id |
varchar(50) |
NULL |
Associated tenant id |
 
|
contract_type |
varchar(20) |
NULL |
Used to indicate hidden contracts that represents report groups. NULL indicates normal contract
'SMA' indicates SMA created contracts
|
 
|
service_hours |
varchar(100) |
NULL |
Specification of service hours:
# separated list of HH:MM times where HH is hours and MM is minutes.
Starts with sunday and ends with saturday.
|
 
|
last_update |
datetime |
NULL |
  |
usm_contract_action |
Defines a action which is based on an SLA contract |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
contract_action_id |
int |
NOT NULL |
Unique identity |
 
|
contract_id |
int |
NULL |
Contract identity |
 
|
slo_instance_id |
int |
NULL |
Associated slo instance identity |
 
|
rule_id |
varchar(50) |
NULL |
non-displayable id used in the backend as a reference between tables. |
 
|
user_id |
nvarchar(100) |
NOT NULL |
  |
usm_cor_data |
The usm_cor_data table holds a long-lived cache of elements from the core. It is populated based on the capabilities defined in usm_cor_metric_capability. The data is organized as a folder tree that equals the structure in COR. The lowest level of the tree points out what metrics that can be used to measure that type of COR objects. The actual objects is not stored in the cache, but is pulled from COR when needed.
Fields--
cor_data_id - a sequential id for the data element.
slm_server_id - the id of the COR gateway server.
parent_path - a slash separated path of cor_data_id representing the tree
level - the level in the tree (0 is a root node).
label - the label for the data element.
icon - name of icon to display.
metric_id - the metric capable of measuring such objects. If NULL, it is a folder, and therefore has something below it. The metric name of the metric should be sent in the ObjectGet call to the COR
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
cor_data_id |
int |
NOT NULL |
cor_data_id - a sequential id for the data element.
|
 
|
metric_id |
int |
NULL |
The identity of the metric. the metric capable of measuring such objects. If NULL, it is a folder, and therefore has something below it. The metric name of the metric should be sent in the ObjectGet call to the COR |
 
|
server_id |
integer |
NULL |
the id of the COR gateway server. |
 
|
parent_path |
varchar(50) |
NOT NULL |
a slash separated path of cor_data_id representing the tree |
 
|
level |
int |
NULL |
level - the level in the tree (0 is a root node).
|
 
|
label |
nvarchar(255) |
NOT NULL |
).
label - the label for the data element.
|
 
|
icon |
nvarchar(256) |
NOT NULL |
icon - name of icon to display.
|
 
|
tree_level |
int |
NULL |
  |
usm_cor_dynamic |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
cor_dynamic_id |
int |
NOT NULL |
  |
 
|
server_id |
integer |
NOT NULL |
Unique identifier for one slm server |
 
|
metric_id |
int |
NOT NULL |
The identity of the metric |
 
|
class_name |
varchar(255) |
NOT NULL |
  |
 
|
bpv_uuid |
varchar(50) |
NOT NULL |
  |
usm_cor_dynamic_attr |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
cor_dynamic_attr_id |
int |
NOT NULL |
  |
 
|
cor_dynamic_id |
int |
NOT NULL |
  |
 
|
metric_attr_spec_id |
integer |
NOT NULL |
Unique identifier for the metric attribute specification for the given attribute |
 
|
value |
varchar(511) |
NOT NULL |
  |
usm_cor_dynamic_report_group |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
cor_dynamic_report_group_id |
int |
NOT NULL |
  |
 
|
cor_dynamic_id |
int |
NOT NULL |
  |
 
|
report_group_id |
int |
NOT NULL |
Unique identity for the report group |
 
|
use_calendar |
c(1) |
NOT NULL |
  |
usm_cor_metric_capability |
How a metric is capable to measure different kinds of objects in COR, needs to be represented in the data model. In 3.5 this was accomplished with the vendor and devicetype metric fields. It was limited to specifying a single capability even though keywords such as any and unknown was allowed. In r11 the COR metric capabilities will be put in a separate table--
usm_cor_metric_capability
metric_id (FK -> usm_metric.metric_id)
vendor
device_type
The set of COR object types that a metric can measure, can be found by listing all metric capabilities (vendor, device type pairs) for the metric id.
The information in usm_cor_metric_capability will be used when data is pulled from COR and temporary stored in the usm_cor_data table. It will be used for resolving capable metrics based on the vendor and device type attributes of the COR elements.
The vendor and device_type fields may contain keywords like any and unknown as previously.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_id |
int |
NULL |
The identity of the metric |
 
|
vendor |
varchar(128) |
NOT NULL |
The vendor from core |
 
|
device_type |
varchar(255) |
NOT NULL |
The device type from cor |
usm_cost_pool |
This table holds information related to cost pools. A pool consists of a collection cost elements related to a single activity.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
cp_id |
integer |
NOT NULL |
Unique id for a cost pool. |
 
|
domain |
varchar(50) |
NULL |
The domain to which the cost pool belongs. |
 
|
name |
nvarchar(64) |
NOT NULL |
Display name for the pool. |
 
|
type |
int |
NULL |
Type can be fixed or variable. |
 
|
description |
nvarchar(256) |
NOT NULL |
description for the cost pool |
usm_cp_inclusion |
This table ties cost elements (rate items) to specific cost pools. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
item_id |
integer |
NOT NULL |
the unique id for each rate item |
 
|
cp_id |
integer |
NOT NULL |
Unique id for a cost pool. |
usm_das_analyses |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analysis_oid |
int |
NOT NULL |
  |
 
|
analyzer_oid |
int |
NOT NULL |
  |
 
|
xml |
long varchar |
NOT NULL |
  |
usm_das_analysis_summaries |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analysis_summary_oid |
int |
NOT NULL |
  |
 
|
analyzer_oid |
int |
NOT NULL |
  |
 
|
name |
varchar(50) |
NOT NULL |
  |
 
|
value |
varchar(255) |
NOT NULL |
  |
usm_das_analyzer_attributes |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analyzer_attribute_oid |
int |
NOT NULL |
  |
 
|
analyzer_oid |
int |
NOT NULL |
  |
 
|
attribute_name |
varchar(50) |
NOT NULL |
  |
 
|
attribute_value |
varchar(255) |
NOT NULL |
  |
usm_das_analyzer_definitions |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analyzer_definition_oid |
int |
NOT NULL |
  |
 
|
description |
nvarchar(255) |
NOT NULL |
  |
 
|
xml |
long varchar |
NULL |
  |
usm_das_analyzer_types |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analyzer_type_oid |
int |
NOT NULL |
  |
 
|
analyzer_type_name |
varchar(100) |
NOT NULL |
UNIQUE constraints |
 
|
description |
nvarchar(255) |
NOT NULL |
  |
 
|
xml |
long varchar |
NULL |
  |
 
|
element_category |
varchar(10) |
NOT NULL |
  |
 
|
input_value_type_oid |
int |
NOT NULL |
  |
 
|
output_value_type_oid |
int |
NOT NULL |
  |
usm_das_analyzers |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analyzer_oid |
int |
NOT NULL |
  |
 
|
analyzer_type_oid |
int |
NOT NULL |
  |
 
|
start_time |
int |
NOT NULL |
  |
 
|
stop_time |
int |
NOT NULL |
  |
usm_dash |
Defines the dashboard information. For each defined dashboard, user can customise their board by adding portal contents.
Organization can have one or more dashboards which are shown to all the users in that organization.
Users also have their personal dashboards, where they store their personal preferences
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
dash_id |
varchar(64) |
NOT NULL |
Dashboard unique ID |
 
|
label |
varchar(64) |
NULL |
Dashboard descriptive label |
 
|
xsl_presentation |
varchar(64) |
NULL |
XSL file if the presentation is involved |
 
|
full_size |
int |
NULL |
Specifies if full size is used |
 
|
height |
int |
NULL |
dashboard window height |
 
|
width |
int |
NULL |
dashboard window width |
 
|
separate_window |
int |
NULL |
Determines if a different window is used to show the dash board contents |
 
|
snapable |
int |
NULL |
Determines if the dash board is snapable |
 
|
locked |
int |
NULL |
Determines if the dash board is locked |
 
|
auto_arrange |
int |
NULL |
auto arangement turn on and off |
 
|
timeout |
int |
NULL |
time out for retrieveing the dashboard content |
 
|
tenant_id |
varchar(50) |
NULL |
Tenant ID is related to the dashboard |
 
|
user_id |
nvarchar(100) |
NULL |
User ID is related to the dashboard |
 
|
access_depth |
int |
NULL |
Defines the weither the child structure will come or not |
 
|
is_default |
bit |
NULL |
specify whether the dashboard is default or not. |
 
|
role_id |
varchar(50) |
NULL |
The unique identifier for the role, Eg: spadministrator, enduser etc |
usm_data_collector |
Not used - To be deleted |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
host_id |
c(18) |
NULL |
The identity of the host. |
 
|
data_collector_name |
varchar(64) |
NULL |
  |
usm_db |
Defines each data source which is used to connect to different data sources.
All components access the database by reading this specific entry. This also has the access permission to the database being accessed.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
db_id |
varchar(50) |
NOT NULL |
Unique id for the db object |
 
|
name |
varchar(64) |
NULL |
Descriptive name of the db object |
 
|
status |
int |
NULL |
Status of the db : Active(1) and null is active.
|
 
|
db_class |
varchar(128) |
NULL |
The class for the db driver implementation, eg- sun.jdbc.odbc.JdbcOdbcDriver |
 
|
db_url |
varchar(256) |
NULL |
The url for the db implementation, example - jdbc:odbc:icandb-mahine1 |
 
|
login_id |
varchar(50) |
NULL |
The login id credentials to connect to the database |
 
|
password |
nvarchar(256) |
NULL |
The password credentials to connect to the database |
 
|
type |
varchar(20) |
NULL |
Specifies the type of the database, Eg: Oracle, Ingres |
 
|
version |
varchar(20) |
NULL |
Specifies the version of the database, Eg: 9i, 10g etc |
 
|
normalize_timestamps |
int |
NULL |
Specfies if the timestamps have to be normaized |
 
|
dst_id |
varchar(30) |
NULL |
Handle to day light savings record |
 
|
host_name |
varchar(64) |
NULL |
Hostname where the db server is installed |
 
|
db_name |
varchar(64) |
NULL |
Name of the database |
 
|
autocommit |
bit |
NULL |
autocommit on/off flag |
 
|
time_zone_code |
varchar(64) |
NULL |
time zone code is the code for a particular time zone, Eg- EST, PST etc |
usm_dca_app_status |
This table is used by the dcanalyzer when computing the availability status of an application. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_instance_id |
int |
NOT NULL |
Unique identifier |
 
|
status |
integer |
NULL |
status of the application. 0=down, 1=up
|
 
|
time_stamp |
int |
NULL |
time stamp for the status |
usm_dca_comp_status |
used by the dcanalyzer when computing the availability status of an application. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_instance_id |
int |
NOT NULL |
Unique identifier |
 
|
event_instance_id |
int |
NULL |
The unique identity of the event instance |
 
|
status |
int |
NULL |
status of the application. 0=down, 1=up
|
 
|
time_stamp |
int |
NULL |
  |
usm_default_service_hours |
The default service hours for all report groups. Report groups that are missing service hours for some time interval will use the default service hours defined here. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
day_name |
nvarchar(50) |
NOT NULL |
The valid day for the service hous
Values:
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
- sunday
|
 
|
start_time |
integer |
NULL |
Start time in seconds since 00:00 |
 
|
end_time |
integer |
NULL |
End time in seconds since 00:00 |
 
|
created |
integer |
NULL |
Epoch time of creation |
usm_dependency |
Persists the dependencies between offerings, and offerings to tenants. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
dependency_id |
integer |
NOT NULL |
the unique id for each rate item |
 
|
dependency_type |
integer |
NOT NULL |
0=tenant-offering, 1=offering-tenant, 2=subscribe offerings, 3=unsubscribe offerings, 4=enable offerings, 5=disable offerings |
 
|
account_no |
varchar(50) |
NULL |
The account number associated to the billing_account. |
 
|
is_global |
integer |
NOT NULL |
1 = apply to all accounts of that tenant, any other value is currently not supported. |
 
|
source_id |
integer |
NULL |
the id of the offering that will cause a dependent offering to be affected. For instance, subscribe to one offering may cause disabling another offering. |
 
|
source_string_id |
varchar(128) |
NULL |
the id of the tenant that will cause a dependent offering to be affected. For instance: tenant T can only subscribe to offering O |
 
|
target_id |
integer |
NULL |
the id of the offering that is dependent on another offering |
 
|
target_string_id |
varchar(128) |
NULL |
the id of the tenant that is dependent on an offering |
 
|
date_available |
date |
NULL |
currently not used. |
 
|
date_unavailable |
date |
NULL |
currently not used. |
 
|
status |
integer |
NULL |
0=deleted, 1=active |
 
|
enum_1 |
integer |
NULL |
currently not used. |
 
|
enum_2 |
integer |
NULL |
currently not used. |
 
|
enum_3 |
integer |
NULL |
currently not used. |
 
|
enum_4 |
integer |
NULL |
currently not used. |
 
|
text_1 |
varchar(128) |
NULL |
currently not used. |
 
|
text_2 |
varchar(128) |
NULL |
currently not used. |
usm_dm_event_data |
Contains event data received for a event instance.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_instance_id |
int |
NOT NULL |
The unique identity of the event instance |
 
|
time_stamp |
integer |
NOT NULL |
The time_stamp in epoch for the data |
 
|
user_name |
varchar(64) |
NULL |
User name to which the data reflects |
 
|
value |
float |
NULL |
The measured value |
 
|
maximum |
float |
NULL |
The maximum value if reduction has been performed. Null orderwise |
 
|
minimum |
float |
NULL |
The minimum value if reduction has been performed. Null otherwise. |
 
|
reductionlevel |
bit |
NULL |
The reduction level. Null means no reduction |
 
|
interval |
integer |
NULL |
The sample interval
|
 
|
no_of_samples |
integer |
NULL |
The number of samples in the reduction. Null means no reduction |
 
|
insert_time |
integer |
NULL |
The inserted time in epoch |
usm_doctmpl_layoutlist |
Defines the document template layout list for each document template |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
document_template_id |
varchar(50) |
NOT NULL |
Document template unique ID |
 
|
order |
int |
NOT NULL |
sequential number to specify the relationship order |
 
|
content_order |
integer |
NOT NULL |
Field name "order" has been changed to "content_order" |
 
|
report_layout_id |
varchar(64) |
NULL |
report layout ID that is related to the template |
usm_document_template |
Defines a template for a document in Document Management. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
document_template_id |
varchar(50) |
NOT NULL |
Unique ID for the document template |
 
|
total_pages |
int |
NULL |
n - indicates infinite value will be replaced by -1, has values
0-99
|
 
|
modify |
int |
NULL |
Flag to indicate one can modify or not |
 
|
time_stamp |
datetime |
NULL |
The created time for the document template |
 
|
comment |
varchar(64) |
NULL |
The desciptive comment |
 
|
comments |
nvarchar(64) |
NULL |
Field name "comment" has been changed to "comments" to support oracle
|
 
|
is_modify |
int |
NULL |
Flag to indicate one can modify or not |
usm_dst |
Defines the day light saving rules for different time zones which need it. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
dst_id |
varchar(30) |
NOT NULL |
The unique id for the day light savings time, Eg: US, Australia_Tonga, Austalia_South |
 
|
in_use |
int |
NULL |
If the daylight setting is used or not |
 
|
start_month |
int |
NULL |
Starting month for this daylight savings |
 
|
start_day |
int |
NULL |
Starting day for this daylight savings |
 
|
start_dayof_week |
int |
NULL |
Starting day of the week for daylight savings |
 
|
start_time |
int |
NULL |
Start time for day light savings |
 
|
end_month |
int |
NULL |
Ending month for this daylight savings |
 
|
end_day |
int |
NULL |
Ending day for this daylight savings |
 
|
end_dayof_week |
int |
NULL |
Ending day of the week for daylight savings |
 
|
end_time |
int |
NULL |
Ending time for the daylight savings |
 
|
start_time_mode |
int |
NULL |
Start time mode for day light savings |
 
|
end_time_mode |
int |
NULL |
End time mode for day light savings |
 
|
dst_savings |
int |
NULL |
Day light savings |
usm_event_category |
The event category is associated with a calendar and is a grouping of events, one-time or recurring.
An event category may have an associated set of legal values, event_category_values.
It may also have an exporter that is used to export events within this category to an external source.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_category_oid |
varchar(256) |
NOT NULL |
Unique identity of the event category |
 
|
name |
nvarchar(50) |
NOT NULL |
Name of the event category |
 
|
description |
nvarchar(255) |
NULL |
Description of the event category |
 
|
exporter_oid |
varchar(20) |
NULL |
The exporter to which events within this category will be exported. May be NULL |
usm_event_category_value |
An event category value specifies one legal value for a event category. It is thus possible to specify a set of legal values for events within a event category. The user will then, when creating or updating events within that category be presented with a selection of the allowed values.
Event categories may or may not have associated event category values.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_category_value_oid |
varchar(20) |
NOT NULL |
Unique identity of the event category value |
 
|
description |
nvarchar(255) |
NULL |
The description of the value |
 
|
value |
nvarchar(255) |
NULL |
The value itself |
 
|
event_category_oid |
varchar(256) |
NULL |
Unique identity of the event category |
usm_event_data |
Contains event data received for a event instance.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_instance_id |
int |
NOT NULL |
Event instance identity associated with the data |
 
|
time_stamp |
integer |
NOT NULL |
The time_stamp in epoch for the data |
 
|
user_name |
varchar(64) |
NULL |
User name to which the data reflects |
 
|
value |
float |
NULL |
The measured value |
 
|
maximum |
float |
NULL |
The maximum value if reduction has been performed. Null orderwise |
 
|
minimum |
float |
NULL |
The minimum value if reduction has been performed. Null otherwise. |
 
|
reductionlevel |
bit |
NULL |
The reduction level. Null means no reduction |
 
|
interval |
integer |
NULL |
The sample interval
|
 
|
no_of_samples |
integer |
NULL |
The number of samples in the reduction. Null means no reduction |
 
|
insert_time |
integer |
NULL |
The inserted time in epoch |
usm_event_instance |
An event instance is an instance of an event type. It identifies a running event type for a given schema, event type, agent host and target_host.
The number if instances in usm_event_instance at a give point in time identifies the number of running data collections/measurements. An event instance is similar to a data collection in slm 3.5.
One event instance can be used by multiple metric instances to produce the metric result. A event instance has an associated set of attributes, which is identified by the usm_event_instance_value table.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_instance_id |
int |
NOT NULL |
The unique identity of the event instance |
 
|
schema_comp_id |
int |
NULL |
The shema component the event instance measures data for. May be NULL |
 
|
event_id |
int |
NULL |
The event type identity |
 
|
agent_host_id |
int |
NULL |
The agent host id |
 
|
target_host_id |
int |
NULL |
The target host id. May be null. |
usm_event_instance_value |
Contains defined attribute values for a given event instance. The attribute values itself references the usm_metric_attr_value table.
The attribute values for an event instance is defined when the event instance is created. They are derived from the metric_attr_spec of the selected metric to be instantiated together with the values provided by the user.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_instance_value_id |
int |
NOT NULL |
The identity of the event instance value |
 
|
metric_attribute_value_id |
integer |
NULL |
Unique identity of the attribute value |
 
|
event_instance_id |
int |
NULL |
The event instance to which this value belongs |
usm_event_type |
The usm_event_type table represents all events supported by SLM r11. An event type identifies a type of measurement that can be performed by a collector.
The usm_event_type table represents the data in eventinfo.dat in Assure 2.2. In r11, the events may be represented both in eventinfo.dat and in this table.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_id |
int |
NOT NULL |
The unique identity of the event type.
event_id < 100 000 is statically defined
dynamically defined event_ids should start at 100 000
|
 
|
collector_id |
int |
NULL |
The collector_id used to collect events of this type. |
 
|
name |
varchar(100) |
NOT NULL |
The name of the event type |
 
|
console_msg |
nvarchar(256) |
NOT NULL |
console message that is related to the event |
 
|
event_class |
varchar(100) |
NULL |
The class of the DbLoader plugin used to load data into the events tables |
 
|
table_name |
varchar(100) |
NULL |
The table name, usually event_data, or event_dataXXX to which the events are loaded. |
 
|
label |
nvarchar(50) |
NOT NULL |
label of the event type |
usm_event_type_attributes |
Contains attributes for a given event type. All attributes for the event type that are not fields in usm_event_type can be represented in this table.
This will typically be data that tells the collector how to collect the event data. For example, this can be logwatcher regular expressions or other information. For some events, these attributes will be kept in collector specific configuration files in r11, such as logwatcher.cfg. This will be moved into the attributes tables in future versions. SLM 3.5 metric types may be represented with event types with event type attributes.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_id |
int |
NOT NULL |
Event type id to which the attributes belongs |
 
|
attr_name |
varchar(50) |
NOT NULL |
The attribute name |
 
|
attr_value |
nvarchar(256) |
NULL |
The attribute value |
usm_event_type_collector |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_type_id |
int |
NOT NULL |
The unique identity of the event type.
event_id < 100 000 is statically defined
dynamically defined event_ids should start at 100 000
|
 
|
collector_id |
int |
NOT NULL |
Unique identity of the collector type |
 
|
agent_host_os |
varchar(20) |
NULL |
  |
 
|
criteria_name |
varchar(20) |
NULL |
  |
 
|
criteria_value |
varchar(20) |
NULL |
  |
usm_exchange_rate |
Persists the mappings between different exchange rates based on currency. The rate is always stored relative to the SP currency. So to convert from one currency to another currency where neither the SP currency is, you first convert to the first currency then convert to the second currency. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
currency |
varchar(50) |
NOT NULL |
the value as used in iCanView that is stored in the tenant. Currently this is an integer value stored in a string field |
 
|
exchange_date |
date |
NOT NULL |
the dat the exchange rate took affect |
 
|
symbol_1 |
varchar(3) |
NOT NULL |
the text abbreviation of the currency (ie: USD, GBP, etc) |
 
|
symbol_2 |
nvarchar(16) |
NOT NULL |
the actual symbo used (ie: $ ) |
 
|
rate |
varchar(64) |
NULL |
a multiplying factor |
usm_export |
This is used in exporting purposes within billing. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
type |
int |
NOT NULL |
Export Type |
 
|
domain |
varchar(50) |
NOT NULL |
Related Domain |
 
|
filename |
nvarchar(128) |
NOT NULL |
File Name |
 
|
export_date |
date |
NULL |
export date |
 
|
format |
nvarchar(10) |
NULL |
Format of the export |
 
|
num_records |
integer |
NULL |
Number of exported records |
 
|
text_1 |
nvarchar(50) |
NULL |
Description |
 
|
date_1 |
date |
NULL |
Date |
 
|
date_2 |
date |
NULL |
Date |
usm_exporter |
Defines exporter for a calendar category. This exporter is used to export all calendar events to an external source. The exporter will be called for insert, update,delete of events within the associated event category |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
exporter_oid |
varchar(20) |
NOT NULL |
Unique identity of the exporter |
 
|
exporter_class |
varchar(255) |
NULL |
Full package name and class of java class implementing the exporter |
 
|
bundle_key |
varchar(50) |
NULL |
bundle key for exporter name |
usm_featured_offering |
This table associates a feature offering to a catalog folder (many-to-one). Featured offerings are a new means for the catalog administrator to choose specific offerings in the catalog and feature them at different levels of request web store browsing. They can be shown on the landing page, the browse drill down UIs, and the offering details UI. This is a way to advertise new or popular offerings in the browsing UIs. On the offering details page, featured offerings can serve as alternative or complimentary choices. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
featured_offering_id |
integer |
NOT NULL |
Featured Offering ID |
 
|
featured_in_offering_id |
integer |
NOT NULL |
Featured Offering would be featured in this offering/folder |
 
|
feature_type |
int |
NOT NULL |
Currently supported feature types include 0 and 1 where
a) 0 stands for Feature offering in current folder, and,
b) 1 for Feature in current and children folders/offerings.
|
usm_fiscal_period |
The fiscal periods are defined in this table |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
fp_id |
int |
NOT NULL |
Unique id for fiscal period. |
 
|
name |
nvarchar(50) |
NULL |
descriptive name for the period. Ex: January 2002 |
 
|
year |
int |
NOT NULL |
the fiscal year of this period. This value can and often is different from the year specified in start_date and end_date. |
 
|
start_date |
date |
NOT NULL |
beginning date of fiscal period |
 
|
end_date |
date |
NOT NULL |
ending date of fiscal period |
 
|
period |
integer |
NULL |
0=monthly, 1=quarterly, 2=yearly |
 
|
domain |
varchar(50) |
NULL |
Domain to which the period was defined. |
usm_form_attributes_schema |
This table defines the attributes for all the component types |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
attr_name |
varchar(256) |
NOT NULL |
Form Component Attribute Name |
 
|
form_entity_type |
int |
NOT NULL |
Form Entity Type |
 
|
attr_default_value |
nvarchar(4000) |
NULL |
Attribute Default Value |
 
|
is_required |
int |
NOT NULL |
Specifies whether mandatory attribute or not. 0 = Not Mandatory, 1 = Mandatory |
usm_form_component_attributes |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
form_comp_attr_id |
bigint |
NOT NULL |
Form Component Attribute Id |
 
|
form_comp_id |
bigint |
NOT NULL |
Form Component id |
 
|
attr_locale |
varchar(8) |
NOT NULL |
Attribute Locale |
 
|
attr_name |
varchar(256) |
NOT NULL |
Attribute Name |
 
|
attr_value |
nvarchar(4000) |
NOT NULL |
Attribute Value |
 
|
attr_type |
int |
NULL |
Attribute Type {Regular = 1, Long = 2}, default to Regular Attribute (1), if is Long Attribute, then the overflow attribute value will be in the table usm_form_component_attrib_ext
|
usm_form_component_long_attributes |
It stores the long attribute value overflow of the form component attributes. When attribute type value equals to 2 (Long Attribute) of the usm_form_component_attributes, then it will store the long attribute to this table.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
form_comp_attr_id |
bigint |
NOT NULL |
Form Component Attribute Id |
 
|
attr_long_value |
ntext |
NOT NULL |
form attribute long value like long javascript etc |
usm_form_entities |
This table contains all the entities that are displayed in the tree and the form |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
form_entity_id |
bigint |
NOT NULL |
Entity id |
 
|
form_entity_name |
nvarchar(256) |
NOT NULL |
Form Entity name |
 
|
tenant_id |
varchar(50) |
NOT NULL |
The unique tenantid that identifies this organization/tenant |
 
|
form_entity_type |
int |
NOT NULL |
Form entity type. 1 = Folder, 2 = Form, 3 = Column Layout, 4 = Column, 5 = Text Field, 7 = Check Box, 8 = Text Area, 9 = Select, 10 = Label, 11 = Option, 12 = Radio Group, 13 = Radio, 14 = Date, 15 = Image
|
 
|
last_modified |
datetime |
NOT NULL |
Last Modified Date |
 
|
created_by |
binary |
NOT NULL |
  |
 
|
created |
datetime |
NOT NULL |
Created date |
 
|
is_system |
int |
NOT NULL |
To identify whether it is system defined entity or not. 0 = User defined, 1 = System Defined |
 
|
form_entity_parent_id |
bigint |
NULL |
Parent entity ID of this entity |
 
|
form_entity_path |
varchar(256) |
NOT NULL |
Form Entity Path |
 
|
form_entity_position |
int |
NULL |
Form Entity Position |
 
|
last_modified_by |
binary |
NOT NULL |
  |
usm_guinode |
Guinode is the information about dynamic linked data in the USM UI. The UI information defines which data can be retrieved dynamically from the backend engines. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
guinode_id |
varchar(128) |
NOT NULL |
Guinode unique ID |
 
|
title |
varchar(64) |
NULL |
desctriptive title for the guinode |
 
|
label |
varchar(64) |
NULL |
descriptive label for the guinode |
 
|
content_type |
int |
NULL |
5 invoking the plugin method, 6 invoke the multi-plugin, 2 no invoking plugin |
 
|
access_depth |
int |
NULL |
If it is 1, then assocated child guinode will be accessed, it it is 0 or null then the current node will be accessed. |
 
|
keywords |
varchar(64) |
NULL |
Group, Locale, User, Domain |
 
|
icon1 |
varchar(50) |
NULL |
To store icon information |
 
|
icon_used |
int |
NULL |
specifies if customized icon is used or not, true or false |
 
|
is_secured |
int |
NULL |
Flag to indicate if this guinode invocation is secure - not used |
 
|
xsl_presentation |
varchar(64) |
NULL |
Relative xsl file location for presentation of xml generated by the invocation of guinode |
 
|
xsl_transformation |
varchar(64) |
NULL |
Relative xsl file location for Transfromation of xml generated by the invocation of guinode |
 
|
separate_window |
int |
NULL |
0, 1; Specifies if a new window is to be opened to display the lauchpad content |
 
|
type |
varchar(128) |
NULL |
Used for caching, specifying which context this guinode is being used |
 
|
help_url |
varchar(256) |
NULL |
The url for accessing help information specific to this guinode |
 
|
is_system |
int |
NULL |
Specifies if this is a system specific entity |
 
|
need_login |
int |
NULL |
Specifies if one need to be authenticated to call this node, Eg: To bypass authentication |
usm_guinode_content |
This table is the extension to the usm_guinode table, storing the content of the guinode, the content specifies which Content Engine handles the request, which plugin method needs to be invoked etc. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
guinode_id |
varchar(128) |
NOT NULL |
referenced guinode unigue ID |
 
|
order |
integer |
NOT NULL |
sequential number for the one guinode if it has multiple contents |
 
|
content_order |
int |
NOT NULL |
This specifies the order of the content, as that might be critical in processing. Column name "order" is DB keyword set, so change to content_order |
 
|
content |
varchar(64) |
NULL |
plugin information to retrieve the content from the backend |
usm_hierachical_data_types |
to store Service Catalog hierachical data types like resources for an examples, computer, cpu, memory, and hard disk etc |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
hdt_id |
varchar(64) |
NOT NULL |
Id of the hierachical data |
 
|
hdt_type |
int |
NOT NULL |
data type { resource type = 1 (default), request status=2 } |
 
|
hdt_name |
nvarchar(256) |
NOT NULL |
name of the data |
 
|
hdt_path |
varchar(2048) |
NOT NULL |
hierachical path to represent the data link tree |
 
|
hdt_tenant_id |
varchar(50) |
NULL |
The unique tenantid that identifies this organization/tenant |
 
|
hdt_parent_id |
varchar(64) |
NULL |
Id of the hierachical data |
 
|
hdt_created_date |
datetime |
NOT NULL |
created date |
 
|
hdt_last_modified_date |
datetime |
NOT NULL |
last modified date |
 
|
hdt_created_by_uuid |
binary |
NULL |
user contact uuid |
usm_host |
Defines the host.
Host is either auto-discovered or added. Various things tie to the host in order to meter the data
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
host_id |
int |
NOT NULL |
The identity of the host. |
 
|
hostname |
varchar(64) |
NULL |
The hostname |
 
|
ip_address |
varchar(64) |
NULL |
The ip address of the host |
 
|
description |
varchar(128) |
NULL |
A description of the host |
 
|
comment |
varchar(64) |
NULL |
A comment |
 
|
registered |
int |
NULL |
1: Autodiscovered. |
 
|
community_string |
varchar(64) |
NULL |
SNMP community string for the host |
 
|
timeout |
int |
NULL |
SNMP timeout for the host |
 
|
capability |
varchar(64) |
NULL |
Describes the capabilities of the host. net_device |
 
|
host_type_id |
integer |
NULL |
Identifies the host type |
 
|
asset_uuid |
tinyint(16) |
NULL |
FK to ca_asset_source table |
 
|
retry |
int |
NULL |
This column is not used |
 
|
secure_info |
varchar(512) |
NULL |
This column is not used |
 
|
comments |
nvarchar(64) |
NULL |
description for the field. Field name "comment" has been changed to "comments" to support oracle
|
usm_host_element |
Defines the element of a host. Interfaces for a network device will be represented here.
Eg-- Serial1, Ethernet1 etc
This table is deprecated. ( We are not using this table from R11.0)*
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
host_element_id |
int |
NOT NULL |
Unique identity for the usm_host_element |
 
|
element_index |
int |
NULL |
Ordering of the host elements for a specific host. |
 
|
type |
varchar(20) |
NULL |
  |
 
|
oid_string |
varchar(64) |
NULL |
  |
 
|
name |
varchar(64) |
NULL |
The name of the host element, for example interface name Serial2/0 |
 
|
address |
varchar(64) |
NULL |
  |
 
|
host_id |
int |
NULL |
The identity of the host. |
 
|
capability |
varchar(64) |
NULL |
  |
usm_host_type |
Defines the type of the host - Linux, HP_UX, Cisco Router etc |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
host_type_id |
int |
NOT NULL |
The identity for the host type |
 
|
display_name |
varchar(64) |
NULL |
The name of the host type, Host, Host_AIX, Host_HPUX, Router, Switch etc. |
 
|
description |
varchar(128) |
NULL |
A textual description of the host type |
 
|
capability |
varchar(64) |
NULL |
The capability of the host type. |
usm_icon |
The icon information that user can define as UI resource and can use for their UI. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
icon_id |
varchar(50) |
NOT NULL |
Unique ID |
 
|
name |
varchar(64) |
NULL |
icon name |
 
|
url |
varchar(64) |
NULL |
the location where the icon is located |
 
|
type |
varchar(32) |
NULL |
descriptive type name for the icon |
 
|
mime_type |
varchar(32) |
NULL |
file type |
usm_id_mapping |
A generic table for integration with other components that can specify how to map objects from one system to another. The description of the fields is listed below but only really as a guideline. During integration there is flexibility to change the behaviors and meaning of these fields.
Primary keys are: domain, ican_type, system_id, object_id
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
domain |
varchar(128) |
NOT NULL |
typically the SP, but can be ST or tenant id |
 
|
system_id |
varchar(64) |
NOT NULL |
the component that this mapping is for |
 
|
object_id |
varchar(64) |
NOT NULL |
id of the object from the integrating component |
 
|
ican_type |
integer |
NOT NULL |
an integer representing the type of ican object the component is trying to map to. |
 
|
ican_id |
integer |
NOT NULL |
id of the object in ican the component is trying to map to. |
 
|
change_date |
date |
NOT NULL |
Update date |
 
|
text_1 |
varchar(128) |
NULL |
any additional information |
usm_id_pd |
Holds the last id for the plan definition table entries. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
The next id for plan def table |
usm_id_plan |
Holds the last id for the plan table. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
pd_id |
integer |
NOT NULL |
The next plan def id for the plan table |
 
|
id |
integer |
NOT NULL |
The next plan id for plan table |
usm_import_attribute |
Attributes for an importer that is not part of a rule or a field in usm_importer. May for example be the directory where the imported files are imported from, the check interval etc |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
import_attribute_id |
integer |
NOT NULL |
The identity of the import attribute |
 
|
value |
varchar(255) |
NULL |
The value of the attribute |
 
|
importer_instance_id |
integer |
NULL |
The identity of the import instance to which this attribute belongs |
 
|
importer_spec_id |
integer |
NULL |
Specification of possible attribute values for an importer |
usm_import_export_mapping |
for ixutil import and export, this will store imported or exported unique UUID by table_name, id, uuid, tenant_id mapping table with timestamp. This will help to migrate data with unique identifier
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
table_name |
varchar(64) |
NOT NULL |
ixutil import or export table name |
 
|
id |
varchar(256) |
NOT NULL |
related ixutil import or export object ID |
 
|
uuid |
binary(16) |
NOT NULL |
related ixutil import or export object UUID |
 
|
domain |
varchar(50) |
NOT NULL |
related ixutil import or export tenant id |
 
|
created_date |
datetime |
NULL |
related ixutil import or export record - first created dated |
 
|
last_import_date |
datetime |
NULL |
related ixutil import or export record - last imported date |
 
|
last_export_date |
datetime |
NULL |
related ixutil import or export record - last exported date |
usm_import_rule |
Defines the rules for a importer such as field separator, which field has which meaning etc |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
import_rule_id |
integer |
NOT NULL |
The import rule identiy |
 
|
name |
varchar(100) |
NULL |
The name of the import rule |
 
|
rule_string |
long varchar |
NULL |
The import rule itself. |
 
|
importer_id |
integer |
NULL |
The importer, to which the rule belongs. |
usm_import_table_index |
Table used for bulk load imports. The data is first bulk loaded into temporary tables. Each temporary table is registered in this table. A background job will then move data from the temporary tables into the event_data tables |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
table_name |
varchar(50) |
NOT NULL |
The name of the temporary import table |
 
|
created_time |
integer |
NULL |
The epoch time stamp of when the table was created. |
usm_importer |
Represents a SLM importer, capable of importing event data into the event_data tables. This entity was known as import metrics in SLM 3.5
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
importer_id |
integer |
NOT NULL |
The unique identity of the importer |
 
|
name |
varchar(50) |
NULL |
Unique symbolic name for the importer. Used for references on command line tools etc. |
 
|
label |
nvarchar(50) |
NULL |
The label of the importer. |
 
|
label_bundle_key |
varchar(50) |
NULL |
The bundle key for the label. This is used for i18n labels when label is NULL |
 
|
callback_type |
c(1) |
NULL |
The callback type |
 
|
callback_function |
varchar(255) |
NOT NULL |
The callback function |
 
|
status |
c(1) |
NULL |
The status |
 
|
metric_folder_id |
integer |
NULL |
The metric folder to which the imported metrics will be placed. |
usm_importer_instance |
An instance of an importer running on one specific dc server |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
importer_instance_id |
integer |
NOT NULL |
Unique identity for the importer instance |
 
|
importer_id |
integer |
NULL |
The unique identity of the importer |
 
|
server_id |
integer |
NULL |
Unique identifier for one slm server |
usm_importer_spec |
The specification of the attributes used to instantiate an importer into an importer instance. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
importer_spec_id |
integer |
NOT NULL |
Specification of possible attribute values for an importer |
 
|
attribute_name |
varchar(50) |
NULL |
The name of the attribute |
 
|
type |
varchar(50) |
NULL |
Defines the type of attribute, hidden, select etc. |
 
|
label_bundle_key |
varchar(50) |
NULL |
The bundle key for the attribute label. Used if the label is not set. |
 
|
label |
nvarchar(100) |
NULL |
The label of the attribute |
 
|
default_value |
nvarchar(255) |
NULL |
The default value of the attribute |
 
|
is_required |
c(1) |
NULL |
Specifices whether the attribute is required or not.
Y - the attribute is required
N - optional attribute
|
 
|
importer_id |
integer |
NULL |
The unique identity of the importer |
usm_importer_spec_value |
Used to represent a set of legal values for a usm_importer_spec attribute. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
importer_spec_id |
integer |
NOT NULL |
Specification of possible attribute values for an importer |
 
|
value |
varchar(255) |
NOT NULL |
One of the values for the attribute spec |
usm_install |
Defines the installation definition and value, used by installation to determine what is installed. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
host_id |
int |
NOT NULL |
The identity of the host. |
 
|
product_code |
nvarchar(64) |
NOT NULL |
product code are:
USV: Unicenter Service View
USA: Unicenter Service Accounting
USC: Unicenter Serviec Catalog
USM: Unicenter Service Meter
USS-BO: Unicenter Service SLM-Base Options
USS-AO: Unicenter Service SLM-Advance Options
|
 
|
name |
nvarchar(128) |
NOT NULL |
Field name
it will contain data like
buildnumber
is_installed
|
 
|
value |
nvarchar(64) |
NULL |
field value |
 
|
data_type |
bit |
NULL |
Holds the Data Type for the name field
String = 0
Integer = 1
Float = 2
Date = 3
Decimal = 4
Double = 5
Binary = 6
|
usm_installed_component |
Defines each component which is installed on the system. There are multiple installed components linked to a system install representing different components installed on the system. Eg: Billing, ViewManager, Scheduler, WorkFlow etc |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
installed_component_id |
varchar(50) |
NOT NULL |
The unique id for the installed component |
 
|
name |
varchar(64) |
NULL |
The descrive name of the installed component |
 
|
type |
varchar(256) |
NULL |
The type of installed component, Scheduler type, Accounting type etc |
usm_installed_subcomponent |
Defines the installation sub components available on the system |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
installed_subcomponent_id |
varchar(50) |
NOT NULL |
The unique id for the installed sub component |
 
|
class |
varchar(64) |
NULL |
The java class implementation for this sub component |
 
|
comment |
varchar(64) |
NULL |
A decriptive comment for this component |
 
|
description |
varchar(128) |
NULL |
Desciption of this component |
 
|
comments |
nvarchar(64) |
NULL |
description for the field. Field name "comment" has been changed to "comments" to support oracle |
usm_invoice_history |
Every bill run and invoice on demand is recorded in this table. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
invoice_history_id |
integer |
NOT NULL |
Unique id |
 
|
start_date |
date |
NOT NULL |
The date the bill run associated to this invoice history record began |
 
|
domain |
varchar(50) |
NOT NULL |
This is the tenant ID of the account |
 
|
parent_domain |
varchar(50) |
NOT NULL |
This is the parent tenant ID, the value of this field is always either a Supert Tenant, Service Provider, or empty in the case when domain is the value of the Service Provider. |
 
|
end_date |
date |
NULL |
The date the bill run associated to this invoice history record ended |
 
|
status |
integer |
NOT NULL |
No Comment Available |
 
|
phases |
integer |
NOT NULL |
Currently not used. Not likely to every be used again |
 
|
num_invoices |
integer |
NOT NULL |
The number of invoices generated in the bill run or invoice on demand |
 
|
total_invoices |
integer |
NOT NULL |
Total number of invoices to be generated that are supposed to be generated in the bill run or invoice on demand |
 
|
forced |
integer |
NOT NULL |
Unsupported and exists for backward compatibility |
 
|
debit_amount |
float |
NULL |
Total debits generated for all accounts in the bill run |
 
|
credit_amount |
float |
NULL |
Total credits generated for all accounts in the bill run |
 
|
system_name |
nvarchar(128) |
NOT NULL |
The host that ran the bill run or processed the invoice on demand |
 
|
group_name |
nvarchar(128) |
NULL |
The billing group that the bill run processed |
 
|
billing_cycle |
nvarchar(50) |
NULL |
Unsupported and exists for backward compatibility |
 
|
billing_cycle_interval |
integer |
NULL |
Interval between billing cycles. |
 
|
period_from_date |
date |
NULL |
Period start Date. |
 
|
period_to_date |
date |
NULL |
Period end date. |
 
|
bill_date |
date |
NULL |
Invoicing date. |
 
|
days_due_default |
integer |
NULL |
Default days due from the account. |
 
|
rollback_date |
date |
NULL |
Invoice Rollback Date |
usm_keyword |
All unique keywords are stored in this table. Keywords are then looked up in associated tables with their corresponding keyword unique ID. As of r11.2, the only supported association is rate item definition to keyword mapping. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
keyword_id |
integer |
NOT NULL |
Unique ID for the keyword |
 
|
keyword |
nvarchar(256) |
NULL |
keywords |
usm_last_analysis |
This table contains information about the last run analysis for a given analysis job. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analyze_job_id |
integer |
NOT NULL |
Unique identity for the analyze job |
 
|
period_start |
integer |
NULL |
The epoch start time of the analysis period. |
 
|
period_stop |
integer |
NULL |
The epoch stop time for the period. |
 
|
report_period |
varchar(30) |
NULL |
report period |
 
|
error |
varchar(50) |
NULL |
error description |
 
|
link |
varchar(100) |
NULL |
Link to the html document containing the actual report.
|
usm_lastid |
Persists the last id generated for many of the tables records. This is maintained and updated by Accounting and the Catalog. Integrated components should not update this table, reference it, or rely on it any way. This table can change to support design implementations that enhance the product. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
name |
varchar(50) |
NOT NULL |
a name representing an id that will be updated and referenced. |
 
|
id |
integer |
NOT NULL |
value that represents the last id used |
usm_launchpad |
Defines the menu information for the USM UI. Menu will be contructed dynamically by retrieving the launch information by the backend engine.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
launchpad_id |
varchar(128) |
NOT NULL |
Unique ID |
 
|
title |
varchar(64) |
NULL |
launchpad title |
 
|
content_type |
int |
NULL |
3, 5 |
 
|
menu_type |
int |
NULL |
This field indicates the level of the menu item
0 = no rendering
1 = main tab
2 = sub tab
3 = vertical menu - gun handle - category
4 = vertical menu - gun handle- item
5 = vertical menu TREE (this is the root of a simple tree, so the backend would have to get all its children nodes)
|
 
|
is_default |
bit |
NULL |
specifies the default flag |
 
|
product_code |
nvarchar(64) |
NOT NULL |
product code |
 
|
tag_name |
varchar(64) |
NULL |
tag name |
 
|
display_intree |
int |
NULL |
Flag to indicate if need to be displayed in tree or not - not used for now |
 
|
access_depth |
int |
NULL |
If it is 1, then assocated child menu will be accessed, it it is 0 or null then the current node will be accessed. |
 
|
icon_used_image |
varchar(256) |
NULL |
if the icon used, then the image resource file name |
 
|
separate_window |
int |
NULL |
0, 1; Specifies if a new window is to be opened to display the lauchpad content |
 
|
xsl_presentation |
varchar(64) |
NULL |
Relative xsl file location for presentation of xml generated by the invocation of guinode |
 
|
xsl_transformation |
varchar(64) |
NULL |
Relative xsl file location for Transfromation of xml generated by the invocation of guinode |
usm_launchpad_content |
For each USM launchpad, defines what contents will be dynamically retrieved to contruct menu and what backend class will handle those request. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
launchpad_id |
varchar(128) |
NOT NULL |
referenced launchpad unique ID |
 
|
order |
integer |
NOT NULL |
sequential number for the one launchpad if it has multiple contents |
 
|
content_order |
integer |
NOT NULL |
This specifies the order of the content, as that might be critical in processing. Column name "order" is DB keyword set, so change to content_order |
 
|
content |
varchar(64) |
NULL |
launchpad content |
usm_link_account_user |
Place holder for many to many relationship between user and account, a account can have may users and a user can be part of many accounts. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
user_id |
nvarchar(100) |
NOT NULL |
handles the related user id |
 
|
account_id |
varchar(50) |
NOT NULL |
handle to the account object |
 
|
type |
int |
NULL |
Indicates if an account is a request account (type=2) or a regular account (type=1) |
usm_link_analysis_layout |
usm_link_analysis_layout |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_layout_id |
varchar(50) |
NOT NULL |
Specifies the Unique identifier for the report layout. It is created when the layout is saved |
 
|
analysis_id |
integer |
NOT NULL |
Unique identity for the analysis |
 
|
is_default |
binary |
NOT NULL |
default |
usm_link_analyze_func_metr_cat |
link table idenfying which metric categories supports which functions |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analyze_function_id |
integer |
NOT NULL |
Unique identifyer for the analyze function |
 
|
metric_category_id |
integer |
NOT NULL |
Unique identity identifying the metric category |
usm_link_analyze_job_group |
Link that represents the report groups for an analyze job |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
analyze_job_id |
integer |
NOT NULL |
Unique identity for the analyze job |
 
|
report_group_id |
int |
NOT NULL |
Unique identity for the report group |
usm_link_analyze_job_ticket |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
service_desk_ticket_id |
int |
NOT NULL |
  |
 
|
analyze_job_id |
integer |
NOT NULL |
Unique identity for the analyze job |
usm_link_billing_account_group |
The table billing_groups are used internally and are never exposed to any GUI and is not integrated with any other component, and therefore may change and is not documented here nor supported. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
group_id |
int |
NOT NULL |
The id of the accounting to which the associated account belongs. |
 
|
account_no |
varchar(50) |
NOT NULL |
The account number associated to the billing_account. |
 
|
type |
nvarchar(50) |
NOT NULL |
Type of the billing group link |
usm_link_calendar_contract |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
calendar_oid |
varchar(256) |
NOT NULL |
Unique identity of the calendar |
 
|
contract_id |
int |
NOT NULL |
Unique identity for the contract |
usm_link_contract_sla_inst |
This table is the relationship place holder for a SLA contract and an SLA instance |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
contract_id |
int |
NOT NULL |
Unique identity for the contract |
 
|
sla_instance_id |
int |
NOT NULL |
  |
usm_link_event_inst_metr_inst |
Many to many link between metric instances and event instances. Identifies which metric instances used which event instances.
One event instance may be reused by multiple metric instances.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_instance_id |
int |
NOT NULL |
Unique identifier |
 
|
event_instance_id |
int |
NOT NULL |
Event instance identity
|
usm_link_event_metric_category |
link table linking an event type to a metric category |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_category_id |
integer |
NOT NULL |
Unique identity identifying the metric category |
 
|
event_id |
int |
NOT NULL |
Event type identity |
usm_link_guinode_guinode |
Defines the relationship of child and parent guinode information. Guinode can contain child guinodes to retrieve more data to user interface. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
guinode_parent_id |
varchar(128) |
NOT NULL |
parent guinode ID |
 
|
guinode_id |
varchar(128) |
NOT NULL |
child guinode ID in hierarchy structure |
 
|
link_order |
integer |
NOT NULL |
related child guinode sequential order |
usm_link_importer_inst_metric |
This table is the place holder for the relationships between an importer instance and metric |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_id |
int |
NOT NULL |
The identity of the metric |
 
|
importer_instance_id |
integer |
NOT NULL |
Unique identity for the importer instance |
usm_link_install_comp_subcomp |
Place holder for the relationship as which install components are part of which system install |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
installed_subcomponent_id |
varchar(50) |
NOT NULL |
The unique id for the installed sub component |
 
|
installed_component_id |
varchar(50) |
NOT NULL |
The unique id for the installed component |
usm_link_launchpad_launchpad |
Defines the relationship of child and parent launchpad information. Launchpad can contain child launchpads to retrieve sub menu. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
launchpad_parent_id |
varchar(128) |
NOT NULL |
parent lauchpad ID in hierarchy structure |
 
|
launchpad_id |
varchar(128) |
NOT NULL |
child lauchpad ID in hierarchy structure |
 
|
link_order |
integer |
NOT NULL |
related child launchpad sequential order |
usm_link_method_method |
This table is used in the multiple method invocation feature, this holds the relationships for a plugin methods
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
method_id |
varchar(128) |
NOT NULL |
Plugin method unique ID |
 
|
method_parent_id |
varchar(128) |
NOT NULL |
Plugin method unique ID |
usm_link_metric_schema_comp |
This table is the placeholder for relationships between a metric and a schema component |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_id |
int |
NOT NULL |
The identity of the metric |
 
|
schema_comp_id |
int |
NOT NULL |
Unique identity of the schema component |
usm_link_metric_scope |
Many - many relationship between scope and metirc/metric_category. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
link_metric_scope_id |
integer |
NOT NULL |
Identity of the metric scope link |
 
|
metric_category_id |
integer |
NOT NULL |
Unique identity identifying the metric category |
 
|
scope_id |
integer |
NOT NULL |
Unique identity for the scope |
 
|
service_goal_id |
integer |
NULL |
Uniquely identifies the |
usm_link_mr_import_event_inst |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
import_id |
int |
NOT NULL |
unique ID |
 
|
event_instance_id |
int |
NOT NULL |
The unique identity of the event instance |
usm_link_object_keyword |
This table is used to store information linking a rate item to a keyword ID (from usm_keyword). Currently (r11.2+) this keyword assignment is only supported and assigned at the rate item level on the rate item definition UI (one-to-many).This table is designed to accommodate the future design plan to support keyword assignments for any object type in the system (for example, offerings, rate plans, reports, etc). |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
object_type |
varchar(32) |
NOT NULL |
Object Type |
 
|
object_id |
integer |
NOT NULL |
Unique ID for the object |
 
|
keyword_id |
integer |
NOT NULL |
Unique ID for the keyword |
usm_link_offering_ci |
Table to map one or many Service Catalog Offerings to one or many CMDB Configuration Items. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
offering_id |
integer |
NOT NULL |
the unique id for each offering. |
 
|
ci_uuid |
byte varying(16) |
NOT NULL |
Unique CMDB Configuration Item ID. |
 
|
status |
int |
NOT NULL |
Indicates if the mapping is active(1) or inactive(0). Mapping becomes inactive when associated CMDB CI is made inactive in CMDB. |
usm_link_plugin_plugintype |
This table is the place holder for relationships between a plug-in and a plugintype
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
plugin_type_id |
varchar(50) |
NOT NULL |
The unique id for the plugin type |
 
|
plugin_id |
varchar(50) |
NOT NULL |
The unique id for the plugin |
usm_link_profile_hosts |
Many-many link between collection profile and the hosts(target hosts) |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
collection_profile_id |
int |
NOT NULL |
The identity of the collection profile |
 
|
target_host_id |
int |
NOT NULL |
The target host id.
|
usm_link_rateitem_model |
This table is used to store information linking a rate item to a UAPM asset model. This model assignment takes place at the rate row level on the rate plan definition UI (one-to-many) |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
rate_item_id |
integer |
NOT NULL |
the unique id for each rate item |
 
|
model_uuid |
tinyint(16) |
NOT NULL |
Stores an asset model UUID |
 
|
created_date |
datetime |
NOT NULL |
The date when this record was created. |
 
|
created_by_user_id |
nvarchar(100) |
NOT NULL |
The user id of the person creating this record. |
usm_link_report_variable_data |
Holds many to many relationship between report data objects and report variables. A data object can have multiple variables and a report variable can be used in many report data objects |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_data_id |
varchar(50) |
NOT NULL |
Refers to the unique identifier of the report data object |
 
|
report_variable_id |
varchar(50) |
NOT NULL |
Refers to the unique identifier of the report variable |
usm_link_request_reservation |
to map Service Catalog usm reservation, reserved resource items, and its subscriptions of the service |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
request_id |
int |
NOT NULL |
related request id of the Catalog request reservation |
 
|
reservation_sub_detail_id |
integer |
NOT NULL |
related subscription detail id of the Catalog request reservation |
 
|
reservation_id |
varchar(64) |
NOT NULL |
related reservation id of the Catalog request reservation |
 
|
reservation_form_sub_detail_id |
integer |
NULL |
related form subscription detail id of the Catalog request reservation |
usm_link_resource_outage |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
calendar_oid |
varchar(256) |
NOT NULL |
Unique identity of the calendar |
 
|
host_id |
int |
NOT NULL |
The identity of the host. |
 
|
sla_instance_id |
int |
NOT NULL |
  |
usm_link_rtapp_account |
Defines relationship on what runtime application are tied to an account |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
account_id |
varchar(50) |
NOT NULL |
Account ID that is related to runtime application |
 
|
runtime_application_id |
varchar(50) |
NOT NULL |
Runtime application ID |
usm_link_schema_component |
icsmcomponent ties schema and schema component
Eg-- It ties winword.exe to Citrix-MS Office
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
smcomponent_id |
varchar(50) |
NOT NULL |
The unique identity of the component link |
 
|
schema_comp_id |
integer |
NULL |
The schema component |
 
|
schema_id |
int |
NULL |
The schema to which the component belongs |
usm_link_schema_inst_metr_cat |
Many - Many relationship between an installed schema instance(appinstance) and a metric category. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
schema_instance_id |
varchar(50) |
NOT NULL |
Indentifying the associated schema instance(app installed instance). |
 
|
metric_category_id |
integer |
NOT NULL |
Unique identity identifying the metric category |
usm_link_schema_metr_category |
Many - Many relationship between a schema and a metric category |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_category_id |
integer |
NOT NULL |
Unique identity identifying the metric category |
 
|
schema_id |
integer |
NOT NULL |
Identifying the schema |
usm_link_schema_slo_template |
Link betwwn schema and slo template |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
schema_id |
int |
NOT NULL |
The schema component |
 
|
slo_template_id |
int |
NOT NULL |
The slo template |
usm_link_scope_layout |
identifies which report layouts can be used for which scope. Many - many link. This will not be used in r11, as usm_analyze_function FK in usm_scope will be used instead
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
scope_id |
integer |
NOT NULL |
Unique identity for the scope |
 
|
report_layout_id |
varchar(50) |
NOT NULL |
The report layout id |
usm_link_server_systeminstall |
Many-Many relationships between a system install entity and the server entity. Ex: Many system install object use one mail server |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
server_id |
int |
NOT NULL |
handle to server id |
 
|
system_install_id |
varchar(64) |
NOT NULL |
handle to system install id |
usm_link_service_event |
This table links a calendar category with a contract or a host. It is used to represent service events for the given contract or host using the provided calendar category.
Representation of service events for contracts and hosts will not change in r11, and stay the same as in Assure 2.2
This table is included for future versions
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
calendar_oid |
varchar(256) |
NOT NULL |
Unique identity of the calendar |
 
|
contract_id |
int |
NOT NULL |
The contract affected by the service events. Either host or contract is set, not both. |
 
|
slo_instance_id |
int |
NULL |
  |
usm_link_service_event_metr_in |
Link identifying which metric instances are affected by which service incident.
Only manually added service events has this link. Calendar derived service events are not associated with metric instances directly, but rather with report groups/contracts(usm_link_service_event)
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
service_event_id |
integer |
NOT NULL |
Unique identifier identifying the service event |
 
|
metric_instance_id |
int |
NOT NULL |
Unique identifier |
usm_link_service_event_ticket |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
service_desk_ticket_id |
int |
NOT NULL |
  |
 
|
service_event_id |
integer |
NOT NULL |
Unique identifier |
usm_link_sla_calendar_event |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
calendar_id |
varchar(128) |
NOT NULL |
Outage Calendar ID (Calendar ID or Business Hour ID) |
 
|
event_id |
varchar(128) |
NOT NULL |
Outage Event ID |
usm_link_slo_instance_instance |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
slo_instance_parent_id |
int |
NOT NULL |
  |
 
|
slo_instance_id |
int |
NOT NULL |
  |
usm_link_slo_package_template |
This table is the placeholder for relationships between an SLO package and templates. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
slo_package_id |
int |
NOT NULL |
  |
 
|
slo_template_id |
int |
NOT NULL |
Identity of the SLO template.
Values < 1.000.000 are statically defined.
Dynamically assigned values should start at 1.000.000.
|
usm_link_slo_template_template |
This table is the placeholder for the relationships between SLO templates |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
slo_template_id |
int |
NOT NULL |
Identity of the SLO template.
Values < 1.000.000 are statically defined.
Dynamically assigned values should start at 1.000.000.
|
 
|
slo_template_parent_id |
int |
NOT NULL |
Identity of the SLO template.
Values < 1.000.000 are statically defined.
Dynamically assigned values should start at 1.000.000.
|
usm_link_subscription_asset |
This table is used to store the information linking a request item with an UAPM asset (ca-asset record) for those request items filled from existing inventory (one-to-many). This table will also be used to store the asset ID when we create a new asset for assets newly purchased based on a request. Creating an asset is a future (but necessary) feature and will take more design.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
request_id |
int |
NOT NULL |
Unique id associated to the order. |
 
|
request_item_id |
integer |
NOT NULL |
the unique id for each subscription record |
 
|
asset_uuid |
tinyint(16) |
NOT NULL |
Asset UUID |
usm_link_sysinstall_installcom |
Place holder for the relationship as which install components are part of which system install |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
installed_component_id |
varchar(50) |
NOT NULL |
handle to the installed component id |
 
|
system_install_id |
varchar(64) |
NOT NULL |
handle to system install id |
usm_link_ticket_request_item |
This table is used to store the mapping between tickets in Unicenter Service Desk and Service Delivery's Request Object (request_item_id and request_id fields). Once a ticket has been linked to a request item it is possible to view the related ticket(s) via the Request detail screen. A new column called 'Related Ticket' has been added next to Amount and Period. This column will show the ID of the Service Desk ticket as a link. Clicking the link will pop up a window displaying the Service Desk ticket. If more than one ticket is associated to the request item they will appear as comma separated. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
persid |
varchar(30) |
NOT NULL |
For CA's Service Desk product persid maps to the SD internal id. Other Helpdesk products
can use persid to store something similar or to store a string representation of their id.
|
 
|
ref_num |
varchar(30) |
NOT NULL |
For CA's Service Desk product ref_num maps to the SD external id. Other Helpdesk products
can use ref_num to store something similar or to store an integer representation of their id.
|
 
|
request_item_id |
int |
NOT NULL |
Catalog Request Item ID that relates to the Helpdesk ticket |
 
|
request_id |
int |
NOT NULL |
Catalog Request ID that relates to the Helpdesk ticket (parent of the Request Item ID) |
usm_localization_value |
language localized values for Service Catalog content data |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
localized_id |
varchar(64) |
NOT NULL |
identifier of localized value |
 
|
obj_tbl_name |
varchar(64) |
NOT NULL |
related localized data table name |
 
|
obj_id |
varchar(128) |
NOT NULL |
related localized data table identifier |
 
|
locale_code |
vachar(8) |
NOT NULL |
language locale |
 
|
attr_name |
varchar(256) |
NOT NULL |
related localized data field name |
 
|
attr_localized_value |
nvarchar(1024) |
NULL |
localized value |
 
|
created_date |
datetime |
NOT NULL |
created date |
 
|
last_modified_date |
datetime |
NULL |
last modified date |
usm_meter_gui_cfg |
Defines the service metering configuration user interface. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
meter_gui_config_id |
varchar(50) |
NOT NULL |
Unique identity for the meter config |
 
|
description |
varchar(128) |
NULL |
A description of the meter config |
 
|
method_name |
varchar(64) |
NULL |
method name of the meter config |
 
|
guinode_id |
varchar(128) |
NULL |
Associated GUI node used to provision the metric. |
 
|
gui_type |
varchar(20) |
NULL |
Defines the properties of the provisioning GUI.
See "Performing Resource Assignment" for more info
|
usm_metering_package |
Defines a service metering package that is available on the system. A metering package is a collection of metric categories for an associated schema. I.e a collection of metrics. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metering_package_id |
int |
NOT NULL |
Unique identity of the metering package |
 
|
package_id |
int |
NULL |
The identity assigned to the package during import. Note. Should use only one id for a metering package. |
 
|
major_version |
varchar(20) |
NULL |
Versioning info |
 
|
minor_version |
varchar(20) |
NULL |
Versioning info |
 
|
name |
varchar(64) |
NULL |
Name of the package |
 
|
schema_id |
int |
NULL |
The schema to which the package belongs |
usm_method |
Defines a multi-method hierarchy for UI backend, which is used to generate the contents.
To construct the hierachy structure, the self join has been implemented by the field method_parend_id
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
method_id |
varchar(128) |
NOT NULL |
Plugin method unique ID |
 
|
guinode_id |
varchar(128) |
NULL |
handle to the Guinode record |
 
|
name |
nvarchar(64) |
NULL |
java method name |
 
|
class |
varchar(256) |
NULL |
plugin java class name |
 
|
engine_id |
varchar(32) |
NULL |
backend engin id |
 
|
description |
nvarchar(128) |
NULL |
description for the method |
 
|
return_code |
varchar(32) |
NULL |
for integration |
 
|
output |
varchar(64) |
NULL |
for integration |
 
|
instance_level |
bit |
NULL |
engine instance level |
 
|
exec_mode |
bit |
NULL |
for integration |
 
|
is_system |
bit |
NULL |
specifies the system flag |
usm_method_input |
This table is the extension of usm_method table and stores the input parameters for a usm_method and is used in multi method invocation plugin method heirarchy |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
method_id |
varchar(128) |
NOT NULL |
Plugin method unique ID |
 
|
input |
varchar(64) |
NOT NULL |
defines the input information for the guinode method
|
usm_method_optional_input |
This table is the extension of usm_method table and stores the optional input parameters for a usm_method |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
method_id |
varchar(128) |
NOT NULL |
Plugin method unique ID |
 
|
optional_input |
varchar(64) |
NOT NULL |
defines optional input for the method |
usm_metric |
A metric, or metric type, represents a way to collect metric data for a given metric category. All metrics within the same metric category collects the same type of metric data, but using different collectors.
A metric type is associated with a schema and a metric category.
A metric type has set of attribute specifications that gives the default values for attributes for metric instances of this metric type.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_id |
int |
NOT NULL |
The identity of the metric |
 
|
major_version |
varchar(20) |
NULL |
Versioning info |
 
|
minor_version |
varchar(20) |
NULL |
Versioning info |
 
|
metric_category_id |
integer |
NULL |
Unique identity identifying the metric category |
 
|
schema_id |
integer |
NULL |
The identity of the associated schema. May be null, in which case the metric is independent of schema. |
 
|
collector_id |
integer |
NULL |
The collector type used to collect these metrics. |
 
|
metric_folder_id |
integer |
NULL |
The metric folder to which this metric belongs |
 
|
label |
nvarchar(100) |
NULL |
The label of the metric |
 
|
label_bundle_key |
varchar(100) |
NULL |
The bundle key of the label. For out-of-the box metrics this can be used to have a i18n label for the metric. |
 
|
name |
nvarchar(100) |
NULL |
The name of the metric. |
 
|
class |
varchar(50) |
NULL |
Identifies the measurement class:
- link - A link is measured.
- path - A path, multiple links, is measured
- node - A node
- none -
|
usm_metric_analyzer |
Contains definition of how a metric category is analyzed by DcAnalyzer. Has an associated set of attributes in usm_metroicc_analyzer_attrs. In Assure 2.2 this data is represented in metricinfo.dat. In r11, this data will still be kept in metricinfo.dat, but for r12 this should be represented in the database |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_analyzer_id |
int |
NOT NULL |
Identity of the metric analyzer . |
 
|
handler |
varchar(100) |
NOT NULL |
The handler for the metric analyzer. |
 
|
plugin |
varchar(100) |
NOT NULL |
The plugin for the metric analyzer. |
usm_metric_analyzer_attrs |
Attributes for a metric analyzer. Will probably not be used in r11, included for future versions |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_analyzer_id |
int |
NOT NULL |
The metric analyzer associated with the attribute |
 
|
attr_name |
varchar(50) |
NOT NULL |
The attribute name |
 
|
value |
varchar(512) |
NOT NULL |
The attribute value |
usm_metric_attr_spec |
The metric attribute specification specifies which attributes can be set for a given metric type during instantiation. It also specifies the default value of the attribute if available.
If an attribute has multiple values allowed, and the user enters multiple values during instantiation/deployment/resource assignment, multiple event instances will be created for the metric instance. This mechanism should be used to reporesent the Assure 2.2. component concept.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_attr_spec_id |
integer |
NOT NULL |
Unique identifier for the metric attribute specification for the given attribute |
 
|
attribute_name |
varchar(100) |
NOT NULL |
Name of the attribute |
 
|
type |
varchar(20) |
NULL |
Defines the type of attribute, hidden, select etc. |
 
|
label_bundle_key |
varchar(50) |
NULL |
The bundle key of the label. This bundle key should be used if the label field is NULL. |
 
|
label |
nvarchar(100) |
NULL |
The label of the attribute |
 
|
default_value |
nvarchar(255) |
NULL |
The default value for the attribute spec. If a plugin is used, the default value should be specified as NULL, and default_reference_key should be used. |
 
|
default_reference_key |
varchar(50) |
NULL |
Reference key to the default value if reference plugins are used. |
 
|
is_required |
c(1) |
NULL |
Y - the attribute is required
N - optional attribute
|
 
|
metric_id |
int |
NULL |
Identifies the metric for which this attribute specification is valid. |
 
|
allow_multiple_values |
c(1) |
NULL |
Y - the user may enter multiple values for this attribute.
N - only one value allowed.
A metric specification for a given metric should only contain one attribute where multiple values are allowed. This will be used to represent multiple components in r11
|
 
|
attr_reference_plugin_id |
integer |
NULL |
References the plugin used to retrieve the allowed attribute values. |
 
|
tab_order |
integer |
NULL |
  |
 
|
cor_property |
varchar(20) |
NULL |
Identifies GUI properties of metrics that have some instantiation data received from COR. |
usm_metric_attr_spec_value |
If a metric attribute spec attribute have a fixed set of allowed values, this table is used to represent the set of allowed values. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_attr_spec_value_id |
integer |
NOT NULL |
Unique identifier |
 
|
metric_attr_spec_id |
integer |
NULL |
Unique identifier for the metric attribute specification for the given attribute |
 
|
value |
nvarchar(100) |
NULL |
The value allowed. Should be null if attr_reference_plugins are used. |
 
|
reference_key |
varchar(50) |
NULL |
The reference key used by the plugin to retrieve the value. Should be NULL if plugins are not used. |
usm_metric_attr_value |
This table contains values for a given metric attribute. Multiple metric instances(of the same metric type) with the same attribute value should reference the same usm_metric_attr_value.
Note, we may make this table independent of metric_attr_spec, so that metric attribute values can be shared across different metric types.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_attribute_value_id |
integer |
NOT NULL |
Unique identity of the attribute value |
 
|
value |
nvarchar(511) |
NULL |
The value |
 
|
metric_attr_spec_id |
integer |
NULL |
Unique identifier for the metric attribute specification for the given attribute |
 
|
reference_key |
varchar(20) |
NULL |
Key used by the metric_attr_plugin to retrieve the value. Should be NULL if metric_attr_reference_plugin_id is NULL |
 
|
attr_reference_plugin_id |
integer |
NULL |
Unique identifier identifying the plugin. Should be NULL if no plugin is used. |
usm_metric_category |
A metric category specifies one type of metric data that can be measured and calculated for a set of associated metrics.
Examples of metric categories--
- Application Availability
- Platform availability
- Bandwidth percentage
One metric category may have an associated set of metrics. Which metric is used to measure the category is defined by the associated schema.
Typically, a metric category like Application Availability will have different metrics defined for different schemas. Each of these metrics will use a collector to collect data and may have different attribute specifications.
The Application Availabilty metric category has 4 types of metrics associated with separate schemas. Each of these metrics uses the same collector, but they have different attribute specifications in that the component attribute values for each metric is different. This is used during resource assignment so that the metric instance has all the associated components.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_category_id |
integer |
NOT NULL |
Unique identity identifying the metric category |
 
|
metric_type |
int |
NULL |
metric cateogryattribute to control the metric request creation user interface restrictions for the metric.
Supported values are:
0 - Do not display component selection and display target host selection
1 - Allow only one component selection and display target host selection
2 - Allow multiple component selection and display target host selection
3 - Force all components to be selected and display target host selection
4 - (reserved)
5 - Do not display component and target host selections
6 - Allow only one component selection and do not display target host selection
7 - Allow multiple component selection and do not display target host selection
8 - Force all components to be selected and do not display target host selection
9 - Uses SMA metric attribute model
10 - SMA import metrics
|
 
|
metric_version |
int |
NULL |
Versioning info |
 
|
name |
varchar(64) |
NULL |
Name of the metric category |
 
|
comment |
varchar(64) |
NULL |
Comment |
 
|
real_time_metric |
int |
NULL |
attribute that identifies whether or not this is a realtime metric. Supported values are:
1 - realtime metric
0 - non - realtime metric
|
 
|
reporting_interval |
int |
NULL |
The reporting interval is used to determine how frequently aggregation occurs. This value in conjunction whit the report_interval_unit determine the length of the period between aggregations
|
 
|
sample_interval |
int |
NULL |
attribute that represents the polling interval of the data collector for this metric category |
 
|
threshold |
float |
NULL |
The threshold value |
 
|
user_dependent |
int |
NULL |
attribute that identifies whether or not this metric is user-based. Supported values are:
1 - user dependent metric
0 - non - user dependent metric
|
 
|
charge_type |
int |
NULL |
attribute used by iCan Bill to determine if the metric provides for chargeback.
1 indicates chargeback metric
0 indicates non-chargeback metric.
|
 
|
meter_gui_config_id |
varchar(50) |
NULL |
attribute specifying the meter_gui_config object ID used by the metering backend to determine how the metric should be provisioned |
 
|
unit_type_id |
int |
NULL |
Identifies the unit type for the metrics of this category. |
 
|
metric_analyzer_id |
int |
NULL |
identity of the metric analyzer used to analyze data for this metric category |
 
|
comments |
nvarchar(256) |
NULL |
  |
usm_metric_folder |
represents a folder in the metric tree. Gives an hierarchical overview of all the metrics in the system.
A metric folder can either be a set of other folders & metrics, or it can be represented as a schema.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_folder_id |
integer |
NOT NULL |
Metric folder identity |
 
|
level |
integer |
NULL |
The level in the metric folder three. 0 is root. |
 
|
parent_path |
varchar(255) |
NULL |
The parent path is a / reparated bath of identities. / means root. |
 
|
label |
nvarchar(100) |
NULL |
The label of the folder |
 
|
label_bundle_key |
varchar(50) |
NULL |
The bundle key label is used for i18n labels when the label itself is NULL. |
 
|
schema_id |
int |
NULL |
The schema that represents this folder. May be null. |
 
|
tree_level |
integer |
NULL |
  |
usm_metric_instance |
usm_metric_instance is created when metric instance is created, it is tied to usm_schema and usm_metric_category.
A metric instance is mapped to one or more event instances that does the actual measurements. For metric instances with multiple components, this will result in one metric instance mapped to multiple event instances.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_instance_id |
int |
NOT NULL |
Unique identifier |
 
|
comment |
varchar(64) |
NULL |
This is a descriptive comment on metic_instance, Example: If any special configuration is needed. |
 
|
description |
varchar(128) |
NULL |
A description about this metric instance |
 
|
destination |
varchar(20) |
NULL |
Destination of the metric instance. May be SLABUS:host:port, smdb etc. |
 
|
enable |
int |
NULL |
  |
 
|
end_time |
datetime |
NULL |
End time, is the date/time when the metric become inactive.
|
 
|
full_detail |
int |
NULL |
  |
 
|
group_id |
int |
NULL |
The code which determines what field to group by.
0=No Group by
1=Group by user
2=group by DC Host
4=group by Target Host
8=group by Component
These values are Boolean, in order to allow a grouping code of multiple fields simultaneously.
|
 
|
metric_category_id |
integer |
NULL |
Unique identity identifying the metric category |
 
|
metric_version |
varchar(20) |
NULL |
Metric request version |
 
|
operator |
int |
NULL |
  |
 
|
real_time_metric |
int |
NULL |
  |
 
|
report_interval |
int |
NULL |
The reporting interval is used to determine how frequently aggregation occurs. This value in conjunction whit the report_interval_unit determine the length of the period between aggregations
|
 
|
requestor |
varchar(20) |
NULL |
The module requesting the creation of this metric instance, BILLING, METERING, SLA etc |
 
|
request_type |
int |
NULL |
metric instance type: 0=Normal, 4=RealTime |
 
|
sample_interval |
int |
NULL |
The sample interval that is used to determine how frequently you would like the data collector to send events for this metric. This value is always in seconds.
|
 
|
start_time |
datetime |
NULL |
: Start time, is the date/time when metric become active. |
 
|
status |
int |
NULL |
status ACTIVE / INACTIVE |
 
|
threshold |
float |
NULL |
The threshold value |
 
|
unittype_id |
int |
NULL |
Unique identity for this unit type |
 
|
user_dependent |
int |
NULL |
  |
 
|
report_interval_unit |
int |
NULL |
This is a code which determines the unit used for the reporting interval.
0=minutes (default)
1=hours
2=days
3=weeks
4=months
5=years
6=Day of month (ie: the 15th day of the month)
|
 
|
schema_id |
int |
NULL |
schema associated with this metric request. |
 
|
server_id |
integer |
NULL |
Unique identifier for one slm server |
 
|
created |
int |
NULL |
Date of creation of metric instance in GMT epoch seconds. Field may be null if metric does not support last modified |
 
|
created_by |
varchar(128) |
NULL |
Identifier for user or other entity (like a script, batch job, workflow) that created the metric instance. To be used as a human readable label. |
 
|
last_modified |
int |
NULL |
Date of last modification of metric instance in GMT epoch seconds. Modification of metric attributes, collector, event_type, event_instance and fields in metric instance it self may cause this to be set. Field is null at creation of metric instance. Field may be null if metric does not support last modified.
|
 
|
last_modified_by |
varchar(128) |
NULL |
Identifier for user or other entity (like a script, batch job, workflow) that last modified the metric instance. To be used as a human readable label.
|
 
|
source_analyze_job_id |
integer |
NULL |
Unique identity for the analyze job |
 
|
source_metric_instance_id |
int |
NULL |
Unique identifier |
 
|
comments |
nvarchar(256) |
NULL |
  |
 
|
analyzed_report_group_id |
int |
NULL |
Unique identity for the report group |
usm_metric_instance_appuser |
This is the list of application users that are tied to a specific metric instance, this list can be used to group by ( application user list) implementation.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
appuser |
varchar(50) |
NULL |
Application username |
 
|
metric_instance_id |
integer |
NULL |
Unique identifier |
usm_metric_resultXXXXX |
The usm_metric_resultXXXXX tables are dynamically created by dcanalyzer when it aggregates events into a meaningful value for this metric. The XXXXX value will be the metric category id for the metrics being aggregated.
This table is added to serve as a prototype for all the dynamic usm_metric_result tables
This was done to enhance the access performance when multiple USM components needed to access the result tables simultaneously.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
sm_start_time |
datetime |
NULL |
The start time for the aggregation report interval period. |
 
|
sm_end_time |
datetime |
NULL |
The end time for the aggregation report interval period. |
 
|
sm_result |
float |
NULL |
The aggregated result value for this report interval. |
 
|
sm_result_status |
int |
NULL |
This show the result of the aggregation. 1=success, 0=failure. A partial failure may occur, and the percentage of inaccurate data will be stored in sm_exclude.
|
 
|
sm_exclude |
integer |
NULL |
The percentage of inaccurate or unknown data which occurred during this report interval. |
 
|
grouped_by |
varchar(256) |
NOT NULL |
When a result is aggregated, and multiple results are generated because of a group by clause, the grouped by value is stored it this field. |
 
|
group_by_type |
int |
NULL |
This is a code, which is use by the aggregation logic to determine which field is to be use when doing the group by clause. |
 
|
metric_instance_id |
int |
NULL |
The metric instance id that is associated with this result. |
 
|
maximum |
float |
NULL |
If the data is reduced, this contain the maximum value of the reduced data. |
 
|
minimum |
float |
NULL |
If the data is reduced, this contains the minimum value of the reduced data. |
 
|
no_of_samples |
integer |
NULL |
No of samples reduced into one. Null if no reduction |
 
|
reduction_level |
integer |
NULL |
Reduction level, 0 and Null means raw data. |
usm_mr_ierror |
Holds the errors occurred during the data mediation process, errors may be either due to upload or importing based |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
type |
int |
NULL |
Type of the error, an error can be due to error in data, or error in import. 0=mr_ifile, 1=mr_import |
 
|
ref_id |
int |
NULL |
reference id to the table mr_iref |
 
|
file_row |
integer |
NULL |
Indicates the row which the error occurred |
 
|
file_col |
integer |
NULL |
Indicates the column where the error occurred |
 
|
status |
integer |
NULL |
Status of the error, listing how critical it is. 0=info, 1=warning, 2=error |
 
|
err_code |
integer |
NULL |
Error code as the result of this error |
 
|
err_text |
varchar(256) |
NULL |
Descriptive error details of the error |
usm_mr_ievent_load |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
import_id |
int |
NULL |
unique ID |
 
|
insert_time |
int |
NULL |
  |
 
|
load_status |
int |
NULL |
  |
 
|
load_from |
datetime |
NULL |
  |
 
|
load_to |
datetime |
NULL |
  |
 
|
file_id |
int |
NULL |
unique ID |
usm_mr_ievent_metric |
This the mapping for event and metric information, place holder as which eventID it mapped to which metricID |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_id |
integer |
NOT NULL |
The event id for the event metric mapping |
 
|
metric_id |
integer |
NOT NULL |
The metric id for the event metic mapping |
usm_mr_ifield |
The fields mapping for the external data for the Data Mediation process |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
field_id |
int |
NOT NULL |
field number (for sorting) |
 
|
table_id |
integer |
NOT NULL |
mr_itable.id |
 
|
pos_1 |
int |
NULL |
file parsing start position |
 
|
pos_2 |
integer |
NULL |
file parsing end position (for fixed-length records only - not used for now) |
 
|
value_type |
integer |
NULL |
0=from file, 1=static value, 2=user-defined value, 3=regular expression, 4=system variable |
 
|
data_format |
nvarchar(32) |
NULL |
data conversion e.g. date format, picture codes (e.g. NN.NN, NNN-NNN-NNN) |
 
|
value |
nvarchar(64) |
NULL |
static/default value |
 
|
ftype_id |
integer |
NULL |
field type |
usm_mr_ifile |
The information for the Imported data file or the external database where the data is fetched from |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
int |
NOT NULL |
unique ID |
 
|
domain |
varchar(50) |
NULL |
domain of user who uploaded file |
 
|
status |
integer |
NULL |
0=uploading, 1=uploaded, 2=checking, 3=error, 4=validated, 5=remove, 6=removing, 7=deleted, 8=incomplete, 9=warning, 10=imported, 11=re-import, 12=archive, 13=archiving, 14=archived |
 
|
upload_date |
date |
NOT NULL |
time when file is uploaded |
 
|
process_date |
date |
NULL |
time when file is imported |
 
|
user_id |
nvarchar(100) |
NULL |
user who uploaded the file |
 
|
proc_id |
varchar(64) |
NULL |
importer engine ID (for future use) |
 
|
server_file |
nvarchar(256) |
NULL |
file name on server |
 
|
client_file |
nvarchar(256) |
NULL |
original file name |
 
|
user_text |
nvarchar(128) |
NULL |
additional comments by user |
 
|
err_code |
integer |
NULL |
error code |
 
|
err_text |
nvarchar(256) |
NULL |
error details |
 
|
source_id |
varchar(32) |
NULL |
icdb id |
 
|
filter |
nvarchar(1024) |
NULL |
content filter on indivdual upload level |
 
|
table_id |
integer |
NULL |
point to mr_itable |
usm_mr_iftype |
Field Type Definition for the fields used in the data mediation process. These are the fields in the system used to map the external data |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
field type id |
 
|
name |
nvarchar(64) |
NULL |
descriptive name |
 
|
field_name |
nvarchar(64) |
NULL |
table field name (used to create temp_XXX schema) |
 
|
to_field |
varchar(64) |
NULL |
field in system: metric_id, value, account_no (for future use) |
 
|
field_type |
integer |
NULL |
field type (0=char, 1=integer, 2=float, 3=date, 4=decimal or numner, 5=double) |
 
|
field_size |
integer |
NULL |
field size (used to create temp_XXX schema) |
 
|
field_decimal |
integer |
NULL |
field decimal size |
 
|
mandatory |
integer |
NULL |
mandatory field? 0=no, 1=server mandatory, 2=client mandatory, 3=both |
 
|
status |
integer |
NULL |
status 0=system (cannot delete), 1=active, 2=inactive |
 
|
check_type |
integer |
NULL |
validation: 0=no check, 1=not empty, 2=range, 3=lookup, 4=lookup and replace |
 
|
value_1 |
nvarchar(64) |
NULL |
range check (check_type=2)/lookup table name (check_type=3/4) |
 
|
value_2 |
nvarchar(64) |
NULL |
range check (check_type=2)/lookup field name (check_type=3/4) |
 
|
value_3 |
nvarchar(64) |
NULL |
replace field name (check_type=4) |
 
|
value_4 |
nvarchar(64) |
NULL |
SQL where (check_type=4) |
usm_mr_imap |
Holds the mapping of holding mandatory fields for different types of profiles. Eg-- For metric information, timestamp, account, value, offering etc are mandatory |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
type |
integer |
NOT NULL |
Type of the mapping 1=mr_iftype.id to mr_itable.file_type |
 
|
mkey |
integer |
NOT NULL |
field type id |
 
|
value |
integer |
NOT NULL |
value of the map |
usm_mr_import |
For each profile, the aggregation import information is defined here. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
int |
NOT NULL |
unique ID |
 
|
domain |
varchar(50) |
NULL |
domain |
 
|
name |
nvarchar(64) |
NULL |
descriptive name |
 
|
table_name |
varchar(32) |
NULL |
event table name |
 
|
status |
integer |
NULL |
process status: 0=pending, 1=processing, 2=processed, 3=error, 4=inactive |
 
|
status_date |
date |
NULL |
last status change |
 
|
priority |
integer |
NULL |
priority |
 
|
import_type |
integer |
NULL |
0=event, 1=mr_result (not used) |
 
|
build_expr |
nvarchar(1024) |
NULL |
sql to populate events/mr_result |
 
|
user_text |
nvarchar(128) |
NULL |
additional comments by user |
 
|
table_id |
integer |
NULL |
mr_itable reference |
 
|
event_id |
int |
NULL |
event id is related to the profile. |
 
|
metric_id |
int |
NULL |
metric id is related to the profile. |
usm_mr_iref |
Import reference table, reference tables are used in conjuction with the the profile data to drive the business logic during aggregation |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
type |
int |
NULL |
0=event, 1=result, 2=file |
 
|
file_id |
integer |
NULL |
file ID |
 
|
ebulk_id |
integer |
NULL |
used to group events data |
 
|
rbulk_id |
integer |
NULL |
used to group results data |
 
|
event_table |
varchar(32) |
NULL |
event table name |
 
|
import_id |
integer |
NULL |
points to mr_import |
 
|
metric_id |
int |
NULL |
metric id which is related to this reference |
usm_mr_isystem |
It holds the information for the data process operational key - last processing ID |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
ID for the system, currently it should be just 0 |
 
|
domain |
varchar(50) |
NULL |
domain for the Data mediation system (not used yet), cross domains are not supported |
 
|
status |
integer |
NULL |
Status for the data mediation system.0=load files only, 1=import only, 2=aggregation, 3=finish!, 4=aggregation error, 5=waiting for billing to finish, 6=aggregating, 7=profiles pending, 8=profile error |
 
|
status_date |
date |
NULL |
date/time when status changed |
 
|
start_date |
date |
NULL |
metric start date/time |
 
|
end_date |
date |
NULL |
metric end date/time |
 
|
min_date |
date |
NULL |
min metric time stamp |
 
|
max_date |
date |
NULL |
max metric time stamp |
 
|
agg_mode |
integer |
NULL |
aggregation mode: 0=use min/max_date, 1=use start/end_date |
 
|
interval |
varchar(16) |
NULL |
metric report interval |
 
|
off_date |
integer |
NULL |
start day of month |
 
|
etable_id |
integer |
NULL |
last event table name ID |
 
|
file_id |
integer |
NULL |
last mr_ifile ID |
 
|
table_id |
integer |
NULL |
last mr_itable ID |
 
|
ftype_id |
integer |
NULL |
last mr_iftype ID |
 
|
import_id |
integer |
NULL |
last mr_import ID |
 
|
group_id |
integer |
NULL |
last group ID |
 
|
proc_id |
integer |
NULL |
last process ID (for future use) |
 
|
ebulk_id |
integer |
NULL |
last event table bulk_id |
 
|
rbulk_id |
integer |
NULL |
last mr_result table bulk_id |
 
|
last_agg_id |
integer |
NULL |
last processed bulk_id |
 
|
file_path |
nvarchar(256) |
NULL |
upload file path (root) |
usm_mr_itable |
Information for the defined profile is stored here |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
unique ID |
 
|
name |
nvarchar(64) |
NULL |
descriptive name |
 
|
match |
varchar(64) |
NULL |
billing group description |
 
|
table_name |
varchar(32) |
NULL |
event_XXX/temp_XXX table name |
 
|
file_type |
integer |
NULL |
input file type: 0=reference file, 1=metric file, 2=assure file |
 
|
file_format |
integer |
NULL |
input file format: 0=csv, 1=fix length, 2=database table import, 3=advanced database import |
 
|
separator |
nvarchar(4) |
NULL |
input file data separator |
 
|
status |
integer |
NULL |
0=ready (simple), 1=pending, 2=ready (complex), 3=inactive |
 
|
load_type |
integer |
NULL |
0=add, 1=delete then add, 2=synchronize |
 
|
key_cols |
varchar(64) |
NULL |
key column numbers in reference table |
 
|
domain |
varchar(50) |
NULL |
domain |
 
|
user_id |
nvarchar(100) |
NULL |
user who create the table |
 
|
filter |
nvarchar(1024) |
NULL |
content filter, i.e. sql query or line number range and etc. |
 
|
src_table |
varchar(64) |
NULL |
the source table name (for database import only) |
 
|
source_id |
varchar(32) |
NULL |
handle to icdb |
usm_mr_itrend |
Aggregated metric trend information, trend is rollup based on a service, account and this data is persisted here to avoid running complex queries to the result tables |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
metric_id |
int |
NOT NULL |
Metric ID |
 
|
service_code |
int |
NOT NULL |
catalog offering id |
 
|
sm_start_time |
date |
NOT NULL |
start metric time |
 
|
sm_end_time |
date |
NOT NULL |
end metric time |
 
|
status |
integer |
NULL |
0=no errors, 1=warning, 2=error |
 
|
row_count |
integer |
NULL |
number of rows created in this aggregation run |
 
|
rollup_value |
float |
NULL |
total value of rows created in this run |
 
|
min_value |
float |
NULL |
minimum aggregation value |
 
|
max_value |
float |
NULL |
maximum aggregation value |
usm_mr_ivalue |
Static values for the fields is stored here for the data that is imported |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
file_id |
int |
NOT NULL |
handle to file_id |
 
|
ftype_id |
integer |
NOT NULL |
handle to ftype_id |
 
|
value |
nvarchar(64) |
NULL |
value |
usm_news |
This is the place holder to transmit any common news messages accross users |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
news_id |
varchar(128) |
NOT NULL |
The unique id for the news record |
 
|
delete_on_expire |
varchar(5) |
NULL |
Flag to purge these records, if this is true then the message will be deleted after it expires |
 
|
description |
nvarchar(126) |
NULL |
The description of the news message |
 
|
tenant_id |
varchar(50) |
NULL |
The domain targeted for the news message, if blank then for all domains |
 
|
expire_time |
integer |
NULL |
The expiration time for this message |
 
|
role_id |
varchar(256) |
NULL |
The targeted role for the message, if blank then all roles |
 
|
importance |
varchar(10) |
NULL |
Specifies the importance of the message, URGENT, HIGH, MEDIUM, LOW, LEAST |
 
|
message |
nvarchar(1000) |
NULL |
The actual broadcasted message |
 
|
message_type |
varchar(50) |
NULL |
The type of the message, INTERNAL, OS, NETWORK, STORAGE |
 
|
source_name |
nvarchar(50) |
NULL |
The source of the message, generally the userid who created the message |
 
|
time_stamp |
date |
NOT NULL |
The message creation time stamp |
 
|
user_name |
nvarchar(128) |
NULL |
The user name of the person who created the message. |
usm_note |
Currently persists only notes for rate items and requests. But can be used to store notes for any object. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
notes_id |
integer |
NOT NULL |
unique id for each note |
 
|
source_type |
integer |
NOT NULL |
the origination of the note. Or an identifier as to where the note came from. –1=none, 0=offerings, 1=rate plans, 2=rate items, 3=subscriptions, 4=billing account |
 
|
source_id |
integer |
NOT NULL |
currently not used. |
 
|
ref_1 |
integer |
NOT NULL |
id of the object the note is posted to |
 
|
ref_2 |
integer |
NOT NULL |
sub-id of the object the note is posted to. Requires that ref_1 has a value |
 
|
ref_3 |
integer |
NOT NULL |
sub-sub-id of the object the note is posted to. Requires that ref_2 has a value |
 
|
type_1 |
integer |
NOT NULL |
type of object specified in ref_1. –1=none, 0=offerings, 1=rate plans, 2=rate items, 3=subscriptions, 4=billing account |
 
|
type_2 |
integer |
NOT NULL |
type of object specified in ref_3. –1=none, 0=offerings, 1=rate plans, 2=rate items, 3=subscriptions, 4=billing account |
 
|
type_3 |
integer |
NOT NULL |
type of object specified in ref_3. –1=none, 0=offerings, 1=rate plans, 2=rate items, 3=subscriptions, 4=billing account |
 
|
status |
integer |
NOT NULL |
currently not used |
 
|
account_label |
nvarchar(128) |
NULL |
account label of the account this note was posted to |
 
|
created_date |
date |
NOT NULL |
date the note was posted or modified |
 
|
note_text |
ntext |
NULL |
note |
 
|
note_type |
int |
NULL |
1=approval notes, 2=fulfillment notes
|
 
|
user_id |
nvarchar(100) |
NULL |
currently note used |
 
|
account_id |
varchar(50) |
NOT NULL |
Account ID which this note belongs to |
 
|
domain |
varchar(50) |
NULL |
Domain to which the notes belong. |
usm_numeric_policy |
Defines the policy used in determining the currency while billing |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
policy_id |
varchar(30) |
NOT NULL |
Unique id. |
 
|
scale |
int |
NULL |
The number of digits to the right of the decimal point. |
 
|
rounding_mode |
int |
NULL |
ROUND_CEILING - Rounding mode to round towards positive infinity.
ROUND_DOWN - Rounding mode to round towards zero.
ROUND_FLOOR - Rounding mode to round towards negative infinity.
ROUND_HALF_DOWN - Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round down.
ROUND_HALF_UP - Rounding mode to round towards "nearest neighbor" unless both neighbors are equidistant, in which case round up.
ROUND_UNNECESSARY - Rounding mode to assert that the requested operation has an exact result, hence no rounding is necessary.
ROUND_UP - Rounding mode to round away from zero.
|
 
|
negative_symbol |
varchar(4) |
NULL |
Negative symbol to be used. |
 
|
display_leading_zeros |
bit |
NULL |
Indication to display leading zeros. |
 
|
type |
int |
NOT NULL |
Type = 1 for quantity based
Type = 2 for currency based
|
 
|
min_scale |
int |
NULL |
minimun scale |
usm_object_wf_instance_ref |
This table is used to store the information linking a USM object (like a request or request item) with a process instance (one-to-many).
Object (like Request/Request Item) - Process Instance Cross Reference
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
object_workflow_instance_id |
int |
NOT NULL |
Unique ID for WF Instance ID |
 
|
object_id1 |
int |
NOT NULL |
like Request ID |
 
|
object_id2 |
int |
NULL |
like Request Item ID |
 
|
process_instance_id |
varchar(256) |
NOT NULL |
related WF Process Instance ID |
 
|
status |
int |
NOT NULL |
workflow process instance status |
 
|
object_type |
integer |
NOT NULL |
1=Request, others to be defined later |
 
|
created_date |
datetime |
NULL |
created date |
 
|
modified_date |
datetime |
NULL |
modified date |
 
|
workflow_type |
integer |
NULL |
  |
usm_offering |
All offerings, offering is a service that can be subscribed to. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
offering_id |
integer |
NOT NULL |
the unique id for each offering. |
 
|
parent_id |
integer |
NOT NULL |
the offering_id of the parent offering, -1 means this offering is the root offering, -2 means there is no parent offering. |
 
|
base_offering |
integer |
NOT NULL |
1=not inherited, other wise points to an offering_id |
 
|
top_base_offering |
integer |
NOT NULL |
1=not inherited, other wise points to an offering_id |
 
|
status |
integer |
NOT NULL |
0=deleted, 1=available, 2=unavailable, 3=created, 4=cancelled |
 
|
date_available |
date |
NULL |
set when status=1 |
 
|
date_unavailable |
date |
NULL |
set when status=2 |
 
|
date_created |
date |
NOT NULL |
set when status=3 |
 
|
date_cancelled |
date |
NULL |
set when status=4 |
 
|
code |
nvarchar(64) |
NULL |
SP/ST supplies code |
 
|
offering_name |
nvarchar(128) |
NOT NULL |
name of the offering |
 
|
description |
nvarchar(512) |
NULL |
description of the offering shown only in the catalog and no where else. |
 
|
info_link |
nvarchar(128) |
NULL |
if it has a value in the form of a URL, a link will show up saying "more..." whenevery viewing the offering through the gui. |
 
|
notes_id |
integer |
NULL |
currently not used. |
 
|
selection_type |
integer |
NULL |
0=none, 1=multiple. Setting this to 1 also allows a check box to appear to subscribe in the gui |
 
|
is_leaf |
integer |
NULL |
0=a node in the offering tree, 1=a leaf in the offering tree (ie: no children) |
 
|
sort_order_type |
integer |
NOT NULL |
0=no sorting, 1=sort by offering_name, 2=by selection_type, 3=by code, 4=by created_date, 5=custom (ie: a sorting number will be added to sort_order_no. |
 
|
sort_order_no |
integer |
NOT NULL |
if sort_order_type=5 then this will have an integer value for the order in the sorted list. |
 
|
sort_order |
integer |
NOT NULL |
0=ascending, 1=descending |
 
|
sub_note_control |
integer |
NULL |
currently not used. |
 
|
image_file |
nvarchar(64) |
NULL |
name of image file to be display when viewing offering. |
 
|
domain |
varchar(50) |
NOT NULL |
Domain to which the offering belongs. |
 
|
approval_process |
int |
NOT NULL |
Indicates the type of approval - No Approval (0), System Approval(1) or WF Driven Approval (2) |
 
|
approval_level |
int |
NULL |
Sets the minimum level of approval required for an offering. OOTB System Approval verifies if a user authorization is greater then or equal to offering approval level before granting approval. If not, approval flows up the management chain. |
 
|
version |
varchar(8) |
NOT NULL |
Version number must be greater then 999. Numbers 0-999 are reserved for CA. |
 
|
type |
int |
NULL |
Indicates if an offering is created using Catalog(type=0) or Accounting (type=1) |
 
|
default_on_approval_status |
int |
NULL |
this holds the default status after offering is approved. The valid values are 1000 for Pending Fulfillment and 2 for Completed. The Default value is set to 2 |
 
|
sd_request_area |
varchar(30) |
NOT NULL |
maps the 'offering/rate plan/rate item' to a Service Desk Request Area |
 
|
path |
varchar(128) |
NOT NULL |
Includes a folder ID path to an offering or a folder separated by a forward slash (/). |
 
|
tree_level |
int |
NULL |
Includes the number of levels from the root folder. |
 
|
feature_sort_order_type |
int |
NOT NULL |
Featured Offerings including under an offering/folder are sorted by name, code, dates and sort number.
(Numerical Value-Sort Order Type)
1 Offering Name
2 Offering Code
3 Offering Created Date
4 Offering Available Date
5 Sort Number
Default value for feature_sort_order_type is set to 1 for sort by offering name.
|
 
|
feature_sort_order |
int |
NOT NULL |
Based on the feature sort type, featured offerings can then be sorted in ascending/descending order.
(Numerical Value-Sort Order Type)
0 Ascending, 1 Descending
Default value for feature_sort_order is set to 0 for sort in ascending order.
|
 
|
date_last_modified |
datetime |
NOT NULL |
To keep a track of when the object (service offering, service option group) was last modified.
This is not nullable. The default value is same as the "date_created" value of the same record.
|
 
|
folder_display_type |
int |
NOT NULL |
Indicates whether this folder displays sub folders in the Browse Catalog section of Request Management. A value of 0 indicates System setting is used, 1 to overide system setting and show folder and 2 for hiding a folder. Note - This value is 0 for offerings and OOTB catalog content to maintain backward compatibility. |
 
|
calendar_id |
varchar(128) |
NULL |
Associated Outage Calendar ID for offering |
 
|
business_hour_id |
varchar(128) |
NULL |
Associated Business Hour ID for offering |
usm_offering_ratedef_inclusion |
Persists the inclusion relation between offerings and the rate plan rows. After a rate_plans object is included into an offering, the user selects which rows are visible and selected by default. This table stores that relationship. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
Unique id for this inclusion relationship |
 
|
parent_id |
integer |
NULL |
the unique id for each offering. |
 
|
rate_plan_id |
int |
NULL |
the unique id for each rate plan |
 
|
child_id |
integer |
NULL |
the unique id for each rate item |
 
|
base_id |
integer |
NOT NULL |
the offering_id of the base offering of the offering pointed to by parent_id |
 
|
selection |
int |
NULL |
1=this rate item is selected to be the default when viewing or subscribing to the offering, 0=is not the default |
 
|
approval_level |
int |
NULL |
0=no approval required, 1=one level of managerial approval, 2=two levels of managerial approval |
 
|
approval_process |
int |
NULL |
0=no approval process, 1=system, 2=workflow
|
usm_offering_rplan_inclusion |
Persists the inclusion relation between offerings and rate plans. For every rate plan included into an offering a record is created in this table.
This table is renamed to usm_offering_rateplan_inclusion from usm_offering_rateplans_inclusion as the table name is too long
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
int |
NOT NULL |
unique id for offerings_rateplans_inclusion |
 
|
base_id |
integer |
NOT NULL |
the offering_id of the base offering of the offering pointed to by parent_id |
 
|
parent_id |
integer |
NULL |
the offering_id. |
 
|
child_id |
integer |
NULL |
the rate_plans_id of the included rate plan |
usm_offering_sla |
This table associates an SLA with a rate row defined under an offering. Since the same rate row can exist in multiple offerings, the SLA is set at the offering level. This allows a rate row that exists in multiple offerings to have different SLAs for each offering. Users can specify how long it should take for a request containing a particular rate row to go from one status to the next. Out-of-box reports allow users to see which requests have violated the SLA (taken longer than specified). |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
offering_sla_def_id |
varchar(128) |
NOT NULL |
offering sla defintion unique id |
 
|
offering_id |
integer |
NULL |
the unique id for each offering. |
 
|
item_id |
integer |
NULL |
the unique id for each rate item |
 
|
start_status |
int |
NOT NULL |
If an SLA has been set up for this Rate Row, this value stores the start status for a status range to be monitored. |
 
|
end_status |
int |
NOT NULL |
If an SLA has been set up for this Rate Row, this value stores the end status for a status range to be monitored. |
 
|
wrn_millis |
bigint |
NOT NULL |
If an SLA has been set up for this Rate Row and this particular status range then this column shows the SLA warning time set up in the ‘Define SLA’ screen. Warning time must be less then Violation time. |
 
|
vio_millis |
bigint |
NOT NULL |
If an SLA has been set up for this Rate Row and this particular status range then this column shows the SLA violation time set up in the ‘Define SLA’ screen. |
 
|
is_option_decision_sla |
integer |
NOT NULL |
flag for service option level decision making sla: If the multiple request status monitoring SLAs are defined for one service option, then this flagged sla will be used whether the option level monitor value is good or bad. |
 
|
is_active |
integer |
NOT NULL |
active/inactive |
 
|
sla_def_name |
nvarchar(256) |
NULL |
sla definition descriptive name |
 
|
sla_expectation_level |
integer |
NULL |
sla expectation level |
 
|
created_date |
datetime |
NULL |
created timestamp |
 
|
last_modified_date |
datetime |
NULL |
last modified date |
usm_offering_sla_history |
History table which stores version history of offering sla definition.
When offering sla definition need to be changed, current sla definition will be stored as old version with user’s provided comment. usm_offering_sla_history_link table is relationship between usm_offering_sla (definition) and usm_offering_sla_history table.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
sla_history_id |
varchar(128) |
NOT NULL |
sla defintion version history unique id |
 
|
sla_definition_status |
integer |
NOT NULL |
1=available, 2=unavailable, 3=closed |
 
|
created_date |
datetime |
NOT NULL |
created date of sla definition |
 
|
effective_date |
datetime |
NULL |
effective date of sla definition |
 
|
closed_date |
datetime |
NULL |
closed date of sla definition version |
 
|
sla_version_comment |
nvarchar(1024) |
NULL |
description of reasoning to close sla definition version |
 
|
user_id |
nvarchar(128) |
NULL |
user who closed the sla definition version |
usm_offering_sla_history_link |
History table which stores version history of offering sla definition.
When offering sla definition need to be changed, current sla definition will be stored as old version with user’s provided comment. usm_offering_sla_history_link table is relationship between usm_offering_sla (definition) and usm_offering_sla_history table.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
sla_history_id |
varchar(128) |
NOT NULL |
sla defintion version history unique id |
 
|
offering_sla_def_id |
varchar(128) |
NOT NULL |
offering sla defintion unique id |
usm_onetime_event |
A one-time event describes a event that is not recurring. I.e it happens only once and has a fixed start and end time.
A one-time event may be related to a recurring event. If so, it is used to override an recurring occurrence for the recurring event in cases where an occurrence is updated or deleted.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
onetime_event_oid |
varchar(20) |
NOT NULL |
Unique identity of the one-time event |
 
|
start |
integer |
NOT NULL |
Start time in epoch for the one time event |
 
|
duration |
integer |
NULL |
Durations, in seconds for the one time event |
 
|
description |
nvarchar(255) |
NULL |
Textual description of the event |
 
|
status |
c(1) |
NULL |
Status, 'D' - deleted, 'A' or null = active |
 
|
value |
nvarchar(255) |
NULL |
value of the event |
 
|
calendar_oid |
varchar(256) |
NULL |
The calendar to which this event belongs. |
 
|
event_category_oid |
varchar(256) |
NULL |
The event category to which this event belongs |
 
|
recurring_event_oid |
varchar(20) |
NULL |
A onetime event can be used to remove or add occurrences to a recurring event by pointing to the recurring event here. |
 
|
event_category_value_oid |
varchar(20) |
NULL |
The event category value selected. May be null. |
 
|
start_time |
integer |
NULL |
Start Time |
usm_pattern_type |
A pattern type describes one type of pattern supporting recurring events. A separate java class is specified that actually implements the pattern parsing.
The pattern type is related to a set of recurring events that uses this pattern type.
In r11, only crontab type of patterns are supported.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
pattern_type_oid |
varchar(20) |
NOT NULL |
Unique identity of the pattern type |
 
|
bundle_key |
varchar(255) |
NULL |
Bundle key used to retrieve the pattern description in i18n |
 
|
scheduler_class |
varchar(255) |
NULL |
Fully qualified java class implementing the scheduler for this pattern type. |
 
|
create_action |
varchar(100) |
NULL |
Not used in r11 |
 
|
update_action |
varchar(100) |
NULL |
Not used in r11 |
usm_payment_method |
Store all the detailed payment information here. The primary key for these objects are account_no and id. The id is calculated from billing_account.last_payment_id
the values for the overloaded fields for the payment types supplied out-of-the-box. Users can created there own payment plugins and override the meanings of these fields.
When type_1=CreditCard
" type_2: 0=VISA, 1=MasterCard, 2=AMEX
" text_1: issued by, ex: Citibank
" text_2: card number
" date_1: expiration date
When type_1=Check
" text_1: check number
" text_2: routing number
" text_3: account_number
" date_1: check date
When type_1=Cash
no fields overloaded for cash
When type_1=Direct
" text_1: institution number
" text_2: routing number
When type_1=PrePay
" numeric_1: deposited amount
" numeric_2: applied amount
" date_1: prepayment date
When type_1=Coupon
" text_1: coupon number
" date_1: expiration date
When type_1=Tip
" type_2: tip type, ex: normal, holiday, etc.
" text_1: tip to who
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
account_no |
varchar(50) |
NOT NULL |
The account to which payment has been made. |
 
|
id |
integer |
NOT NULL |
Incremented integer associated to each payment. |
 
|
domain |
varchar(50) |
NOT NULL |
This is the tenant ID of the account |
 
|
parent_domain |
varchar(50) |
NOT NULL |
This is the parent tenant ID, the value of this field is always either a Supert Tenant, Service Provider, or empty in the case when domain is the value of the Service Provider. |
 
|
status |
integer |
NOT NULL |
1=deleted, 0=inactive, 1=active, 2=opened, 3=closed |
 
|
type_1 |
varchar(50) |
NOT NULL |
payment plugin id, ex: Check, CreditCard, etc. |
 
|
type_2 |
integer |
NULL |
additionaly distiguisher between payment types, ex: when type_1=CreditCard then type_2 could be AMEX, VISA, etc. In other words, this value is overloaded depending on the value of type_1. |
 
|
p_name |
nvarchar(50) |
NULL |
Payer's name. |
 
|
p_title |
nvarchar(50) |
NULL |
Payer's title. |
 
|
p_address1 |
nvarchar(50) |
NULL |
Payer's address 1. |
 
|
p_address2 |
nvarchar(50) |
NULL |
Payer's address 2. |
 
|
p_city |
nvarchar(50) |
NULL |
Payer's city. |
 
|
p_state |
nvarchar(50) |
NULL |
Payer's state. |
 
|
p_zip |
nvarchar(50) |
NULL |
Payer's zip. |
 
|
p_country |
nvarchar(50) |
NULL |
Payer's country. |
 
|
p_tel |
nvarchar(50) |
NULL |
Payer's telephone number. |
 
|
p_fax |
nvarchar(50) |
NULL |
Payer's fax number. |
 
|
p_email |
nvarchar(50) |
NULL |
Payer's email address. |
 
|
opened_date |
date |
NOT NULL |
Date of payment. |
 
|
closed_date |
date |
NULL |
Date of completed payment. |
 
|
active_date |
date |
NULL |
Currently not used. |
 
|
inactive_date |
date |
NULL |
Currently not used. |
 
|
enum_1 |
integer |
NULL |
overloaded depending on the value of type_1. Currenly no payment plugins provided out of the box uses this field, but exists for user plugins. |
 
|
text_1 |
nvarchar(50) |
NULL |
overloaded depending on the value of type_1. ex: when type_1=Check then text_1 is check number |
 
|
text_2 |
nvarchar(50) |
NULL |
overloaded depending on the value of type_1. ex: when type_1=Check then text_2 is the routing number |
 
|
text_3 |
nvarchar(50) |
NULL |
overloaded depending on the value of type_1. ex: when type_1=Check then text_3 is the account number |
 
|
numeric_1 |
float |
NULL |
overloaded depending on the value of type_1. ex: when type_1=PrePay then numeric_1 is the deposited amount |
 
|
numeric_2 |
float |
NULL |
overloaded depending on the value of type_1. ex: when type_1=PrePay then numeric_2 is the applied amount |
 
|
date_1 |
date |
NULL |
overloaded depending on the value of type_1. ex: when type_1=Check then date_1 is the date on the check |
usm_plan |
usm_plan contains information relating to a plan item.
This table is deprecated. ( We are not using this table from R11.0)*
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
pd_id |
int |
NOT NULL |
Unique id for plan definition. |
 
|
id |
int |
NOT NULL |
Unique Plan ID |
 
|
src_type |
nvarchar(64) |
NULL |
Source type. |
 
|
text_1 |
nvarchar(128) |
NULL |
Display text. |
 
|
enum_1 |
integer |
NULL |
Rate item id. |
 
|
enum_2 |
integer |
NULL |
  |
 
|
enum_3 |
integer |
NULL |
  |
 
|
numeric_1 |
float |
NULL |
Value associated with the plan. |
usm_plan_data |
This table holds the plan data for set/cost_pool/fiscal_periods combinations. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
fp_id |
int |
NOT NULL |
Unique id for fiscal period. |
 
|
ps_id |
int |
NOT NULL |
Unique id for plan set. |
 
|
cp_id |
integer |
NOT NULL |
Unique id for cost pool. |
 
|
item_id |
int |
NOT NULL |
FK to usm_offering_ratedef_inclusion |
 
|
type |
integer |
NOT NULL |
Used in determining if item is direct cost or a cost element within a cost pool. |
 
|
domain |
varchar(50) |
NOT NULL |
The unique tenantid that identifies this organization/tenant |
 
|
numeric_1 |
float |
NULL |
Value associated to the plan item. |
usm_plan_def |
usm_plan_def contains information relating to a plans definition grouping. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
pd_id |
int |
NOT NULL |
Unique id for plan definition. |
 
|
lvl |
int |
NOT NULL |
Level of granularity. |
 
|
lvl_type |
integer |
NOT NULL |
Level type: Catalog, Account, Catalog by Account |
 
|
year |
integer |
NOT NULL |
Fiscal year. |
 
|
period |
integer |
NOT NULL |
Period type: monthly, quarterly, yearly |
 
|
start_date |
date |
NOT NULL |
Period start date. |
 
|
end_date |
date |
NOT NULL |
Period end date. |
 
|
set_code |
nvarchar(50) |
NOT NULL |
Set code associated with the definition. |
 
|
activity |
integer |
NOT NULL |
Activity associated with the definition. |
 
|
domain |
varchar(50) |
NULL |
The domain to which the definition belongs. |
usm_plan_set |
Logical groupings of related financial quantities used in the budget and planning process.
This table is deprecated. ( We are not using this table from R11.0)*
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
set_domain |
varchar(50) |
NOT NULL |
  |
 
|
set_code |
varchar(50) |
NOT NULL |
  |
 
|
name |
nvarchar(64) |
NULL |
  |
 
|
status |
int |
NULL |
  |
 
|
activity |
nvarchar(8) |
NULL |
  |
 
|
src_type |
nvarchar(256) |
NULL |
  |
 
|
description |
nvarchar(512) |
NULL |
Description of the plan set |
usm_planning_set |
Logical groupings of related financial quantities used in the budget and planning process. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
ps_id |
int |
NOT NULL |
Unique id. |
 
|
domain |
varchar(50) |
NULL |
Domain to which the set belongs. |
 
|
name |
nvarchar(64) |
NOT NULL |
Display name associated to the set. |
 
|
status |
integer |
NOT NULL |
Specifies if plan data could be modified.
0=Locked
1=Unlocked
|
 
|
source |
integer |
NULL |
Determines where to draw data. |
 
|
description |
nvarchar(128) |
NULL |
Set's description field. |
 
|
code |
nvarchar(64) |
NOT NULL |
This column is not used |
usm_plugin |
Defines a plugin for driving the content in iCanView |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
plugin_id |
varchar(50) |
NOT NULL |
The unique id for the plugin |
 
|
class |
varchar(256) |
NULL |
The java class implementation for this plugin |
 
|
display_name |
varchar(64) |
NULL |
The readable name of the plugin |
 
|
persistent |
int |
NULL |
If this plugin is to be persisted in memory or loaded/unloaded each time; 1 - persit; 0 - don’t persist |
 
|
uuid |
varchar(20) |
NULL |
The unique identifier for this plugin |
 
|
static |
int |
NULL |
Flag specifies if the implementation is static |
 
|
load_on_startup |
int |
NULL |
Flag to specify if the plugin is to be loaded on system startup |
 
|
installed_subcomponent_id |
varchar(50) |
NULL |
Handle to the installed subcomponent for this plugin |
usm_plugin_type |
Defines the grouping of plugin’s based on the type |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
plugin_type_id |
varchar(50) |
NOT NULL |
The unique id for the plugin type |
 
|
uuid |
varchar(20) |
NULL |
The unique identifier for this plugin |
 
|
installed_subcomponent_id |
varchar(50) |
NULL |
The unique id for the installed sub component |
usm_policy_entities |
This table is to store the policies created in Policy Builder
The scope of this feature is to allow service designer the ability to dynamically assign pending actions based using a policy. Currently service builders have to create a service specific workflow if they want to do multi level
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
policy_id |
varchar(128) |
NOT NULL |
Unique ID of the policy |
 
|
policy_name |
nvarchar(512) |
NOT NULL |
Name of the policy |
 
|
policy_description |
nvarchar(2048) |
NOT NULL |
Description of the Policy |
 
|
policy_entity_type |
int |
NOT NULL |
Integer value for identifying the type of policy this is. 1 = Policy Folder, 2 = General Policy, 3 = Approval Policy |
 
|
tenant_id |
varchar(50) |
NOT NULL |
tenant_id of the tenant in the usm_tenant table to which this policy belongs. |
 
|
policy_parent_id |
varchar(128) |
NOT NULL |
The id of the policy entity that is the parent of this policy. The parent will be a policy that will be of the type Folder. |
 
|
policy_condition |
ntext |
NOT NULL |
The condition of the policy. For policies of type Folder, this will be set to 'false'. |
 
|
created_by |
binary(16) |
NOT NULL |
The contact_uuid from the ca_contact table of the user who created this policy. |
 
|
created |
datetime |
NOT NULL |
The date and time when this policy was created. |
 
|
last_modified_by |
binary(16) |
NOT NULL |
The contact_uuid from the ca_contact table of the user who last modified this policy. |
 
|
last_modified |
datetime |
NOT NULL |
The date and time when this policy was last modified. |
 
|
is_system |
int |
NOT NULL |
Value identifying if this is a system policy or not. 1 = True = System Policy, 0 = False = Not a system policy. (default is set to 0) |
 
|
policy_version |
int |
NULL |
Version of the policy record |
 
|
policy_priority |
int |
NOT NULL |
Value indicating the priority of this policy. 1000 = high priority, 1 = low priority. default 1000-default(default/system) |
 
|
policy_status |
int |
NOT NULL |
Value indicating the status of this policy. 0 = active, 1 = inactive, 2 = deleted. default 0-active(active/inactive/delete) |
 
|
policy_action |
ntext |
NOT NULL |
Serialized object representing the policy action for this policy. For policies of type Folder, the policy action will be the serialized object of the type NoOpPolicyAction. data type set to xml(sql server)/clob(oracle) |
usm_portal_content |
Defines the content for portal object. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
portal_content_id |
varchar(50) |
NOT NULL |
The unique id for the portal content |
 
|
title |
varchar(64) |
NULL |
The descriptive title for the portal content |
 
|
stylesheet_url |
varchar(64) |
NULL |
Relative location for the stylesheet |
 
|
refresh_time |
int |
NULL |
Refresh time in seconds |
 
|
full_size |
int |
NULL |
Flag indicating if the window should be opened in full screen |
 
|
x |
int |
NULL |
The x coordinate for the new window left top corner |
 
|
y |
int |
NULL |
The y coordinate for the new window left top corner |
 
|
width |
int |
NULL |
width of the new window if opened |
 
|
height |
int |
NULL |
height of the new window if opened |
 
|
row |
int |
NULL |
Row of the content
This Column is not used
|
 
|
col |
int |
NULL |
Column of the content |
 
|
separate_window |
int |
NULL |
0, 1; Specifies if a new window is to be opened to display the content |
 
|
portal_template_id |
varchar(50) |
NULL |
Handle to portal tempalte |
 
|
dash_id |
varchar(64) |
NULL |
Handle to the dash board |
 
|
is_label |
bit |
NULL |
The label for the portal content |
 
|
new_window |
int |
NULL |
New window is a flag to open a new window |
 
|
params |
varchar(64) |
NULL |
Specifies additional parameters |
 
|
is_hidden |
int |
NULL |
Specifies if the content is hidden or to be shown |
 
|
data1 |
varchar(64) |
NULL |
for integration |
 
|
data2 |
varchar(64) |
NULL |
for integration |
 
|
data3 |
varchar(64) |
NULL |
for integration |
 
|
resize |
int |
NULL |
Flag to specify if resizing is allowed |
 
|
irow |
int |
NULL |
When the Auto-Arrange is checked in dashboard options, specifies the initial row where to be positioned. |
usm_portal_template |
Defines the template library for portal management |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
portal_template_id |
varchar(50) |
NOT NULL |
Portal Library Unique ID |
 
|
portal_template_parent_id |
varchar(50) |
NULL |
Parent portal ID |
 
|
name |
varchar(64) |
NULL |
template name |
 
|
description |
varchar(128) |
NULL |
template description |
 
|
is_system |
int |
NULL |
Specifies if this is a system specific entity |
 
|
content_type |
int |
NULL |
plugin method type |
 
|
content_url |
varchar(256) |
NULL |
The url for the content display |
 
|
embedded_content |
ntext |
NULL |
embedded content if it is used |
 
|
criteria |
varchar(64) |
NULL |
The special criteria for the portal template |
 
|
parse_content |
int |
NULL |
Flag to indicate if parsing is required |
 
|
tag_name |
varchar(64) |
NULL |
The tag name for displaying the content |
 
|
xsl_url |
varchar(256) |
NULL |
The relative location for the XSL |
 
|
guinode_id |
varchar(128) |
NULL |
related Guinode ID |
 
|
params |
varchar(64) |
NULL |
arguments which will be passed |
 
|
embedded_xsl |
ntext |
NULL |
embedded xsl code |
 
|
status |
int |
NULL |
status of the template, Eg: 1 |
 
|
expire_date |
datetime |
NULL |
expiration date |
 
|
created_date |
datetime |
NOT NULL |
creation date |
 
|
modified_date |
datetime |
NULL |
modified date |
 
|
user_id |
varchar(50) |
NULL |
User who created the template |
 
|
icon_used |
varchar(256) |
NULL |
used icon name and location |
 
|
keywords |
varchar(64) |
NULL |
keywords for the portal template |
 
|
tenant_id |
varchar(50) |
NULL |
Tenant ID is related to the template |
 
|
parent_tenant_id |
varchar(50) |
NULL |
parent tenant ID is related to the tenant |
 
|
asset_id |
varchar(50) |
NULL |
handle to the usm_asset |
 
|
file_name |
varchar(64) |
NULL |
The file name for the portal template |
 
|
authentication_url |
varchar(256) |
NULL |
The url for the external authentication |
 
|
credentials |
ntext |
NULL |
Any credentials/password that is required to display the contents |
 
|
label |
int |
NULL |
label for the template |
 
|
new_window |
int |
NULL |
If a new window needs to be opened to show the contents |
 
|
data1 |
varchar(64) |
NULL |
for integration |
 
|
data2 |
varchar(64) |
NULL |
for integration |
 
|
data3 |
varchar(64) |
NULL |
for integration |
usm_pwd_policy |
Defines a password policy which is enforced on the users logging in |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
pwd_policy_id |
varchar(50) |
NOT NULL |
The unique identifier for the password policy |
 
|
lockout_time |
int |
NULL |
The unlock time in Seconds after the user is locked |
 
|
incorrect_pwd_count |
int |
NULL |
The maximum number of incorrect passwords before the account should be locked |
 
|
first_time_change |
int |
NULL |
Flag indicating if the user have to change the password on first login |
 
|
pwd_expire_days |
int |
NULL |
The number of days after which the password expires |
 
|
pwd_history_count |
int |
NULL |
The number of last old passwords, that cannot be repeated |
 
|
pwd_syntax |
varchar(20) |
NULL |
The perl based syntax to verify the password requirements, Too short, upper and lower comibnation etc |
 
|
description |
varchar(128) |
NULL |
The description of the password policy |
 
|
name |
varchar(64) |
NULL |
The readable name for the policy |
usm_queue_item |
Queue item is used for inter process distributed communitcation, a request is posted to the queue_item and it is picked up by the any of the distributed servers. Eg: When a bill run is scheduled using the UI, a queue_item is posted, and any of the billing services can pick this up and handle it on the FCFS basis. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
queue_item_id |
integer |
NOT NULL |
The unique id for the queue item |
 
|
created_time |
date |
NOT NULL |
created time stamp for this item |
 
|
priority_no |
integer |
NOT NULL |
Priority for the item |
 
|
status |
integer |
NOT NULL |
status of the item:
ST_INACTIVE = 0, ST_ACTIVE = 1, ST_PROCESSING = 2, ST_PROCESSED_OK = 3, ST_PROCESSED_ERROR = 4
|
 
|
type |
varchar(50) |
NOT NULL |
type of queue item
|
 
|
queue_item_name |
nvarchar(50) |
NOT NULL |
name of this component |
 
|
group_id |
varchar(256) |
NOT NULL |
group id for a queue item |
 
|
owner |
nvarchar(128) |
NULL |
owner id |
 
|
start_time |
date |
NULL |
start time |
 
|
end_time |
date |
NULL |
end time |
 
|
delete_item |
integer |
NOT NULL |
delete flag for the queue item |
 
|
deleted_time |
date |
NULL |
deleted time |
 
|
item_comment |
nvarchar(128) |
NULL |
descriptive comments |
 
|
data1 |
nvarchar(512) |
NULL |
information field for processing the queue item |
 
|
data2 |
nvarchar(512) |
NULL |
information field for processing the queue item |
 
|
data3 |
nvarchar(128) |
NULL |
information field for processing the queue item |
usm_queue_item_detail |
Details for each queue_item are added here. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
queue_item_detail_id |
int |
NOT NULL |
Unique ID- detailed description of the queue item
|
 
|
queue_item_id |
integer |
NOT NULL |
Related Queue Item ID |
 
|
created_time |
date |
NOT NULL |
Created Time |
 
|
status |
integer |
NOT NULL |
Status of the queue item detail |
 
|
status_time |
date |
NULL |
status time |
 
|
guinode_id |
varchar(50) |
NULL |
related Guinode ID |
 
|
label |
nvarchar(50) |
NULL |
label of the queue item detail
|
 
|
details1 |
nvarchar(4000) |
NULL |
detailed description
|
 
|
details2 |
nvarchar(256) |
NULL |
detailed description |
 
|
details3 |
nvarchar(256) |
NULL |
detailed description |
 
|
details4 |
nvarchar(256) |
NULL |
detailed description |
 
|
details5 |
nvarchar(4000) |
NULL |
detailed description |
 
|
owner |
nvarchar(128) |
NULL |
related owner |
usm_rate_def_ext |
This table is for supporting extra key value (Contractual metrics, incentive metrics) for usm_rate_defination. Table to store Contractual metrics and incentive metrics as key value pair
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
binary(16) |
NOT NULL |
Auto generated unique ID |
 
|
item_id |
integer |
NULL |
the unique id for each rate item. item_id that referes to item_id in usm_rate_defination |
 
|
ext_key |
varchar(128) |
NULL |
Oblicore integration item |
 
|
ext_value |
nvarchar(512) |
NULL |
Value of Oblicore integration item |
usm_rate_definition |
Rate items -
This table is perhaps the most complicated of them all. In addition to the number of rate items that are provided, and the fact that new ones can be added as plugins, but many of the rate items share certain properties, and many of the overloaded fields are used to keep the meaning consistent for related rate items. Programmatically this allows for an inherited structure of objects.
Chargeable rate items:
There is no rate item called Chargeable, however, rate items that have similar properties and extend from this set of overloaded fields and maintain there meaning:
Chargeable rate items are: Rate, Application, Agreement, Adjustment
The fields and there meanings are:
" enum_1 = billing_cycle, 0=onetime, 1=installments , 2=periodic, 3=na
" enum_2 = periodic type, -1=na, 0=daily, 1=weekly, 2=monthly
" enum_3 = number of installments
" enum_4 = charge type, 0=credit, 1=debit
" enum_9 = cost type, 1=sp/st specify, 3=user specified
" enum_10 = periodic type interval
" text_1 = unit type
" text_4 = unit cost text
" numeric_1 = unit cost
Chargeable Associated rate items:
Similarly, there is no rate item called Chargeable, however, rate items that have similar properties and extend from this set of overloaded fields and maintain there meaning. What is significant about this set is that ChargeableAssociated rate item also extend from Chargeable rate items.
Chargeable Associated rate items are: Application, Agreement
The fields and there meanings are:
" enum_5 = 1 means rate item is associated to a rate plan, 0 is not
" enum_6 = tier type, -1=na, 0=lookup, 1=lookup multiple, 2=fixed, 3=fixed incremental, 4=fixed decremental, 5=fixed incremental/decremental, 6=variable lookup, 7=variable fixed, 8=variable fixed incremental, 9=variable fixed decremental, 10=variable fixed incremental/decremental
Associated rate items:
Similarly, there is no rate item called Associated, however, rate items that have similar properties and extend from this set of overloaded fields and maintain there meaning:
Associated rate items are: Numeric, Boolean, Date
The fields and there meanings are:
" enum_5 = 1 means rate item is associated to a rate plan, 0 is not
" enum_6 = tier type, -1=na, 0=lookup, 1=lookup multiple, 2=fixed, 3=fixed incremental, 4=fixed decremental, 5=fixed incremental/decremental, 6=variable lookup, 7=variable fixed, 8=variable fixed incremental, 9=variable fixed decremental, 10=variable fixed incremental/decremental
Range rate items:
Similarly there is no rate item called Range, however, rate items that have similar properties and extend from this set of overloaded fields and maintain there meaning:
Range rate items are: Numeric Range, Date Range
The fields and there meanings are:
" enum_1 = 1 is infinite upper bound, 0 is not.
The following list is a compilation of all the fields used for each type of rate item:
When item_type = 0 (text rate item)
" text_1 = textual value
When item_type = 1 (header rate item)
does not use overloaded fields
When item_type = 2 (numeric range rate item)
" enum_1 = 1 is infinite upper bound, 0 is not.
" numeric_1 = lower bound
" numeric_2 = upper bound
When item_type = 3 (rate rate item)
" enum_1 = billing_cycle, 0=onetime, 1=installments , 2=periodic, 3=na
" enum_2 = periodic type, -1=na, 0=daily, 1=weekly, 2=monthly
" enum_3 = number of installments
" enum_4 = charge type, 0=credit, 1=debit
" enum_5 = quantity type, 0=flat rate, 1=specify, 2=admin lookup, 3=user specified, 4=system passes, 5=user lookup
" enum_6 = rate item id for quantity if a lookup is being made to another rate item for the quantity
" enum_7 = 1 means show quantity on the invoice, 0 means dont
" enum_8 = offering id for quantity. This is needed in cunjunction with enum_6 because a rate plan can be included in more then one offering and therefore is necessary to not only know the rate item but which offering.
" enum_9 = cost type, 0=sp/st specify, 1=user specified
" enum_10 = periodic type interval
" text_1 = unit type
" text_4 = unit cost text
" numeric_1 = unit cost
" numeric_2 = quantity
When item_type = 4 (application rate item)
" enum_1 = billing_cycle, 0=onetime, 1=installments , 2=periodic, 3=na
" enum_2 = periodic type, -1=na, 0=daily, 1=weekly, 2=monthly
" enum_3 = number of installments
" enum_4 = charge type, 0=credit, 1=debit
" enum_5 = pricing structure, 0=subscription, 1=tiered, 2=usage based
" enum_6 = tier type, -1=na, 0=lookup, 1=lookup multiple, 2=fixed, 3=fixed incremental, 4=fixed decremental, 5=fixed incremental/decremental, 6=variable lookup, 7=variable fixed, 8=variable fixed incremental, 9=variable fixed decremental, 10=variable fixed incremental/decremental
" enum_7 = 1 is show mteric result on invoice, 0 is dont
" enum_9 = cost type, 1=sp/st specify, 3=user specified
" enum_10 = periodic type interval
" text_1 = unit type
" text_2 = application id
" text_3 = metric id
" text_4 = unit cost text
" numeric_1 = unit cost
When item_type = 5 ( agreement rate item)
" enum_1 = billing_cycle, 0=onetime, 1=installments , 2=periodic, 3=na
" enum_2 = periodic type, -1=na, 0=daily, 1=weekly, 2=monthly
" enum_3 = number of installments
" enum_4 = charge type, 0=credit, 1=debit
" enum_5 = 1 means rate item is associated to a rate plan, 0 is not
" enum_6 = tier type, -1=na, 0=lookup, 1=lookup multiple, 2=fixed, 3=fixed incremental, 4=fixed decremental, 5=fixed incremental/decremental, 6=variable lookup, 7=variable fixed, 8=variable fixed incremental, 9=variable fixed decremental, 10=variable fixed incremental/decremental
" enum_7 = 1 is charge for sla, 0 is dont
" enum_9 = cost type, 0=sp/st specify, 1=user specified
" enum_10 = periodic type interval
" text_1 = unit type
" text_2 = agreement id
" text_4 = unit cost text
" numeric_1 = unit cost
When item_type = 6 (numeric rate item)
" enum_1 = quantity type, 0=flat rate, 1=specify, 2=admin lookup, 3=user specified, 4=system passes, 5=user lookup
" enum_5 = 1 means rate item is associated to a rate plan, 0 is not
" enum_6 = tier type, -1=na, 0=lookup, 1=lookup multiple, 2=fixed, 3=fixed incremental, 4=fixed decremental, 5=fixed incremental/decremental, 6=variable lookup, 7=variable fixed, 8=variable fixed incremental, 9=variable fixed decremental, 10=variable fixed incremental/decremental
" numeric_1 = numeric value
" enum_7 = 1 is show quantity on invoice, 0 is dont
When item_type = 7 (boolean rate item)
" enum_3 = the boolean value, 0 = false, 1 = true
" enum_5 = 1 means rate item is associated to a rate plan, 0 is not
" enum_6 = tier type, -1=na, 0=lookup, 1=lookup multiple, 2=fixed, 3=fixed incremental, 4=fixed decremental, 5=fixed incremental/decremental, 6=variable lookup, 7=variable fixed, 8=variable fixed incremental, 9=variable fixed decremental, 10=variable fixed incremental/decremental
When item_type = 8 (adjustment rate item)
" enum_1 = billing_cycle, 0=onetime, 1=installments , 2=periodic, 3=na
" enum_2 = periodic type, -1=na, 0=daily, 1=weekly, 2=monthly
" enum_3 = number of installments
" enum_4 = charge type, 0=credit, 1=debit
" enum_5 = 1 means rate item is associated to a rate plan, 0 is not
" enum_6 = pointer to the rate item that this adjustment will be applied to
" enum_7 = adjustment type, 0=applied amount, 1=multiplier, 2=limit applied amount
" numeric_2 = adjusment value
" enum_8 = pointer to the offering that contains the rate item being adjusted. This is needed in cunjunction with enum_6 because a rate plan can be included in more then one offering and therefore is necessary to not only know the rate item but which offering.
" enum_9 = cost type, 0=sp/st specify, 1=user specified
" enum_10 = periodic type interval
" text_1 = unit type
" text_4 = unit cost text
" numeric_1 = unit cost
When item_type = 9 (date rate item)
" enum_1 = date type, 0=specify, 1=subscription date, 2=invoice date
" enum_5 = 1 means rate item is associated to a rate plan, 0 is not
" enum_6 = tier type, -1=na, 0=lookup, 1=lookup multiple, 2=fixed, 3=fixed incremental, 4=fixed decremental, 5=fixed incremental/decremental, 6=variable lookup, 7=variable fixed, 8=variable fixed incremental, 9=variable fixed decremental, 10=variable fixed incremental/decremental
" text_1 = the date value
When item_type = 10 (date range rate item)
" enum_1 = 1 is infinite upper bound, 0 is not.
" text_1 = lower bound date
" text_2 = upper bound date
When item_type = 11 (day rate item)
" enum_1 = billing_cycle, 0=onetime, 1=installments , 2=periodic, 3=na
" enum_2 = periodic type, -1=na, 0=daily, 1=weekly, 2=monthly
" enum_3 = number of installments
" enum_4 = charge type, 0=credit, 1=debit
" enum_5 = quantity type, 0=flat rate, 1=specify, 2=admin lookup, 3=user specified, 4=system passes, 5=user lookup
" enum_6 = rate item id for quantity if a lookup is being made to another rate item for the quantity
" enum_7 = 1 means show quantity on the invoice, 0 means dont
" enum_8 = offering id for quantity. This is needed in conjunction with enum_6 because a rate plan can be included in more then one offering and therefore is necessary to not only know the rate item but which offering.
" enum_9 = cost type, 0=sp/st specify, 1=user specified
" enum_10 = periodic type interval
" enum_11 = a value for the day of week or the day of month
" text_1 = unit type
" text_4 = unit cost text
" numeric_1 = unit cost
" numeric_2 = quantity
When item_type = 12 (cost allocation rate item)
" enum_1 = billing_cycle, 0=onetime, 1=installments , 2=periodic, 3=na
" enum_2 = periodic type, -1=na, 0=daily, 1=weekly, 2=monthly
" enum_3 = number of installments
" enum_4 = charge type, 0=credit, 1=debit
" enum_5 = pricing structure 1=tiered, 2=usage based
" enum_6 = tier type, -1=na, 0=lookup, 1=lookup multiple, 6=variable lookup
" enum_7 = 1 is show mteric result on invoice, 0 is dont
" enum_9 = cost type, 1=sp/st specify, 4=allocation
" enum_10 = periodic type interval
" enum_11 = 0 don't add budget, 1=add budget
" text_1 = unit type
" text_2 = application id
" text_3 = metric id
" text_4 = unit cost text
" numeric_1 = unit cost
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
item_id |
integer |
NOT NULL |
the unique id for each rate item |
 
|
rate_plan_id |
integer |
NULL |
the unique id for each rate plan |
 
|
base_id |
integer |
NOT NULL |
the rate item that this rate item inherits from. |
 
|
association_id |
integer |
NOT NULL |
1=no references, this is the associated rate_plan_id |
 
|
rate_row |
integer |
NOT NULL |
the row position of this rate item in the rate plan |
 
|
rate_col |
integer |
NOT NULL |
the column position of this rate item in the rate plan |
 
|
code |
nvarchar(64) |
NULL |
SP/ST supplies code |
 
|
status |
integer |
NOT NULL |
0=delete, 1=active |
 
|
item_text |
nvarchar(1024) |
NULL |
the display text of the rate item |
 
|
item_type |
integer |
NOT NULL |
the type of the rate item. SP can create there own rate item by plugging them in and defining there own item_typ, the following are rate items provided out-of-the-box: -1=empty, 0=text, 1=header, 2=numeric range, 3=rate, 4=application, 5=agreement, 6=numeric, 7=boolean, 8=adjustment, 9=date, 10=date range, 11=day |
 
|
is_hidden |
integer |
NOT NULL |
If set to 0 the item is subscribable and invoicable, if set to 1, then this rate item can be subscribed to but will not be included in any invoice calculations and will not appear on the invoice. If set to 2, then user will not see the rate item during subscription which means they won |
 
|
notes_id |
integer |
NULL |
Currently not used. |
 
|
info_link |
nvarchar(128) |
NULL |
if this contains a value in the form of a URL a "more info..." link will appear next to the rate item |
 
|
currency_1 |
nvarchar(50) |
NULL |
The currency of the SP or ST creating this rate item. |
 
|
currency_2 |
nvarchar(50) |
NULL |
Currently not used. |
 
|
date_available |
date |
NULL |
the date the rate item is available for subscription and consequently invoicing |
 
|
date_unavailable |
date |
NULL |
the date when the rate item is no longer available for subscription and consequently invoicing. If there is already a subscription to this rate item, then it will only be invoiced up to this date. |
 
|
effective |
integer |
NULL |
This specifies when the dates_available/date_unavailable take effect for rate items already subscribed to the rate item for matters regarding invoicing. 0=beginning of an account |
 
|
changeto_item_id |
integer |
NULL |
This value is -1 if a change to a rate item does does not create another rate item along the audit change trail. Otherwise it points to the id of another rate item. |
 
|
enum_1 |
integer |
NULL |
See Table Comment |
 
|
enum_2 |
integer |
NULL |
See Table Comment |
 
|
enum_3 |
integer |
NULL |
See Table Comment |
 
|
enum_4 |
integer |
NULL |
See Table Comment |
 
|
enum_5 |
integer |
NULL |
See Table Comment |
 
|
enum_6 |
integer |
NULL |
See Table Comment |
 
|
enum_7 |
integer |
NULL |
See Table Comment |
 
|
enum_8 |
integer |
NULL |
See Table Comment |
 
|
enum_9 |
integer |
NULL |
See Table Comment |
 
|
enum_10 |
integer |
NULL |
See Table Comment |
 
|
enum_11 |
integer |
NULL |
See Table Comment |
 
|
enum_12 |
integer |
NULL |
See Table Comment |
 
|
enum_13 |
integer |
NULL |
See Table Comment |
 
|
enum_14 |
integer |
NULL |
Allocation method is : 0 default, 1 -Distribute by Subscribed Account,2- Distribute by Subscription, 3- Weighted distribution
While defining Service Option Element(SOE) if type “Application” is selected,Pricing Structure is : Susbcription Based,Cost Type : Allocate Cost is selected then the allocation method will be used
|
 
|
numeric_1 |
float |
NULL |
See Table Comment |
 
|
numeric_2 |
float |
NULL |
See Table Comment |
 
|
text_1 |
nvarchar(100) |
NULL |
See Table Comment |
 
|
text_2 |
nvarchar(50) |
NULL |
See Table Comment |
 
|
text_3 |
nvarchar(50) |
NULL |
See Table Comment |
 
|
text_4 |
nvarchar(50) |
NULL |
See Table Comment |
 
|
text_5 |
nvarchar(100) |
NULL |
planning set id from usm_planning_set table ps_id. This id is used when set is assigned.
|
 
|
date_1 |
date |
NULL |
While Creating Service Option Group if we select type as Tiered, then while creating Service OptionElement if we select Date Range as type then date_1 is Lower bound
|
 
|
date_2 |
date |
NULL |
While Creating Service Option Group if we select type as Tiered, then while creating Service OptionElement if we select Date Range as type then date_2 is Upper bound
|
 
|
sub_note_control |
integer |
NULL |
currently not used. |
 
|
category |
integer |
NULL |
This field is used to logically group rate items the logical groups can be: 0=None, 1=Software, 2=Hardware. This field will be used as a field to filter in rule management to trigger different workflow |
 
|
external_id |
nvarchar(64) |
NULL |
Stores External ID from the Rate Item Options tab. |
 
|
approval_level |
integer |
NOT NULL |
0=no approval required, 1=one level of managerial approval, 2=two level of managerial approval
|
 
|
approval_process |
int |
NULL |
0=no approval process, 1=system, 2=workflow
|
 
|
category_class |
integer |
NULL |
meta data to categories the rate item. Can you put this next to the category filed in the schema so they appear together
|
 
|
category_subclass |
integer |
NULL |
meta data to categories the rate item. Can you put this next to the category filed in the schema so they appear together |
 
|
track_as_asset |
int |
NULL |
0=do not track this rate item as an Argis asset, 1=track this rate item as an Argis asset
|
 
|
sd_request_area |
varchar(30) |
NOT NULL |
maps the 'offering/rate plan/rate item' to a Service Desk Request Area |
 
|
enum_15 |
int |
NULL |
This will be applicable to items with usm_rate_definition.item_type=4 (Application Rate Items). The purpose is to indicate whether or not the Service Manager should create a service config for the item upon request/subscription. If item_type=4 and enum_15=1, service config will not be created.
|
 
|
allowed_cancellation_state |
integer |
NULL |
The request status upto which cancellation for a service option is allowed |
usm_rate_plan |
Holds rate plan, a rate plan consists of one or more rate items and will be included in a offering to allow for subscription to Accounts |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
rate_plan_id |
int |
NOT NULL |
the unique id for each rate plan |
 
|
rate_plan_name |
nvarchar(128) |
NOT NULL |
name of the rate plan |
 
|
rate_plan_type |
integer |
NOT NULL |
0=fixed, 1=tiered |
 
|
selection_type |
integer |
NOT NULL |
0=no selection, 1=single selection, 2=multiple selection |
 
|
status |
integer |
NOT NULL |
0=deleted, 1=available, 2=unavailable, 3=created, 4=cancelled |
 
|
code |
nvarchar(64) |
NULL |
set when status=1 |
 
|
date_available |
date |
NULL |
set when status=2 |
 
|
date_unavailable |
date |
NULL |
set when status=3 |
 
|
date_created |
date |
NOT NULL |
set when status=4 |
 
|
date_cancelled |
date |
NULL |
SP/ST supplies code |
 
|
is_inherited |
integer |
NOT NULL |
0=a base rate plan, 1=rate plan inherits some or all of it |
 
|
has_header |
integer |
NOT NULL |
0=no header rate items, 1=has header rate items |
 
|
total_rows |
integer |
NOT NULL |
number of rows in the rate plan |
 
|
total_cols |
integer |
NOT NULL |
number of columns in the rate plan |
 
|
description |
nvarchar(128) |
NULL |
SP/ST admin description of the rate plan |
 
|
notes_id |
integer |
NULL |
currently not used. |
 
|
sub_note_control |
integer |
NULL |
currently not used. |
 
|
domain |
varchar(50) |
NULL |
ID of the business unit to which this rate plan belongs. |
 
|
folder |
nvarchar(64) |
NULL |
this field holds the folder name in which a rate plan belong, it will help in organizing the rate plans in folders, we will support only 1 level deep folders.
|
 
|
sort_order_no |
int |
NULL |
Rate plan sort number is used when custom sort is used for an Offering. |
 
|
sd_request_area |
varchar(30) |
NOT NULL |
maps the 'offering/rate plan/rate item' to a Service Desk Request Area |
 
|
date_last_modified |
datetime |
NOT NULL |
To keep a track of when the object (service offering, service option group) was last modified.
This is not nullable. The default value is same as the "date_created" value of the same record.
|
usm_rateplan_inclusion |
Persists the relationship of which rate items belong to which rate plans. The concept of this table is that every rate plan has many rate items of which some are no longer available, due to soft deleted rate items and rate items that are tracked for auditing purposes. Only the available rate items will appear in the table. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
unique id for offerings_rateplans_inclusion |
 
|
parent_id |
integer |
NULL |
the unique id for each offering |
 
|
child_id |
integer |
NULL |
the rate_plans_id of the included rate plan |
usm_rateplan_inheritance |
Persists the relationship of between rate plans and the rate items that they are inheriting. The concept of this table is that a component can determine if a rate plan inherits from another rate plan if it has entries in this table. From this table a rate plan inheritance tree can be formed. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
int |
NOT NULL |
unique id for rateplan_inclusion |
 
|
base_id |
integer |
NOT NULL |
the rate plan inheriting rate items from another rate plan pointed to by base_id |
 
|
item_id |
integer |
NOT NULL |
the unique id for each rate item |
 
|
derived_id |
int |
NULL |
the unique id for each rate plan |
usm_recurring_event |
A recurring event is an description of a recurring pattern of events. One recurring event will result in a series of events, called recurring occurrences.
A pattern is used to decribe the recurring event. Crontab is supported but other pattern types may be supported in the future.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
recurring_event_oid |
varchar(20) |
NOT NULL |
Unique identity for the recurring event |
 
|
start |
integer |
NOT NULL |
Start time in epoch of the recurring event |
 
|
expire |
integer |
NULL |
Expiry time in epoch of the recurring event. If NULL, the recurring event does not expire. |
 
|
duration |
integer |
NOT NULL |
Durations in seconds, of one recurring occurrence for this recurrring event series. |
 
|
description |
nvarchar(255) |
NOT NULL |
Description of all occurrences for this recurring event series. |
 
|
value |
nvarchar(255) |
NULL |
Value of the event |
 
|
timezone |
varchar(50) |
NULL |
Time zone id used to parse the pattern |
 
|
pattern |
varchar(255) |
NOT NULL |
Pattern of the recurring event, parsed by the patter type scheduler. |
 
|
calendar_oid |
varchar(256) |
NULL |
The calendar oid to which the recurring event belongs |
 
|
pattern_type_oid |
varchar(20) |
NULL |
The pattern type used to parse the recurring events |
 
|
event_category_oid |
varchar(256) |
NULL |
The event category to which occurrences of this recurring event belongs. |
 
|
event_category_value_oid |
varchar(20) |
NULL |
Unique identity of the event category value |
 
|
start_time |
integer |
NULL |
Start Time of the recurring event |
usm_report_data |
Defines a data object for a report.
Data object is responsible for fetching the data from the data source.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_data_id |
varchar(50) |
NOT NULL |
Unique identifier for the report data object. The unique identifier is assigned when the report data is saved. |
 
|
name |
varchar(64) |
NULL |
Human readable name of the data object |
 
|
status |
int |
NULL |
Indicates whether the data object is active or inactive. If status is 1, the data object is active and if status is 0, the data object is inactive |
 
|
type |
nvarchar(20) |
NULL |
Indicates the source of data |
 
|
description |
varchar(128) |
NULL |
Detailed description of the purpose of the data object |
 
|
db_id |
varchar(50) |
NULL |
Handle to the usm_db table |
 
|
comment |
varchar(64) |
NULL |
Stores the comment entered when data object is created |
 
|
time_stamp |
datetime |
NULL |
The time when the data object is created |
 
|
pre_actions |
varchar(64) |
NULL |
Actions that have to be taken after the data is fetched from data source |
 
|
query_string |
varchar(256) |
NULL |
The query which indicates which data should be fetched from data source |
 
|
post_actions |
varchar(64) |
NULL |
Actions that have to be taken after the data is fetched from data source. |
 
|
page_functions |
varchar(64) |
NULL |
Functions applied to each page of the report |
 
|
report_functions |
varchar(64) |
NULL |
Functions applied to the entire report |
 
|
fields |
varchar(64) |
NULL |
Specific fields to be selected when fetching data |
 
|
data1 |
varchar(64) |
NULL |
external integration/additional data |
 
|
data2 |
varchar(64) |
NULL |
external integration/additional data |
 
|
delimiter |
nvarchar(20) |
NULL |
Seperates values of fields in the data |
 
|
class |
varchar(64) |
NULL |
Class to which this data object belongs to |
 
|
report_variable_string |
varchar(64) |
NULL |
Specifies the variables for this report |
 
|
folder |
varchar(64) |
NULL |
Folder into which the data object is stored |
 
|
owner |
varchar(50) |
NULL |
User who created the data object |
 
|
reg_join_query_string |
varchar(256) |
NULL |
Select query if the data object type is registry join |
 
|
pvt_row_fields |
varchar(64) |
NULL |
Row fields that are selected for pivoting |
 
|
pvt_column_fields |
varchar(64) |
NULL |
Column fields by which data is grouped while pivoting |
 
|
pvt_data_fields |
varchar(64) |
NULL |
Actual data values that are aggregated for the pivoted data |
 
|
pvt_aggregate_fields |
varchar(64) |
NULL |
Values of data after aggregation |
 
|
dblock_type |
int |
NULL |
Type of locking method when executing the database queries. |
 
|
pvt_totals |
int |
NULL |
Specifies how the pivoted totals are displayed |
 
|
pvt_aggregate_type |
int |
NULL |
Specifies how aggregation should be done |
 
|
pvt_data |
varchar(64) |
NULL |
Stores the pivoted data |
 
|
pvt_empty_cell_value |
varchar(64) |
NULL |
Specifies the value to be taken if cell is empty |
 
|
pvt_error_value |
varchar(64) |
NULL |
Specifies the value to be taken if cell value is error |
 
|
pvt_orig_fields |
varchar(64) |
NULL |
Original values of data before any pivoting |
 
|
pvt_sort_order |
varchar(64) |
NULL |
Specifies how sorting should be done |
 
|
bucket_no |
int |
NULL |
Specifies the number of buckets in the data |
 
|
bucket_size |
int |
NULL |
Specifies the size of each bucket |
 
|
pvt_col_sort_order |
varchar(64) |
NULL |
Specifies how column sort should be done |
 
|
get_variables_page |
nvarchar(1024) |
NOT NULL |
Handle to the page displaying the variables of the data object |
 
|
comments |
nvarchar(512) |
NULL |
description for the field. Field name "comment" has been changed to "comments" to support oracle |
usm_report_dataview |
Defines a data view for a report. The dataview displays the data retrieved from data object in customizable chart or table format. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_dataview_id |
varchar(128) |
NOT NULL |
Unique identifier for the report dataview. This is created when the dataview is saved |
 
|
description |
varchar(128) |
NULL |
Describes the purpose of the data view |
 
|
report_data_id |
varchar(50) |
NOT NULL |
Handle to the data object to which this dataview is associated |
 
|
comment |
varchar(64) |
NULL |
Stores comments entered by the user when dataview is created |
 
|
type |
nvarchar(20) |
NULL |
Specifies the type of the dataview |
 
|
time_stamp |
datetime |
NULL |
Specifies the time when dataview is created |
 
|
status |
int |
NULL |
Specifies the status of dataview: active or inactive |
 
|
legend |
nvarchar(64) |
NULL |
Specifies the legend to be displayed on the chart |
 
|
report_style_chart |
varchar(64) |
NULL |
Chart settings to be applied if dataview contains chart |
 
|
report_style_table |
varchar(64) |
NULL |
Table settings to be applied if dataview contains table |
 
|
bucket_size |
int |
NULL |
Specifies the number of rows to be displayed in each bucket |
 
|
data1 |
varchar(64) |
NULL |
external integration/additional data |
 
|
data2 |
varchar(64) |
NULL |
external integration/additional data |
 
|
column_rules |
varchar(64) |
NULL |
Operations to be performed on each and individual column of data |
 
|
dataview_type |
int |
NULL |
Specifies the type of dataview |
 
|
dataobject_string |
varchar(64) |
NULL |
Specifies settings for the data object associated with the dataview |
 
|
external_cmd |
varchar(64) |
NULL |
Store the command for external process invocation |
 
|
external_file_name |
varchar(64) |
NULL |
Store the file name for external process invocation |
 
|
external_params |
varchar(64) |
NULL |
Store the parameter for external process invocation |
 
|
external_format |
varchar(64) |
NULL |
Store the format for external process invocation |
 
|
external_cleanup |
int |
NULL |
Specify whether external cleanup is to performed |
 
|
delimiter |
nvarchar(20) |
NULL |
Delimiter separating values of data |
 
|
refresh_time |
int |
NULL |
Specifies how often dataview should be refreshed |
 
|
print_settings |
varchar(64) |
NULL |
Specifies settings for printing the dataview |
 
|
folder |
varchar(64) |
NULL |
Specifies folder in which dataview is saved |
 
|
owner |
varchar(50) |
NULL |
Specifies user who created the dataview |
 
|
get_variables_page |
varchar(256) |
NULL |
Handle to the page to get variables for the associated data object |
 
|
pre_actions |
varchar(64) |
NULL |
Specifies actions to be performed before loading the dataview |
 
|
post_actions |
varchar(64) |
NULL |
Specifies actions to be performed after loading the dataview |
 
|
bucket_no |
int |
NULL |
Specifies the number of the page of dataview being displayed |
 
|
path |
varchar(256) |
NULL |
Specifies path for storing offline report |
 
|
file_name |
varchar(64) |
NULL |
Specifies filename for storing offline report |
 
|
guinode_id |
varchar(128) |
NULL |
Specifies handle to the guinode for displaying the report |
 
|
metering_string |
varchar(256) |
NOT NULL |
Specifies paramter for customizing the metering reports |
 
|
name |
nvarchar(128) |
NULL |
Specifies Human readable name for the dataview |
 
|
comments |
nvarchar(512) |
NOT NULL |
description for the field. Field name "comment" has been changed to "comments" to support oracle |
usm_report_dataview_field |
Defines a relationship for storing multi valued attribute field. A report dataview can have multiple fields. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_dataview_id |
varchar(128) |
NOT NULL |
Handle to the usm_report_dataview table |
 
|
field_type |
varchar(50) |
NOT NULL |
Define field type { CHART_XFIELDS,CHART_YFIELDS,TABLE_FIELDS,CHARTTITLE } |
 
|
field |
ntext |
NOT NULL |
Specifies the value of field of the dataview |
usm_report_group |
A report group is a collection of metric instances with a set of assicated service goals. Also, a set of analyses are schedules on the metric instances within the report group.
A report group is associated with a contract. The contract is used to retrieve the service hours.
Also, the contract may be used to retrieve a overall status for the report group. This may not be included in r11.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_group_id |
int |
NOT NULL |
Unique identity for the report group |
 
|
parent_path |
varchar(255) |
NULL |
  |
 
|
report_group_template_id |
int |
NULL |
Unique identity for the report group template from which this report group is derived. |
 
|
contract_id |
int |
NULL |
The associated contract |
 
|
name |
varchar(64) |
NOT NULL |
The name of the report group |
 
|
description |
varchar(128) |
NOT NULL |
The description of the report group |
 
|
level |
int |
NULL |
The level. Root level report groups have a level of "0". |
 
|
calendar_oid |
varchar(256) |
NULL |
Associated calendar for service events.
Events exported by that calendar into usm_service_events are used by analyses for this report group.
|
 
|
tree_level |
int |
NULL |
  |
 
|
weight |
int |
NULL |
  |
 
|
account_id |
varchar(50) |
NULL |
Unique ID of the account |
 
|
time_zone_code |
varchar(64) |
NULL |
time zone code is the code for a particular time zone, Eg- EST, PST etc |
 
|
sla_instance_id |
int |
NULL |
  |
usm_report_group_attr |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_group_attr_id |
int |
NOT NULL |
  |
 
|
report_group_id |
int |
NOT NULL |
Unique identity for the report group |
 
|
report_group_attr_spec_id |
int |
NOT NULL |
  |
 
|
value |
nvarchar(512) |
NOT NULL |
  |
 
|
reference_key |
varchar(256) |
NOT NULL |
  |
usm_report_group_attr_spec |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_group_attr_spec_id |
int |
NOT NULL |
  |
 
|
attribute_name |
varchar(100) |
NOT NULL |
  |
 
|
type |
varchar(256) |
NOT NULL |
  |
 
|
form_type |
varchar(256) |
NOT NULL |
  |
 
|
label |
nvarchar(100) |
NOT NULL |
  |
 
|
label_bundle_key |
varchar(50) |
NOT NULL |
  |
 
|
default_value |
nvarchar(255) |
NOT NULL |
  |
 
|
default_reference_key |
varchar(50) |
NOT NULL |
  |
 
|
is_required |
c(1) |
NOT NULL |
  |
 
|
report_group_template_id |
int |
NULL |
Unique identity for the report group template |
 
|
attr_reference_plugin_id |
integer |
NULL |
Unique identifier identifying the plugin |
 
|
tab_order |
int |
NULL |
  |
usm_report_group_goal |
The service goal for a given report group |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_group_id |
int |
NOT NULL |
Unique identity for the report group |
 
|
service_goal_id |
integer |
NOT NULL |
Uniquely identifies the |
 
|
value |
varchar(255) |
NULL |
The value for the associated service goal for the associated report group |
usm_report_group_metr_instance |
Identifies the metric instances used by this report group.
It is possible to specify whether a metric instance should be affected by service events from the calendar or not. The field use_calendar specifies this.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_group_id |
int |
NOT NULL |
Unique identity for the report group |
 
|
metric_instance_id |
int |
NOT NULL |
Unique identifier |
 
|
use_calendar |
c(1) |
NULL |
If 'N', the metric instance is not affected by the calendar service events. 'Y' or any other value means yes. |
usm_report_group_spec_value |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_group_spec_value_id |
int |
NOT NULL |
  |
 
|
report_group_attr_spec_id |
int |
NOT NULL |
  |
 
|
label |
nvarchar(100) |
NOT NULL |
  |
 
|
label_bundle_key |
varchar(50) |
NOT NULL |
  |
 
|
value |
nvarchar(100) |
NOT NULL |
  |
 
|
value_order |
int |
NULL |
  |
 
|
reference_key |
varchar(50) |
NOT NULL |
  |
usm_report_group_template |
A report group template represents a collection of metrics with associated default service goals. Such a template can be instantiated into a report group.
A report group template may also be organized into a hierarchy, so that it is possible to instantiate a complete report group hierarchy from a report group template.
In r11, only one report group template will be supported.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_group_template_id |
int |
NOT NULL |
Unique identity for the report group template |
 
|
parent_path |
varchar(255) |
NULL |
  |
 
|
name |
varchar(64) |
NULL |
The name of the template |
 
|
description |
varchar(128) |
NULL |
A description of the template |
 
|
level |
int |
NULL |
The level of the template. Root level is 0 |
 
|
slo_package_id |
int |
NULL |
Identity of the associated slo package. |
 
|
description_bundle_key |
nvarchar(50) |
NULL |
Bundle key for the description. This is used when the description is null. Used for i18n. |
 
|
tree_level |
int |
NULL |
  |
usm_report_layout |
Defines the layout of the report.
Layout is a combination of one or more report views. Report layout contains the definition of how the report views are layed out and displayed
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_layout_id |
varchar(50) |
NOT NULL |
Specifies the Unique identifier for the report layout. It is created when the layout is saved |
 
|
comment |
varchar(64) |
NULL |
Stores the comment entered by the user when layout is created |
 
|
data1 |
varchar(64) |
NULL |
external integration/additional data |
 
|
data2 |
varchar(64) |
NULL |
external integration/additional data |
 
|
data3 |
varchar(64) |
NULL |
external integration/additional data |
 
|
time_stamp |
datetime |
NULL |
Specifies the time when layout is created |
 
|
folder |
varchar(64) |
NULL |
Specifies the folder in which layout is stored |
 
|
name |
varchar(64) |
NULL |
Specifies the human readable name for the layout |
 
|
owner |
varchar(50) |
NULL |
Specifies the user who created the layout |
 
|
get_variables_page |
varchar(256) |
NULL |
Handle to get variables for the data object associated with the dataview displayed |
 
|
document_string |
varchar(64) |
NULL |
Specifies the settings for the layout in general |
 
|
external_params |
varchar(256) |
NOT NULL |
Specifies the external parameters string for the layout |
 
|
file_name |
nvarchar(256) |
NOT NULL |
Specifies the file name for the layout |
 
|
type |
nvarchar(20) |
NOT NULL |
Specifies type for the layout |
 
|
status |
integer |
NULL |
Specifies status (available-1, created-0) for the layout |
 
|
comments |
varchar(64) |
NOT NULL |
description for the field. Field name "comment" has been changed to "comments" to support oracle |
usm_report_layout_obj_list |
A list containing settings for various components displayed in the layout |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_layout_id |
varchar(50) |
NOT NULL |
Handle to the usm_report_layout table |
 
|
layout_object_list |
ntext |
NULL |
Specifies settings for a particular component in the layout |
 
|
report_dataview_id |
varchar(128) |
NULL |
Handle to the usm_report_dataview_table |
usm_report_profile |
This table represents report profiles that are used to create a profile for how reports look and what properties the reports have. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_profile_id |
integer |
NOT NULL |
Unique identity of the report profile |
 
|
name |
nvarchar(50) |
NULL |
Name of the profile |
usm_report_profile_attrs |
One attribute for a given report profile. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_profile_id |
integer |
NOT NULL |
Unique identity of the report profile |
 
|
section |
varchar(50) |
NULL |
The section for the attribute |
 
|
name |
varchar(50) |
NULL |
The attribute name |
 
|
value |
nvarchar(2048) |
NULL |
The attribute value |
usm_report_profile_spec |
Specification of the attributes that a report profile can have.
A specification gives the attribute names, default value, whether it is a selection list or input field, the order of the fields etc.
The attributes are divided into sections, i.e. one for line-chart, one for layout
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
attribute_name |
varchar(50) |
NOT NULL |
Attribute name |
 
|
section |
varchar(50) |
NOT NULL |
The section to which the attribute applies |
 
|
default_value |
nvarchar(2048) |
NULL |
The default value for the attribute |
 
|
label |
nvarchar(255) |
NULL |
The attribute label |
 
|
label_bundle_key |
varchar(50) |
NULL |
The bundle key for the label. Used if label is null to create i18n labels. |
 
|
help |
nvarchar(255) |
NULL |
Help text |
 
|
help_bundle_key |
varchar(50) |
NULL |
Bundle key for the help text. Used if help is null to create i18n help texts |
 
|
type |
varchar(50) |
NULL |
The attribute type, for GUI
- check - Boolean checkbox
- entry - User is allowed to enter data
- hidden - Not shown to the user at all
- label - A simple label. Not for editing
- select - The user is presented with a selection list with the values from usm_report_profile_spec_values.
- text - Text field
|
 
|
tab_order |
integer |
NULL |
The ordering of the fields. Lowest tab order is presented first. |
usm_report_profile_spec_values |
Set of allowed selection values for a given attribute for a report profile and a section |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
attribute_name |
varchar(50) |
NOT NULL |
Attribute name |
 
|
section |
varchar(50) |
NOT NULL |
The section to which the attribute applies |
 
|
value |
varchar(2048) |
NULL |
A allowed select value for that attribute,section, and profile. |
usm_report_variable |
Defines a variable used in the reports |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_variable_id |
varchar(50) |
NOT NULL |
Unique identifier for each variable |
 
|
name |
varchar(64) |
NULL |
Human readable name of the variable |
 
|
status |
int |
NULL |
Specifies status of variable |
 
|
type |
nvarchar(20) |
NULL |
Specifies the type of variable |
 
|
data_type |
varchar(20) |
NULL |
Specifies the data type of variable |
 
|
value |
varchar(64) |
NULL |
Specifies the value of the variable |
 
|
prompt |
varchar(64) |
NULL |
Specifies the text to be displayed when prompting for value of variable |
 
|
description |
varchar(128) |
NULL |
Specifies description of purpose of variable |
 
|
constraints |
nvarchar(1280) |
NULL |
Specifies various contraints on value of variable |
usm_request |
This table stores all the request header information. A request header can have many fields depending on the implementation. To facilitate dynamic fields it is closely tied to usm_request_values table. The line items of a request are stored in usm_subscription_details table. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
request_id |
int |
NOT NULL |
Unique id associated to the order. |
 
|
name |
nvarchar(128) |
NOT NULL |
Display name of order. |
 
|
status |
integer |
NOT NULL |
The status of the order. |
 
|
created_date |
datetime |
NOT NULL |
Date when order was initiated. |
 
|
modified_date |
date |
NOT NULL |
Date when order was modified. |
 
|
completion_date |
date |
NULL |
Date when order was completed. |
 
|
desired_date |
date |
NULL |
Desired date the end user would like the order fulfilled |
 
|
priority |
int |
NULL |
The priority associated with this order, it is primarily used for the fulfillment part. |
 
|
req_for_account_id |
varchar(50) |
NULL |
The account number that this request is for |
 
|
req_by_account_id |
varchar(50) |
NULL |
The account number that is creating this request |
 
|
req_for_user_id |
varchar(50) |
NULL |
The user that this request is for |
 
|
req_by_user_id |
varchar(50) |
NULL |
The user that is creating this request |
 
|
code |
nvarchar(64) |
NULL |
user data |
 
|
domain |
varchar(50) |
NULL |
Domain to which this order belongs. |
 
|
location_uuid |
tinyint(16) |
NULL |
Location Unique ID |
 
|
comments |
ntext |
NULL |
Comments associated to the order. |
 
|
context_type |
int |
NOT NULL |
This new column is required to differentiate whether a request has been created through normal flow or through delegation of service request. We should not allow null for this column to support backward compatability the old values should be 0
|
usm_request_auto_delegation |
Table to persist auto-delegation setting for a user |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
req_auto_delegation_id |
int |
NOT NULL |
Unique auto-generated Pending Auto Delegation ID. |
 
|
delegator_id |
nvarchar(128) |
NOT NULL |
User ID of the person whose newly assigned request pending action(s) get auto-delegated. |
 
|
delegate_id |
nvarchar(128) |
NOT NULL |
User ID of the delegated User. Newly assigned pending action(s) get automatically delegated from Delegator to this User. |
 
|
delegation_type |
int |
NULL |
This new column is required to store the delegation type .For request auto delegation value=0 for service delegation value=1 .If any new delegation is added to request management we can assign other integer values 2,3 ,4 etc. We should not allow null for this column to support backward compatability the old values should be 0
|
usm_request_item_form |
Form information associated to a form type request item (subscription_detail_id) is stored in this table. Form information is stored as name-value pairs. Note - The Form rate item was introduced as part of a patch to Catalog r11.1. This functionality is also in Catalog r11.2 and includes additional functionality. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
subscription_detail_id |
integer |
NOT NULL |
the unique id for each subscription record |
 
|
form_elem_name |
nvarchar(64) |
NOT NULL |
Includes request form element ID. Note- The form label is referenced from the related request form XML file. |
 
|
form_elem_value |
ntext |
NOT NULL |
Includes request form element value(s). |
usm_request_pending_act_hist |
Table to track request pending action history |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
req_pend_act_hist_id |
int |
NOT NULL |
Unique auto-generated Pending Action History ID. |
 
|
req_pend_act_id |
int |
NOT NULL |
Auto-generated unique ID. |
 
|
reassigned_req_pend_act_id |
int |
NULL |
Auto-generated unique ID. |
 
|
action_type |
int |
NOT NULL |
Action performed like take, return, transfer or delegate. |
 
|
modified_by |
nvarchar(128) |
NOT NULL |
Record which user performed the action. Refers user id in CA_Contact table. |
 
|
modified_date |
datetime |
NOT NULL |
Record when the pending action was modified (GMT) |
usm_request_pending_action |
This table is used to store the information linking a request or request item with an user ID to which a workflow task or non-USF approval is currently assigned (one-to-many). This table is populated based on the request item status changes.
Request/Request Item User ID Cross Reference
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
request_pending_action_id |
int |
NOT NULL |
Auto-generated unique ID. |
 
|
request_id |
int |
NULL |
ID of the request to which this pending action belongs. |
 
|
object_id |
integer |
NOT NULL |
FK to either usm_subsrcition_detail or usm_offering table this value depends on object_type field.
|
 
|
object_type |
int |
NULL |
0=usm_subscription_detail, 1=usm_offering |
 
|
process_instance_id |
varchar(20) |
NULL |
set to null if USF is not involved |
 
|
workitem_id |
varchar(36) |
NULL |
set to null if USF is not involved |
 
|
user_id |
nvarchar(100) |
NULL |
Indicates the user ID if a pending action is assigned to an individual user OR when a pending action is taken by a particular user in a group. |
 
|
status |
integer |
NOT NULL |
0=Assigned but not completed, 1=Completed by assigned user, 2=Completed but not by assigned user, 3=Process instance cancelled |
 
|
complete_date |
datetime |
NULL |
store date and time workitem is completed |
 
|
created_date |
datetime |
NULL |
This field will save the date for which the pending action is created |
 
|
action_type |
int |
NULL |
This field will be used to indicate type of pending action. They are edit, approval or fulfillment |
 
|
modified_date |
datetime |
NULL |
Date when this pending action was last modified. |
 
|
modified_by |
nvarchar(128) |
NULL |
ID of the user who last modified this request. |
 
|
is_group |
int |
NULL |
Indicates if a pending action is assigned to a user(is_group=0) or group(is_group=1) |
 
|
object_group_id |
int |
NULL |
- Offering group_id will be stored in this column if object_type=1 (indicating that object_id is an offering id).
- This column is null if object_type=2 (indicating that object_id is a rate item id)
|
 
|
group_id |
nvarchar(100) |
NOT NULL |
Indicates the group ID if a pending action is assigned to a group. Otherwise, it is null when a pending action is assigned to an individual user. |
usm_request_resource_item |
catalog request resource items for an example like for the reserved vitural machine vm1, vm2 at the computer type, for disk1, disk2 at the hard disk type level |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
resource_item_id |
varchar(64) |
NOT NULL |
identifier of catalog request resource item |
 
|
resource_item_parent_id |
varchar(64) |
NULL |
parent identifier of catalog request resource item |
 
|
resource_hierachical_type_id |
varchar(64) |
NOT NULL |
Id of the hierachical data |
 
|
resource_item_status |
int |
NOT NULL |
status of item {CREATED(100), READY(200), CANCELLED(300), COMPLETED(400)} |
 
|
resource_item_sub_detail_id |
integer |
NOT NULL |
related subscription detail id of the resource item |
 
|
resource_item_created_date |
datetime |
NOT NULL |
resource item created date |
 
|
resource_item_name |
nvchar(512) |
NULL |
resource item name |
 
|
resource_item_identifier |
nvchar(512) |
NULL |
resource item identifier |
 
|
resource_item_url |
nvchar(2000) |
NULL |
resource item created url |
usm_request_sla_instance |
Table contains all SLAs instance information at service options level and monitored status sla level, for each requests |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
sla_instance_id |
varchar(128) |
NOT NULL |
Request SLA Instance ID |
 
|
offering_sla_def_id |
varchar(128) |
NOT NULL |
offering sla defintion unique id |
 
|
request_id |
int |
NOT NULL |
Unique id associated to the order. |
 
|
subscription_detail_id |
integer |
NOT NULL |
the unique id for each subscription record |
 
|
is_sla_active |
integer |
NOT NULL |
sla instance active or inactive flag (Active=1/Inactive=0) |
 
|
sla_status |
integer |
NULL |
sla instance status (Created=0/Warned=1/Violated=2/Completed=3/Paused=4/Resumed=5/Canceled=6) |
 
|
time_to_warn |
bigint |
NULL |
remaining time upto warning |
 
|
time_to_violate |
bigint |
NULL |
remaining time upto violation |
 
|
last_event_time |
bigint |
NULL |
last occurred event time |
 
|
next_event_time |
bigint |
NULL |
next occuring event time |
 
|
next_event_type |
integer |
NULL |
next occuring event type like Outage/Warn/Violate/ |
 
|
created_time |
datetime |
NULL |
sla instance created timestamp |
 
|
warned_time |
datetime |
NULL |
warned timestamp if sla instance is warned |
 
|
violated_time |
datetime |
NULL |
violated timestamp if sla instance is violated |
 
|
completed_time |
datetime |
NULL |
completed timestamp if sla instance is completed |
 
|
paused_time |
datetime |
NULL |
paused timestamp if sla instance is stopped |
 
|
resumed_time |
datetime |
NULL |
resumed timestamp if sla instance is resumed |
 
|
canceled_time |
datetime |
NULL |
canceled timestamp, if request is canceled |
usm_request_status |
In r11.1 request status history was fetched from event audit trail table, usm_system_change which did not scale well to high load. For r11.2, in order to improve performance and to show pending action at the request item level the request status history was stored in this new table. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
request_status_id |
int |
NOT NULL |
request status unique id |
 
|
request_id |
int |
NOT NULL |
Unique id associated to the order. |
 
|
subscription_detail_id |
integer |
NULL |
the unique id for each subscription record |
 
|
status |
int |
NOT NULL |
Status of a request, service offeing or a service option. |
 
|
status_date |
datetime |
NOT NULL |
Date when this status change was recorded. |
 
|
user_id |
nvarchar(128) |
NULL |
User who initiated a status change. |
 
|
status_old |
integer |
NULL |
stores old status ("from" status) of request status change. allowed null to support backward compatability |
 
|
login_device |
integer |
NOT NULL |
For Nomal system login (status updated) value = 0 (default value), PDA login (status updated) = 1. It can further extend to 2,3,4 for new type
User should either Login via PDA/System, default value 0
|
usm_request_value |
This table is used to store the order header information. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
request_id |
int |
NOT NULL |
Unique id associated to the order. |
 
|
name |
varchar(50) |
NOT NULL |
filed name |
 
|
value |
nvarchar(256) |
NULL |
filed value |
 
|
type |
int |
NULL |
type of the field |
 
|
data_type |
int |
NULL |
Data type of the value, 0=string, 1=Date, 2=integer, 3=double
|
 
|
text_1 |
nvarchar(64) |
NULL |
user data |
usm_reservation |
to store catalog request reservation |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
reservation_id |
varchar(64) |
NOT NULL |
to store catalog request reservation |
 
|
external_system_id |
varchar(64) |
NOT NULL |
identifier of an external reservation system like MRM, and DEMO1 etc |
 
|
external_system_track_id |
nvarchar(256) |
NULL |
tracking id of an external reservation system like ticket id, or reservation id etc |
 
|
status |
int |
NOT NULL |
status of reservation {CREATED(100), READY(200), CANCELLED(300), COMPLETED(400)} |
 
|
start_date |
datetime |
NOT NULL |
reservation start date |
 
|
end_date |
datetime |
NULL |
reservation end date |
 
|
created_date |
datetime |
NOT NULL |
reservation created date |
 
|
last_modified_date |
datetime |
NOT NULL |
reservation last modified date |
usm_role |
Defines the role which a user can be assigned.
Role determines the level of access. Eg: service provider administrator, super tenant administrator , enduser etc
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
role_id |
varchar(50) |
NOT NULL |
The unique identifier for the role, Eg: spadministrator, enduser etc |
 
|
access_depth |
int |
NULL |
Specifies the power of the rule, depth -1 is unlimited power for that domain scope |
 
|
domain_type |
varchar(4) |
NULL |
For which domains is this role used, Eg: SP, ST, TE etc |
 
|
name |
nvarchar(64) |
NULL |
The descriptive name of the role |
 
|
description |
nvarchar(50) |
NULL |
The description of the role |
 
|
domain |
varchar(50) |
NULL |
The unique tenantid that identifies this organization/tenant |
 
|
sys_defined_group |
nvarchar(512) |
NULL |
System Defined Group |
usm_role_user |
Place holder for the relationship as which users belong to which group |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
user_id |
nvarchar(100) |
NOT NULL |
Related User ID |
 
|
role_id |
varchar(50) |
NOT NULL |
Related Role ID |
usm_rsc_map |
Defines relationship to represent hierarchy structure of resource |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
unique table id |
 
|
type |
integer |
NULL |
1=node relationship |
 
|
parent_id |
integer |
NULL |
the parent node id |
 
|
child_id |
integer |
NULL |
the child node id |
usm_rsc_method |
Defines resource methods
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
unique table id |
 
|
ds_type |
integer |
NULL |
data source type, 1=database, 2=registry query, 3=registry property, 4=java method |
 
|
class_name |
varchar(64) |
NOT NULL |
registry class name or database table name |
 
|
criteria |
varchar(256) |
NOT NULL |
the search criteria |
 
|
data_source |
varchar(64) |
NOT NULL |
the icdb id, it allows the tree to display data from multiple data source. not used now |
usm_rsc_nmrefer |
Defines the relationship between resource node and resource method
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
unique table id |
 
|
method_id |
integer |
NULL |
the method id that uses the parameter |
 
|
node_id |
integer |
NULL |
node id |
 
|
seq_no |
integer |
NULL |
the method sequence number within one node, starts with 1 |
usm_rsc_node |
Defines the resource node for the resource management
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
unique table id |
 
|
type |
integer |
NULL |
the node type, 1=folder, 2=object |
 
|
gui_action |
integer |
NULL |
each bit represents a action, value 1 means yes and 0 means no. Bit 0=expandable, 1=clickable, 2=right click able, 3=double clickable, 4=drag and drop able
|
 
|
name |
nvarchar(64) |
NOT NULL |
the folder name when type=1, object display attribute name type=2 |
 
|
icon_1 |
varchar(128) |
NULL |
the icon file name, used when the folder is closed |
 
|
icon_2 |
varchar(128) |
NOT NULL |
the icon file name, used when the folder is open |
usm_rsc_parameter |
Defines parameters which is related to the resource method
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
unique table id |
 
|
method_id |
integer |
NULL |
the method id that uses the parameter |
 
|
seq_no |
integer |
NULL |
the parameter sequence number within one method |
 
|
name |
nvarchar(64) |
NOT NULL |
the parameter name that matches to registry attribute name or table field name |
usm_rsc_property |
Defines resource property information for the resource node.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
int |
NOT NULL |
unique table id |
 
|
node_id |
integer |
NULL |
the rsc_node id |
 
|
type |
integer |
NULL |
1=static value, 2=dynamic value |
 
|
name |
nvarchar(64) |
NOT NULL |
the property name |
 
|
value |
nvarchar(256) |
NOT NULL |
the property value |
usm_rsc_system |
Keep the last accessed IDs for resource management
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
nvarchar(256) |
NOT NULL |
unique table id, there should be only one record with id=1 |
 
|
gui_action |
int |
NULL |
each bit represents a action, value 1 means yes, 0 means no. Bit 0=expandable, 1=clickable, 2=right click able, 3=double clickable, 4=drag and drop able
|
 
|
nmrefer_id |
integer |
NULL |
last rsc_nmrefer id |
 
|
map_id |
int |
NULL |
last rsc_map id |
 
|
parameter_id |
integer |
NULL |
last rsc_parameter id |
 
|
method_id |
integer |
NULL |
last rsc_method id |
 
|
property_id |
integer |
NULL |
last rsc_property id |
 
|
node_id |
integer |
NULL |
last rsc_node id |
usm_rule |
Rule is a basic entity which drives the fulfilment of a task, we can add any number of rule for a specific rule_event_type.
Rule will hold a bunch of action associated which will be triggred on execution of this rule
Eg: A new hire is added to a company and you want to drive certain thing as soon as a user is added into the system.
Here "new hire" is a new rule which is added to rule_event_type ADD_USER.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
rule_id |
varchar(50) |
NOT NULL |
non-displayable id used in the backend as a reference between tables. |
 
|
status |
int |
NULL |
ACTIVE/DISABLED. A disabled rule does not get triggered when an event occurs. |
 
|
display_name |
varchar(64) |
NULL |
Name for this rule. |
 
|
description |
varchar(128) |
NULL |
text explaining the purpose of this rule. |
 
|
is_hidden |
int |
NULL |
YES/NO. Any hidden rules will not be shown in the GUI. However, they will be triggered when an event corresponding to the event type this rule is subscribed for, occurs. |
 
|
is_system |
int |
NULL |
YES/NO. iCanProvision comes with some in-built rules for certain event types such as SLA Violation etc. These are system rules. |
 
|
event_type_id |
varchar(50) |
NULL |
non-displayable id used in the backend as a reference between tables. |
 
|
type |
varchar(128) |
NULL |
Specifies the type of the rule |
 
|
sub_type |
varchar(50) |
NULL |
Specifies the secondary type of the rule |
 
|
start_time |
datetime |
NULL |
Specifies the start time of the rule activation |
 
|
expire_time |
datetime |
NULL |
Specifies the expiration time of the rule |
usm_rule_action |
Rule Action is the action which achieves the end task to be fulfilled.
There can be many actions associated to a rule, so when a rule is satisfied all its actions are triggered
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
rule_action_id |
varchar(64) |
NOT NULL |
non-displayable id used in the backend as a reference between tables. |
 
|
type |
varchar(128) |
NULL |
type of the rule action. JAVA, SHELL, HTTP etc. |
 
|
action |
varchar(64) |
NULL |
String containing the action that needs to be executed. For example, if JAVA is selected above in the ictype field, this field contains the JAVA class name with the package qualifier. If SHELL is selected, this field contains the command that needs to be executed from a shell. |
 
|
display_name |
varchar(64) |
NULL |
name for this action. |
 
|
description |
varchar(128) |
NULL |
text explaining the purpose of this action. |
 
|
is_system |
int |
NULL |
true/false. iCanProvision comes with some in-built rule actions for certain rules. These are system rule actions. |
 
|
rule_id |
varchar(50) |
NULL |
non-displayable id used in the backend as a reference between tables. |
 
|
options |
varchar(128) |
NULL |
Specifies the options for the rule action |
 
|
exec_mode |
int |
NULL |
Specifies the execution mode |
 
|
timeout |
int |
NULL |
Specifies the time out of the rule action |
 
|
status |
int |
NOT NULL |
Specifies the status of the rule action |
usm_rule_condition |
When adding a rule, there is an option to specify an event filter. Any event filters defined from this section for a particular rule are stored in this table . For a rule to trigger, all the rule conditions associated with that rule need to be satisfied. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
rule_condition_id |
varchar(50) |
NOT NULL |
non-displayable id used in the backend as a reference between tables. |
 
|
condition |
varchar(64) |
NULL |
SQL type String containing the event filter. |
 
|
class |
varchar(256) |
NULL |
Specifies the class of rule condition |
 
|
db_id |
varchar(20) |
NULL |
Handle to the database |
 
|
description |
varchar(128) |
NULL |
Descriptive text for this rule condition |
 
|
display_name |
varchar(64) |
NULL |
Display name of this condition |
 
|
is_hidden |
int |
NULL |
If this condition is a hidden or not |
 
|
is_system |
int |
NULL |
Specifies if this is a system manadated condition or not |
 
|
type |
nvarchar(64) |
NULL |
table or class on which the above SQL query needs to be executed to check the condition in the event filter. |
 
|
rule_id |
varchar(50) |
NULL |
non-displayable id used in the backend as a reference between tables. |
usm_rule_event_param |
Rule event param is the event parameter information of event notifications that the system can support.
Rule event param specifies the list of parameter information for each event type
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_param_id |
varchar(50) |
NOT NULL |
Unique Event Param ID |
 
|
event_type_id |
varchar(50) |
NOT NULL |
non-displayable id used in the backend as a reference between tables. |
 
|
event_param_name |
nvarchar(64) |
NOT NULL |
Name for the event parameter |
 
|
event_param_data_type |
int |
NOT NULL |
Data type for the event parameter |
usm_rule_event_type |
Rule event type is the type of event notifications the system can support.
Rule event type specifies the list of system level notification than can happen.
Eg. USER CREATE, SUBSCRIPTION CHANGE etc
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_type_id |
varchar(50) |
NOT NULL |
non-displayable id used in the backend as a reference between tables. |
 
|
display_name |
varchar(64) |
NULL |
displayable name of the event type |
 
|
description |
varchar(128) |
NULL |
short text explaining the nature of the event type |
 
|
class |
nvarchar(20) |
NULL |
contains the component to which this event type belongs to. For example, REGISTRY, DATABASE or LOGICAL. |
 
|
params |
varchar(64) |
NULL |
a comma-separated list of parameters associated with this event type. When an event is thrown, the parameters and their values need to be packaged as part of the event so that the action can use them to provision external systems. For example, a USER_CREATE event would contain the user id, first name, last name etc. |
 
|
event_name |
varchar(64) |
NULL |
type of event. ADDED, MODIFIED, DELETED etc. |
 
|
nsp_path |
varchar(128) |
NULL |
name of the table or class this event originated from. For example, for a USER_CREATE event, the table or class that gets affected is the icuser class in the Registry. |
 
|
is_system |
int |
NULL |
Denotes if this event type is an external event defined by the user on a internal event such as USER_CREATE event. |
 
|
eventq_id |
varchar(50) |
NULL |
qid of the event processing Queue. |
 
|
event_dependency |
int |
NULL |
string defining the dependency of this event type on other event types. This string requires a combination of the iceventtypeid, icnsppath and iceventname fields to identify the event dependency. |
 
|
installed_subcomponent_id |
varchar(50) |
NULL |
Handle to the installed sub component to indicate if which installed sub component is responsible for this rule event type |
 
|
save_level |
int |
NULL |
Specifies the save level |
usm_runtime_application |
Defines a Web based runtime application which is based on an USM Application being served and can be single singed on into. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
runtime_application_id |
varchar(50) |
NOT NULL |
Unique identity for the runtime application |
 
|
schema_id |
integer |
NULL |
The schema to which th e runtime application belongs |
 
|
comment |
varchar(64) |
NULL |
A comment |
 
|
major_version |
varchar(256) |
NULL |
Versioning info |
 
|
minor_version |
varchar(20) |
NULL |
Versioning info |
 
|
name |
varchar(64) |
NULL |
The name of the runtime application |
 
|
param_form |
varchar(64) |
NULL |
These are the form parameters for the runtime application. Eg: METHOD = GET etc |
 
|
param_input |
varchar(64) |
NULL |
These ar the input parameters which have to be passed on to the end application |
 
|
param_login |
varchar(50) |
NULL |
This is the place holder which specifies what is the parameter for login field |
 
|
param_password |
varchar(128) |
NULL |
This is the place holder which specifies what is the parameter for the password field |
 
|
param_script |
varchar(1024) |
NULL |
related parameter script |
 
|
runtime_parameters |
varchar(64) |
NULL |
runtime parameter |
 
|
status |
int |
NULL |
status for the runtime application |
 
|
url |
varchar(64) |
NULL |
This is the URL for the external application |
 
|
type |
varchar(256) |
NULL |
the runtime application type |
 
|
param_domain |
varchar(50) |
NULL |
This is the place holder which specifies what is the parameter for domain field |
 
|
file_name |
varchar(64) |
NULL |
This is the file name which has the image to be shown for this single sign on application |
 
|
schema_instance_id |
varchar(50) |
NULL |
The schema instance(installed app instance) for this runtime application |
 
|
comments |
varchar(64) |
NOT NULL |
description for the field. Field name "comment" has been changed to "comments" to support oracle |
usm_runtime_component |
Defines each runtime component which is will run on the system |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
runtime_component_id |
varchar(50) |
NOT NULL |
Unique id for the runtime component |
 
|
class |
varchar(64) |
NULL |
The java class name for the runtime application |
 
|
name |
varchar(64) |
NULL |
The name of the runtime component |
 
|
type |
varchar(20) |
NULL |
Specifies the component type |
 
|
installed_component_id |
varchar(50) |
NULL |
handle to the installed component id |
 
|
db_id |
varchar(50) |
NULL |
handle to the database id |
usm_runtimecomp_parameter |
Place holder for the different parameters for the runtime component |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
runtime_component_id |
varchar(50) |
NOT NULL |
ID(FK) to runtime component |
 
|
runtime_parameter |
varchar(64) |
NOT NULL |
ID(FK) to runtime component parameter |
usm_schema |
Defines an application type with version and other configuration.
icsloruleinfo is replaced with a new link table link_apptype_slorule.( many -many)
icmetricinfo is replaced with a new link table link_apptype_metric.( many -many)
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
schema_id |
int |
NOT NULL |
Unique identity of the schema |
 
|
major_version |
varchar(20) |
NULL |
Versioning info |
 
|
minor_version |
varchar(20) |
NULL |
Versioning info |
 
|
description |
varchar(128) |
NULL |
A description of the schema |
 
|
name |
varchar(64) |
NULL |
A name of the schema |
 
|
requestor |
varchar(20) |
NULL |
  |
 
|
comment |
nvarchar(64) |
NULL |
A description of the schema |
 
|
comments |
nvarchar(64) |
NULL |
description for the field. Field name "comment" has been changed to "comments" to support oracle |
usm_schema_comp |
Defines a schema component.
Eg--winword.exe, excel.exe, apache.exe
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
schema_comp_id |
int |
NOT NULL |
Unique identity of the schema component |
 
|
name |
varchar(64) |
NULL |
Name of the schema component |
 
|
comment |
varchar(64) |
NULL |
A comment of the component |
 
|
gui_cfg |
varchar(32) |
NOT NULL |
  |
 
|
comments |
varchar(64) |
NOT NULL |
description for the field. Field name "comment" has been changed to "comments" to support oracle |
usm_schema_instance |
This is the installed instance of the schema |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
schema_instance_id |
varchar(50) |
NOT NULL |
Unique identity of the schema instance/installed instance |
 
|
schema_id |
int |
NULL |
Identifies the schema installed. |
usm_scope |
A scope identifies a set of metrics/metric categories with a similar set of characteristics. A scope also identifies the analyses that can be performed on the metric instances within a scope. This is done through the link to usm_link_scope_layout and usm_analyze_function.
In r11, the analyze functions will be used to create analyses, and not layouts.
Scopes may be hierarchical, but in r11 they probably will not.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
scope_id |
integer |
NOT NULL |
Unique identity for the scope |
 
|
level |
integer |
NULL |
The scope may be hierarchical. If so, the level tag identifies which level in the tree the scope is on. 0 means root. |
 
|
parent_path |
varchar(255) |
NULL |
If the scope is hierarchical, this attribute specifies a scope_id list separated by /. The list includes the scope_id of the parent, but not itself.
A scope on the root level has a parent path of /.
|
 
|
label |
nvarchar(100) |
NULL |
The label of the scope. |
 
|
label_bundle_key |
varchar(50) |
NULL |
A bundle key for the label. If the label is NULL, the bundle key is used to create an language depentent text for the scope.
label_bundle_keys will typically be used for out-of-the-box scopes.
|
 
|
analyze_function_id |
integer |
NULL |
Unique identifyer for the analyze function that this scope supports.
A scope may only support one analyze function.
|
 
|
unit |
nvarchar(50) |
NULL |
The unit. |
 
|
tree_level |
int |
NULL |
The scope may be hierarchical. If so, this specifies the level of the tree. |
usm_search_node |
Defines the control for the search pages. The bucket search API used the searchnode implementation to do various searches |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
search_node_id |
varchar(50) |
NOT NULL |
The unique id for the search implementation |
 
|
params |
varchar(4000) |
NULL |
params is the list of parameters delimited by space |
 
|
search_limit |
int |
NULL |
The max limit on the number of results to be searched, -1 is for no limit |
 
|
default_param |
varchar(128) |
NULL |
The default parameter to fetch and show the results |
 
|
bucket_size |
int |
NULL |
To fetch the results in a batch mode, to display limited results on a page, Eg: 1 to 50, 50 to 100 etc |
 
|
table_name |
varchar(64) |
NULL |
table_names is the list of tables delimited by space |
 
|
order_by |
varchar(128) |
NULL |
The sort order for the search query |
 
|
param_domain |
varchar(64) |
NULL |
The table.column which has the domian information, to do business level validation checks |
 
|
param_parent_domain |
varchar(64) |
NULL |
The table.column which has the parent domian information, to do business level validation checks |
 
|
criteria |
varchar(64) |
NULL |
The default where clause for the query |
usm_security |
This table holds the security mapping for the resouces and the access control lists. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
object_id |
varchar(64) |
NOT NULL |
Object ID for the resource |
 
|
object_type |
varchar(128) |
NOT NULL |
Type of the resource object
<i.e.>usm_report_data, usm_report_layout, usm_portal_template, usm_webservice, usm_launchpad, usm_asset, usm_guinode
|
 
|
owner_check |
bit |
NOT NULL |
Owner Check 0/1 |
 
|
acl_id |
varchar(64) |
NOT NULL |
ID for the access control list |
usm_server |
Defines the servers that are available like mail server, print server etc |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
server_id |
int |
NOT NULL |
  |
 
|
comment |
varchar(64) |
NULL |
  |
 
|
display_name |
varchar(64) |
NULL |
  |
 
|
host_name |
varchar(64) |
NULL |
  |
 
|
timeout |
int |
NULL |
  |
 
|
type |
varchar(256) |
NULL |
  |
 
|
port_no |
int |
NULL |
  |
 
|
login_id |
varchar(64) |
NULL |
  |
 
|
password |
varbinary |
NULL |
  |
 
|
comments |
varchar(64) |
NOT NULL |
description for the field. Field name "comment" has been changed to "comments" to support oracle |
usm_service_desk_priority |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
priority_id |
int |
NOT NULL |
  |
 
|
description |
nvarchar(128) |
NULL |
  |
usm_service_desk_ticket |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
service_desk_ticket_id |
int |
NOT NULL |
  |
 
|
ticket_id |
int |
NOT NULL |
  |
 
|
ticket_name |
nvarchar(128) |
NOT NULL |
  |
 
|
server_id |
integer |
NULL |
Unique identifier for one slm server |
 
|
priority_id |
int |
NOT NULL |
  |
 
|
description |
nvarchar(255) |
NULL |
  |
 
|
message |
nvarchar(255) |
NULL |
  |
 
|
problem_type |
nvarchar(255) |
NULL |
  |
 
|
status |
nvarchar(128) |
NULL |
  |
 
|
start_date |
int |
NULL |
  |
 
|
open_date |
int |
NULL |
  |
 
|
resolve_date |
int |
NULL |
  |
 
|
close_date |
int |
NULL |
  |
usm_service_event |
Service events are used in SLM analyses to comment or remove down events within given time intervals.
Service events can be added directly, or they can be exported from a associated calendar category.
Manually added service events are associated with metric instances using usm_link_service_event_metric_instance. Calendar exported service events are mapped to a report group(or contract) using usm_link_service_event
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
service_event_id |
integer |
NOT NULL |
Unique identifier |
 
|
description |
nvarchar(255) |
NULL |
Description of the service event |
 
|
start_time |
integer |
NULL |
Epoch start time of the service event |
 
|
stop_time |
integer |
NULL |
Epoch stop time of the service event |
 
|
created |
integer |
NULL |
Time of creation in epoch |
 
|
modified |
integer |
NULL |
Time when last modified, in epoch |
 
|
category |
int |
NULL |
0 - Remove outage with comment - will not be used in r11
1- Comment only - previously provider responsible
3- Remove outage without comment - previously known as provider responsible
|
 
|
calendar_oid |
varchar(256) |
NULL |
Unique identity of the calendar |
 
|
event_category_oid |
varchar(256) |
NULL |
Unique identity of the event category |
 
|
onetime_event_oid |
varchar(20) |
NULL |
If the service event is exported from a calendar category and represents a onetime_event, this points to the given onetime event. |
 
|
recurring_event_oid |
varchar(20) |
NULL |
If the service event is exported from a calendar category and is derived from a recurring event, this points to the recurring event. Otherwise it is NULL. |
usm_service_goal |
The default service goals. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
service_goal_id |
integer |
NOT NULL |
Uniquely identifies the |
 
|
label |
nvarchar(100) |
NULL |
The label of the service goal |
 
|
label_bundle_key |
varchar(50) |
NULL |
Bundle key for the label. Used if label is null |
 
|
description |
nvarchar(255) |
NULL |
Description for service goal |
 
|
descr_bundle_key |
varchar(50) |
NULL |
Bundle key for description. Used if description is null. |
 
|
properties |
bit |
NULL |
Gives the properties, in binary format
properties & 1 == 1 : required
properties & 2 == 1 : editable
properties & 4 == 1 : hidden
|
 
|
default_value |
varchar(255) |
NULL |
Default value for the service goal |
 
|
minval |
varchar(255) |
NULL |
Minimum allowed value for service goal values |
 
|
maxval |
varchar(255) |
NULL |
Maximum value for service goal values. |
 
|
orientation |
bit |
NULL |
# 0: no orientation
# 1: less than
# 2: less or equal
# 3: greater or equal
# 4: greater than
|
 
|
name |
nvarchar(100) |
NOT NULL |
Purpose of the field is to have a string to match against for our data import system. When new metrics are added through the data import, we need this to check if the service goal is already defined.
|
usm_service_goal_values |
A set of legal service goal values for a given service goal |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
service_goal_id |
integer |
NOT NULL |
Uniquely identifies the |
 
|
value |
varchar(50) |
NOT NULL |
An allowed service goal value |
usm_service_hours |
Contains the service hours for a report group. If service hours are not defined for a given day, the default service hours applies. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
report_group_id |
int |
NOT NULL |
Unique identity for the report group |
 
|
day_name |
nvarchar(15) |
NOT NULL |
The valid day for the service hous
Values:
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
- sunday
|
 
|
start_time |
integer |
NULL |
The start time in seconds since 00.00 |
 
|
end_time |
integer |
NULL |
The end time in seconds since 00:00 |
 
|
created |
integer |
NULL |
Epoch time of creation |
usm_serviceconfig |
When a contract is created an entry is created in serviceconfig for the resource and it needs to be provisioned. This entry has details on which engine is responsible for aggregation and which application instance and metric instance are used.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
serviceconfig_id |
varchar(50) |
NOT NULL |
  |
 
|
time_stamp |
datetime |
NULL |
  |
 
|
comment |
varchar(64) |
NULL |
  |
 
|
partition_id |
varchar(256) |
NULL |
  |
 
|
sla_engine_id |
integer |
NULL |
Unique identifier for one slm server, in this case, the SLA engine doing the aggregation |
 
|
sla_instance_id |
int |
NULL |
  |
 
|
metric_instance_id |
int |
NULL |
Unique identifier |
 
|
schema_id |
int |
NULL |
Unique identity of the schema |
 
|
schema_instance_id |
varchar(50) |
NULL |
Unique identity of the schema instance/installed instance |
 
|
contract_id |
int |
NULL |
Unique identity for the contract |
 
|
requestor |
varchar(32) |
NOT NULL |
  |
 
|
status |
int |
NULL |
  |
 
|
slo_instance_id |
int |
NULL |
  |
 
|
account_id |
varchar(50) |
NULL |
Unique ID of the account |
 
|
metric_category_id |
integer |
NULL |
Unique identity identifying the metric category |
 
|
subscription_detail_id |
integer |
NULL |
the unique id for each subscription record |
 
|
comments |
nvarchar(64) |
NULL |
  |
 
|
resource_name |
nvarchar(128) |
NULL |
resource name |
usm_settlement |
Settlements are special type of adjustments, they are not used in the current billing system
This table is deprecated. ( We are not using this table from R11.0)*
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
settlement_no |
integer |
NOT NULL |
Settlement ID |
 
|
adjustment_id |
integer |
NULL |
All adjustments are recorded here and then applied to the accounts when they are invoiced in a bill run.
When adjustment_type=0 (general adjustment) and value_type=0 (fixed amount):
" enum_1 = billing cycle (0=onetime, 1=periodic, 2=every invoice)
" enum_2 = periodic type (0=NA,1=daily,2=weekly,3=monthly,4=quarterly,5=yearly)
When adjustment_type=0 (general adjustment) and value_type=1 (percentage):
" enum_1 = billing cycle (0=onetime, 2=every invoice)
" enum_2 = periodic type (0=NA)
" enum_3 = apply adjustment to (1=offering,2=rate column, 3=all charges, 4=total invoice amount)
" enum_4 = select offering ( when enum_3=1 or 2, then this is the offering_id )
" enum_5 = select rate column ( when enum_3=2, then this is the item_id of the column header rate item)
" enum_6 = percent of ( when enum_3=2, then 0=Quantity, 1=UnitCost, 2=Cost)
|
 
|
domain |
varchar(50) |
NOT NULL |
  |
 
|
settle_account |
varchar(50) |
NULL |
  |
 
|
settle_domain |
varchar(50) |
NOT NULL |
  |
 
|
settle_user |
nvarchar(128) |
NULL |
  |
 
|
type |
integer |
NOT NULL |
  |
 
|
status |
integer |
NOT NULL |
  |
 
|
recorded_date |
date |
NOT NULL |
  |
 
|
unsettled_date |
date |
NULL |
  |
 
|
settled_date |
date |
NULL |
  |
 
|
amount |
float |
NULL |
  |
 
|
amount_settled |
float |
NULL |
  |
 
|
show_on_invoice |
integer |
NOT NULL |
  |
 
|
enum_1 |
integer |
NULL |
  |
 
|
enum_2 |
integer |
NULL |
  |
 
|
comments |
nvarchar(128) |
NULL |
description for the field. Field name "comment" has been changed to "comments" to support oracle |
 
|
account_no |
varchar(50) |
NULL |
The account number associated to the billing_account. |
usm_sla_calendar |
request sla service hour object, which includes, event_group =1, outage calendar=2, business hour=3. Outage calendar can include event group other than events
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
calendar_id |
varchar(128) |
NOT NULL |
Outage Calendar ID (Calendar ID or Business Hour ID) |
 
|
calendar_type |
tinyint |
NOT NULL |
Outage Calendar Type (Outage Event Group = 0/Business Hour=1/Outage Calendar = 2) |
 
|
calendar_name |
nvarchar(128) |
NOT NULL |
Outage Calendar Name |
 
|
calendar_desc |
nvarchar(512) |
NULL |
Outage Calendar Description |
 
|
domain |
varchar(50) |
NULL |
The unique tenantid that identifies this organization/tenant |
 
|
created_date |
datetime |
NULL |
created date |
 
|
last_modified_date |
datetime |
NULL |
last modified date |
usm_sla_calendar_group |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
parent_calendar_id |
varchar(128) |
NOT NULL |
Outage Calendar ID (Calendar ID or Business Hour ID) |
 
|
calendar_id |
varchar(128) |
NOT NULL |
Outage Calendar ID (Calendar ID or Business Hour ID) |
usm_sla_config |
Defines the configuration for an SLA instance. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
sla_config_id |
varchar(50) |
NOT NULL |
  |
 
|
name |
varchar(64) |
NULL |
  |
 
|
last_run |
datetime |
NULL |
  |
 
|
port_no |
int |
NULL |
  |
 
|
status |
int |
NULL |
  |
 
|
param |
varchar(64) |
NULL |
  |
 
|
data1 |
varchar(64) |
NULL |
  |
 
|
data2 |
varchar(64) |
NULL |
  |
 
|
data3 |
varchar(64) |
NULL |
  |
 
|
data4 |
varchar(64) |
NULL |
  |
 
|
host_id |
int |
NULL |
The identity of the host. |
usm_sla_event |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
event_id |
varchar(128) |
NOT NULL |
Outage Event ID |
 
|
event_type |
tinyint |
NOT NULL |
One Time Event = 1, Recurreing Event = 2 |
 
|
start_time |
bigint |
NOT NULL |
Start Time |
 
|
end_time |
bigint |
NULL |
End Time |
 
|
event_duration |
bigint |
NULL |
Durations in seconds, of one recurring occurrence for this recurrring event series. |
 
|
event_time_zone |
varchar(64) |
NOT NULL |
Outage Event Time Zone |
 
|
event_name |
nvarchar(256) |
NOT NULL |
Outage Event Name |
 
|
event_pattern |
varchar(256) |
NULL |
Outage Event Pattern (y=yearly/m=monthly/w=weekly/d=daily/h=hourly/minute=minutely) |
 
|
event_desc |
nvarchar(512) |
NULL |
Outage Event Description |
 
|
created_time |
datetime |
NULL |
created time stamp |
 
|
domain |
varchar(50) |
NULL |
The unique tenantid that identifies this organization/tenant |
 
|
last_modified_date |
datetime |
NULL |
last modified date |
usm_sla_instance |
Service Level Aggreement Package Definition - defines an SLA package which is tied to an application. This groups a bunch of the icslo objects to create a package.
aggregationtype is made single valued, hence use delimited sepreated list
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
sla_instance_id |
int |
NOT NULL |
  |
 
|
text_slo |
varchar(64) |
NULL |
  |
 
|
aggregation_type |
varchar(64) |
NULL |
icaggregationtype is made single valued, hence use delimited sepreated list |
 
|
tenant_id |
varchar(50) |
NULL |
The unique tenantid that identifies this organization/tenant |
 
|
description |
varchar(128) |
NULL |
  |
 
|
status |
int |
NULL |
  |
 
|
package_type |
varchar(20) |
NULL |
  |
 
|
schema_id |
int |
NULL |
The associated schema |
 
|
last_update |
datetime |
NULL |
  |
usm_sla_metric_instance |
This table provides a many-many relationship between a metric instance and an sla.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
sla_metric_instance_id |
integer |
NOT NULL |
Unique identity for the sla_metric_instance entity
|
 
|
sla_instance_id |
int |
NULL |
The identity of the associated sla instance |
 
|
sla_config_id |
varchar(50) |
NULL |
The identity of the sla configuration |
 
|
slo_instance_id |
int |
NULL |
The identity of the associated slo_instance |
 
|
metric_instance_id |
int |
NULL |
Unique identifier for the associated metric instnace |
 
|
use_calendar_events |
c(1) |
NULL |
To be removed |
 
|
contract_id |
int |
NULL |
Unique identity for the contract |
 
|
dm_profile_id |
int |
NULL |
  |
usm_slm_server |
Represents various slm servers running on a host somewhere. Each server has an associated table with configuration information and another giving the state of the server.
Such servers can be DC Hubs, DC Servers, SLA engines for example.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
server_id |
integer |
NOT NULL |
Unique identifier for one slm server |
 
|
host_id |
int |
NULL |
The host on which this server runs. |
 
|
server_type_id |
integer |
NULL |
Unique identity of the server type |
usm_slm_server_config |
Configuration attribute for a slm server. One slm server may have multiple configuration attributes. Each attribute has a name and a value and is associated with a usm_slm_server. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
server_config_id |
integer |
NOT NULL |
Unique identity for this configuration |
 
|
name |
varchar(50) |
NULL |
Name of the configuration attribute |
 
|
value |
nvarchar(1023) |
NULL |
Value of the configuration attribute |
 
|
server_id |
integer |
NULL |
The slm server for which this configuration attribute applies. |
usm_slm_server_status |
The status of an SLM server. The status is updated by a separate process monitoring each slm server.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
server_status_id |
integer |
NOT NULL |
Unique identifier |
 
|
value |
varchar(20) |
NULL |
The status value.
Values for the following statuses should be supported.
Suspended
Undefined
Normal
Warning
Stopped
Deleted(may not be used)
Minor
Major
Critical
How the values are represented, as int or strings are yet to be defined. Other status values may be defined
|
 
|
server_id |
integer |
NULL |
The server for which this status applies |
 
|
type |
integer |
NULL |
Type of status.
|
usm_slm_server_status_type |
List of known status types for a server.
The following types should be defined. Others may also be defined
- disk
- cpu
- connection
- process
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
server_status_type_id |
integer |
NOT NULL |
Unique identifier |
 
|
description |
nvarchar(255) |
NULL |
Description of the status type |
usm_slm_server_type |
This entity defines the various server types available in the system
- DC Hub
- The various collector types
- DC Server
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
server_type_id |
integer |
NOT NULL |
Unique identity of the server type |
 
|
name |
varchar(100) |
NULL |
The name of the server type. |
usm_slm_server_type_spec |
The attribute specification for a server type. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
slm_server_type_spec_id |
integer |
NOT NULL |
Specification of attributes for a server type. |
 
|
attribute_name |
varchar(50) |
NULL |
The name of the attribute |
 
|
type |
varchar(50) |
NULL |
  |
 
|
label_bundle_key |
varchar(50) |
NULL |
The label bundle key, used to present the label if the label itself is NULL |
 
|
label |
nvarchar(100) |
NULL |
The label of the attribute |
 
|
default_value |
nvarchar(255) |
NULL |
The default value of the attribute |
 
|
is_required |
c(1) |
NULL |
'Y' - attribute is required
'N' or NULL, attribute is not required.
|
 
|
server_type_id |
integer |
NULL |
The associated server type for which this spec is valid. |
usm_slm_server_type_value |
Identifies the legal values for a server type specification attribute. Used for for example selection type of attributes. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
slm_server_type_spec_id |
integer |
NOT NULL |
Specification of attributes for a server type. |
 
|
value |
nvarchar(255) |
NOT NULL |
The legal value of the attribute. |
usm_slo_data |
Contains aggregated slo data. One entry pr. report interval pr slo_instance for each sla/contract |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
time_stamp |
datetime |
NOT NULL |
  |
 
|
sla_engine_id |
integer |
NULL |
  |
 
|
pkg_id |
integer |
NULL |
  |
 
|
app_user |
varchar(64) |
NULL |
  |
 
|
state0 |
integer |
NULL |
  |
 
|
category |
integer |
NULL |
  |
 
|
state1 |
integer |
NULL |
  |
 
|
state2 |
integer |
NULL |
  |
 
|
status |
integer |
NULL |
  |
 
|
value |
float |
NULL |
  |
 
|
final |
integer |
NULL |
  |
 
|
slo_instance_id |
int |
NULL |
  |
 
|
contract_id |
int |
NULL |
  |
 
|
host_id |
int |
NULL |
  |
 
|
ts_sec |
int |
NULL |
  |
usm_slo_event |
Contains service violations. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
time_stamp |
datetime |
NOT NULL |
  |
 
|
sla_engine_id |
integer |
NULL |
  |
 
|
text_id |
c(36) |
NULL |
  |
 
|
locale |
c(4) |
NULL |
  |
 
|
host_name |
varchar(128) |
NULL |
  |
 
|
pkg_id |
integer |
NULL |
  |
 
|
app_name |
nvarchar(128) |
NULL |
  |
 
|
category |
integer |
NULL |
  |
 
|
unit |
varchar(32) |
NULL |
  |
 
|
interval |
integer |
NULL |
  |
 
|
severity |
integer |
NULL |
  |
 
|
threshold |
float |
NULL |
  |
 
|
value |
float |
NULL |
  |
 
|
app_user |
varchar(64) |
NULL |
  |
 
|
final |
integer |
NULL |
  |
 
|
contract_id |
int |
NULL |
  |
 
|
host_id |
int |
NULL |
  |
 
|
slo_instance_id |
int |
NULL |
  |
 
|
ts_sec |
int |
NULL |
  |
usm_slo_instance |
Defines a Service Level Objective which is part of the SLA package |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
slo_instance_id |
int |
NOT NULL |
  |
 
|
check_interval |
varchar(10) |
NULL |
  |
 
|
level |
int |
NULL |
  |
 
|
operator |
varchar(8) |
NULL |
  |
 
|
report_interval |
int |
NULL |
  |
 
|
slo_type |
varchar(4) |
NULL |
  |
 
|
threshold |
float |
NULL |
  |
 
|
unit |
nvarchar(20) |
NULL |
  |
 
|
group_user |
int |
NULL |
  |
 
|
sla_instance_id |
int |
NULL |
THe sla instance to which this slo instance belongs |
 
|
metric_category_id |
integer |
NULL |
Unique identity identifying the metric category |
 
|
sla_config_id |
varchar(50) |
NULL |
The sla configuration |
 
|
slo_template_id |
int |
NULL |
Identity of the SLO template.
Values < 1.000.000 are statically defined.
Dynamically assigned values should start at 1.000.000.
|
 
|
slo_weight |
int |
NULL |
  |
 
|
pkg_level |
int |
NULL |
  |
usm_slo_package |
Package of SLO templates.
aggregationtype is made single valued, hence use delimited sepreated list
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
slo_package_id |
int |
NOT NULL |
  |
 
|
major_version |
varchar(20) |
NULL |
  |
 
|
minor_version |
varchar(20) |
NULL |
  |
 
|
name |
varchar(64) |
NULL |
  |
 
|
package_name |
varchar(64) |
NULL |
  |
 
|
schema_id |
int |
NULL |
The schema to which this package belongs. |
 
|
aggregation_type |
varchar(50) |
NOT NULL |
icaggregationtype is made single valued, hence use delimited sepreated list |
usm_slo_template |
Defines a service level offering rule based on an SLO |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
slo_template_id |
int |
NOT NULL |
Identity of the SLO template.
Values < 1.000.000 are statically defined.
Dynamically assigned values should start at 1.000.000.
|
 
|
check_interval |
int |
NULL |
  |
 
|
comment |
varchar(64) |
NULL |
  |
 
|
description |
varchar(128) |
NULL |
  |
 
|
level |
int |
NULL |
  |
 
|
operator |
varchar(4) |
NULL |
  |
 
|
report_interval |
int |
NULL |
  |
 
|
threshold |
float |
NULL |
  |
 
|
unit |
nvarchar(50) |
NULL |
  |
 
|
warning_text |
varchar(64) |
NULL |
  |
 
|
violation_text |
varchar(64) |
NULL |
  |
 
|
group_user |
int |
NULL |
  |
 
|
request_type |
int |
NULL |
  |
 
|
aggregation_rule_id |
int |
NULL |
  |
 
|
show_smreport |
int |
NULL |
  |
 
|
metric_category_id |
integer |
NULL |
Unique identity identifying the metric category |
 
|
slo_weight |
int |
NULL |
  |
 
|
comments |
nvarchar(1024) |
NULL |
  |
 
|
pkg_level |
int |
NULL |
  |
usm_slo_template_sla_config |
This table is the placeholder for the SLO template's SLA configuration |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
slo_template_id |
int |
NOT NULL |
Identity of the SLO template.
Values < 1.000.000 are statically defined.
Dynamically assigned values should start at 1.000.000.
|
 
|
sla_config_id |
varchar(50) |
NOT NULL |
  |
 
|
aggregation_type |
integer |
NOT NULL |
  |
usm_slo_threshold |
  |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
slo_threshold_id |
int |
NOT NULL |
  |
 
|
slo_instance_id |
int |
NULL |
  |
 
|
threshold |
float |
NULL |
  |
 
|
threshold_type |
int |
NULL |
  |
 
|
threshold_order |
int |
NULL |
  |
usm_sm_comp |
This table has information on which schema component is installed on which host and for which metric instance.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
sm_request_id |
int |
NOT NULL |
Unique identity |
 
|
sm_target |
varchar(64) |
NULL |
  |
 
|
metric_instance_id |
int |
NULL |
Unique identifier |
 
|
inst_host_id |
int |
NULL |
The identity of the host. |
 
|
schema_comp_id |
int |
NULL |
Associated schema component |
usm_sm_event |
Events sent to assure for analysis are stored in this table. Host and contract service events are also stored in this table.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
ts_sec |
int |
NOT NULL |
  |
 
|
sla_engine_id |
integer |
NULL |
  |
 
|
app_user |
varchar(64) |
NULL |
  |
 
|
interval |
integer |
NULL |
  |
 
|
value |
float |
NULL |
  |
 
|
time_stamp |
datetime |
NULL |
  |
 
|
data1 |
integer |
NULL |
  |
 
|
data2 |
varchar(64) |
NULL |
  |
 
|
sla_instance_id |
int |
NULL |
  |
 
|
contract_id |
int |
NULL |
  |
 
|
host_id |
int |
NULL |
  |
 
|
slo_instance_id |
int |
NULL |
  |
 
|
metric_category_id |
int |
NULL |
  |
 
|
recurring_event_oid |
varchar(20) |
NULL |
Not used in r11 |
 
|
onetime_event_oid |
varchar(20) |
NULL |
Not used in r11 |
 
|
calendar_category_oid |
varchar(20) |
NULL |
Not used in r11 |
 
|
insert_time |
int |
NULL |
  |
usm_snmp_config |
The snmp_config table is used by the snmp collector. The table contains information needed by an snmp agent for selecting snmp version, community string and so on.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
target |
varchar(50) |
NOT NULL |
destination host/network.
Can contain one special value, named 'default' that applies to destinations not specified.
|
 
|
community |
varchar(50) |
NOT NULL |
the snmp community string |
 
|
retries |
integer |
NOT NULL |
number of retries |
 
|
timeout |
integer |
NOT NULL |
The timeout in seconds |
 
|
netmask |
varchar(20) |
NULL |
if target is host, netmask is 255.255.255.255, else the target is a network. |
 
|
snmp_version |
varchar(50) |
NOT NULL |
snmp protocol version |
 
|
username |
varchar(100) |
NULL |
username if snmp version needs username authentications |
 
|
password |
varchar(100) |
NULL |
password for authentication if needed |
 
|
privacyPassword |
varchar(100) |
NOT NULL |
  |
 
|
securityLevel |
varchar(256) |
NOT NULL |
  |
usm_statement |
Contains all items associated to a particular invoice. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
statement_id |
integer |
NOT NULL |
unique id that identifies each invoice. This will change in the near future such that every statements record will be unqiue based on the account_no and the statement_id |
 
|
statement_label |
nvarchar(128) |
NULL |
a unique invoice identifier, such as an invoice number, that is comprised of the tenant id, account_label, and the statement_id |
 
|
account_type |
integer |
NOT NULL |
0=Open Item, 1=Balance Forward. This is the same value of the billing_account.account_type that is stored here to at the time this invoice was created for that account |
 
|
invoice_history_id |
integer |
NULL |
a pointer to the invoice_history record that this invoice is associated to. In other words, this tells iCanBill what bill run this invoice was created for |
 
|
domain |
varchar(50) |
NOT NULL |
This is the tenant ID of the account |
 
|
parent_domain |
varchar(50) |
NOT NULL |
This is the parent tenant ID, the value of this field is always either a Supert Tenant, Service Provider, or empty in the case when domain is the value of the Service Provider. |
 
|
invoice_date |
date |
NULL |
the date the invoice was generated |
 
|
status |
integer |
NULL |
0=delete, 1=zero balance (or paid), 2=debit balance (or balance remaining), 3=credit balance |
 
|
status_reason |
nvarchar(128) |
NULL |
currently not used |
 
|
due_date |
date |
NULL |
the date payment is due for this invoice. This is set by taking the billing_account.days_due and adding it to the invoice_date |
 
|
tax_amount |
float |
NULL |
currently not used |
 
|
debit_amount |
float |
NULL |
the new debits on the invoice |
 
|
credit_amount |
float |
NULL |
the new credits on this invoice |
 
|
account_debit_amount |
float |
NULL |
the old debits from the account balance, from billing_account.debit_amount |
 
|
account_credit_amount |
float |
NULL |
the old credits from the account balance, from billing_account.credit_amount |
 
|
period_to |
date |
NULL |
the billing account |
 
|
period_from |
date |
NULL |
the billing account |
 
|
violations |
integer |
NULL |
the number of SLA violations that occured in this the invoiced billing period |
 
|
purchase_order_no |
nvarchar(30) |
NULL |
retrieved from billing_account.purchase_order_no and stored here to display on the invoice |
 
|
invoice_loc |
nvarchar(512) |
NULL |
the location of the invoice on the hard drive. If none is specified then the data for the invoice is always fetched from the database |
 
|
comments |
nvarchar(128) |
NULL |
currently not used |
 
|
account_no |
varchar(50) |
NULL |
The account number associated to the billing_account. |
usm_stylesheet |
Defines the style sheet that specifies the style for portal components |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
stylesheet_id |
varchar(50) |
NOT NULL |
The unique id for the style sheet |
 
|
name |
varchar(64) |
NULL |
Name of the stylesheet |
 
|
url |
varchar(64) |
NULL |
The relative path for the stylesheet |
 
|
type |
varchar(20) |
NULL |
The type of the style sheet, Eg: DashBoardItem etc |
usm_subscription_detail |
all the subscription information
the values for the overloaded fields for the subscription_details supplied out-of-the-box.
When subscription_type = 0
" text_5 = the unit cost text for display
" enum_1 = pointer to another subscription_details record for looking up other subscription info, such as user specified quantity, etc.
" numeric_1 = user defined quantity
" numeric_2 = unit cost used for calculations
When subscription_type = 1
" text_1 = application id
" text_2 = application name
" text_3 = service config id
" text_5 = the unit cost text for display
" enum_1 = metric ID
" enum_2 = offset used in making queries to the SM result tables.
" numeric_2 = unit cost used for calculations
When subscription_type = 2
" text_1 = contract ID
" text_2 = sla package name
" text_5 = the unit cost text for display
" numeric_2 = unit cost used for calculations
When subscription_type = 3
" enum_1 = the adjustment ID that the subscription was created for
" numeric_1 = quantity used when invoicing adjustment depending on the what the adjustment is applied to (ie: rate's quantity, rate's unit cost, rate's cost, etc)
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
the unique id for each subscription record |
 
|
account_no |
varchar(50) |
NOT NULL |
The account number associated to the billing_account. |
 
|
account_label |
nvarchar(128) |
NOT NULL |
the billing account label |
 
|
parent_domain |
varchar(50) |
NOT NULL |
This is the parent tenant ID, the value of this field is always either a Supert Tenant, Service Provider, or empty in the case when domain is the value of the Service Provider. |
 
|
offering_id |
integer |
NOT NULL |
the unique id for each offering. |
 
|
rate_plan_id |
integer |
NOT NULL |
the unique id for each rate plan |
 
|
item_id |
integer |
NOT NULL |
the unique id for each rate item |
 
|
status |
integer |
NOT NULL |
0=deleted, 1=pending, 2=active, 3=inactive, 4=cancelled. subsciptions to application rate items usually are first set to pending first until they are assigned to a resource. most subscriptions will be in the active state which means they will be invoiced. Inactive subscriptions are subscriptions that need to be invoiced before being cancelled. |
 
|
subscription_type |
integer |
NOT NULL |
0=subscription to general rate item such as a Rate rateitem, Numeric rateitem, Adjustment rateitem, etc. 1=subscription to an Application rate item, 2=subscription to an Agreement rate item, 3=a periodic adjustment |
 
|
instance_name |
varchar(64) |
NULL |
name that can be associated to a particular subscription instance. |
 
|
subscribed_date |
date |
NOT NULL |
the date the subscription was made |
 
|
unsubscribed_date |
date |
NULL |
the date the subscription was unsubscribed |
 
|
charge_date |
date |
NOT NULL |
the date that the subscription should begin getting charged. |
 
|
last_charge_date |
date |
NULL |
the last date the subscription was charged up to. When first subscribing, this date is the same as the charge_date, and is then incremented every bill run this subscription is invoiced. |
 
|
code |
nvarchar(64) |
NULL |
the codes of the rate items, rate plans or offerings will be persisted here during subscription |
 
|
charge |
integer |
NULL |
0=don't invoice this subscription, 1=invoice this subscription |
 
|
installments |
integer |
NULL |
number installments this subscription was invoice for to date |
 
|
tiered_item_id |
integer |
NULL |
charged tiered item ID |
 
|
tiered_last_date |
date |
NULL |
last charge date for tiered item pointed to by tiered_item_id |
 
|
text_1 |
nvarchar(50) |
NULL |
if subscription_type=1 then application id, if subscription_type=2 then contract ID, otherwise empty |
 
|
text_2 |
nvarchar(50) |
NULL |
if subscription_type=1 then application name, if subscription_type=2 then sla package name, otherwise empty |
 
|
text_3 |
nvarchar(50) |
NULL |
if subscription_type=1 then service config ID, otherwise empty |
 
|
text_4 |
nvarchar(50) |
NULL |
currently not used |
 
|
text_5 |
nvarchar(50) |
NULL |
see table comment |
 
|
text_6 |
nvarchar(50) |
NULL |
This column is not used |
 
|
text_7 |
nvarchar(50) |
NULL |
This column is not used |
 
|
enum_1 |
integer |
NULL |
see table comment |
 
|
enum_2 |
integer |
NULL |
see table comment |
 
|
enum_3 |
integer |
NULL |
currently not used |
 
|
enum_4 |
integer |
NULL |
This column is not used |
 
|
enum_5 |
integer |
NULL |
This column is not used |
 
|
numeric_1 |
float |
NULL |
see table comment |
 
|
numeric_2 |
float |
NULL |
see table comment |
 
|
request_id |
integer |
NULL |
This column consists of the Request Id associated to subscription |
 
|
request_type |
integer |
NULL |
This column consists value what type of Request it is. |
 
|
domain |
varchar(50) |
NOT NULL |
Domain to which this item belongs. |
 
|
group_id |
int |
NOT NULL |
used to groups multiple subscription_detail rows ion a tree structure in the UI |
 
|
sd_row |
int |
NULL |
The subscription detail row number within an offering, this number spans over all the rate plans within the offering. |
usm_subscription_mgmt |
Persists all the subscription management criterias such as billing in advance, date differentials, and suspensions
the values for the overloaded fields for the subscription_mgmt types supplied out-of-the-box.
When type = 0
" enum_1 = differential type. 0=no difference, 1=fixed, 2=absolute, 3=offset, 4=user
" enum_2 = day differential
" enum_3 = month differential
" enum_4 = year differential
" enum_5 = day differential value
" enum_6 = month differential value
" enum_7 = year differential value
" date_1 = fixed date of the date differential
When type = 1
" enum_1 = bill advance type. 0=no billing in advance, 1=specify billing in advance
" enum_2 = the number periods to bill in advance
When type = 4
" enum_1 = the offering id
" enum_2 = rate plan id
" enum_3 = rate item id
" enum_4 = 1 means the suspension is fully applied and will no longer be applied to new charges. 0 means keep applying
" date_1 = the start date of the suspension
" date_2 = the end date of the suspension
" date_3 = the applied date of the suspension. That is, up to what date has the suspension already been applied.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
integer |
NOT NULL |
unique id for each subscription management record |
 
|
parent_domain |
varchar(50) |
NULL |
This is the parent tenant ID, the value of this field is always either a Supert Tenant, Service Provider, or empty in the case when domain is the value of the Service Provider. |
 
|
type |
integer |
NOT NULL |
0=date differential, 1=billing in advance, 4=suspension |
 
|
scope |
integer |
NOT NULL |
0=global, 2=account label |
 
|
label |
nvarchar(128) |
NULL |
Account label when specific accounts are specified. |
 
|
subscription_type |
integer |
NOT NULL |
0=existing, 1=future, 2=both, 3=na |
 
|
subscription_item |
integer |
NOT NULL |
0=offering, 1=rate plan, 2=rate item. This specifies at what level the subscription mgmt should take effect |
 
|
subscription_item_id |
integer |
NOT NULL |
The offerings.offering_id, rate_plans.rate_plan_id, or the rate_definition.item_id of an object depending on if subscription_item is 0,1, or 2 respecively. |
 
|
status |
integer |
NOT NULL |
0=deleted, 1=active, 2=inactive |
 
|
status_date |
date |
NOT NULL |
the date the status changed |
 
|
enum_1 |
integer |
NULL |
see table comment |
 
|
enum_2 |
integer |
NULL |
see table comment |
 
|
enum_3 |
integer |
NULL |
see table comment |
 
|
enum_4 |
integer |
NULL |
see table comment |
 
|
enum_5 |
integer |
NULL |
see table comment |
 
|
enum_6 |
integer |
NULL |
see table comment |
 
|
enum_7 |
integer |
NULL |
see table comment |
 
|
date_1 |
date |
NULL |
see table comment |
 
|
date_2 |
date |
NULL |
see table comment |
 
|
date_3 |
date |
NULL |
see table comment |
 
|
domain |
varchar(50) |
NULL |
Domain to which the this item belongs. |
usm_system_alert |
Place holder for all the system alerts, alerts are generated if something goes down or something is not working properly |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
system_alert_id |
varchar(128) |
NOT NULL |
Unique id for the system alert message |
 
|
host_name |
varchar(50) |
NULL |
The affected host name for the message |
 
|
message |
nvarchar(1024) |
NULL |
The actual alert message |
 
|
tenant_id |
varchar(50) |
NULL |
The domain which is logging the message |
 
|
message_type |
varchar(50) |
NULL |
Type, INTERNAL, OS, NETWORK, STORAGE, THIRD_PARTY |
 
|
other_info1 |
nvarchar(1024) |
NULL |
Additional information for the message |
 
|
other_info2 |
nvarchar(1024) |
NULL |
Additional information for the message |
 
|
other_info3 |
nvarchar(1024) |
NULL |
Additional information for the message |
 
|
severity |
varchar(50) |
NULL |
Serverity: DOWN, CRITICAL, MAJOR, MINOR, INFORMATIONAL |
 
|
source_name |
varchar(50) |
NULL |
The source for the message, generally the system id or the userid |
 
|
time_stamp |
date |
NOT NULL |
The time stamp for the message |
 
|
user_name |
nvarchar(128) |
NULL |
User logged in to the the system when message is generated |
 
|
status |
int |
NOT NULL |
Field denotes state of a system alert. (Default should be 1 to indicate active alerts) – Soft delete should would have a value of 0, 2 should be used to ignore, 3 if the status of that particular request item was overridden. |
usm_system_change |
This table holds the basic information about the event or transaction that had taken place in the iCan System. External events from other system can also be posted to iCan system. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
varchar(128) |
NOT NULL |
non-displayable id used in the backend as a reference between tables. |
 
|
name |
nvarchar(50) |
NOT NULL |
name of the transaction. For database events, it’s the table name i.e. billing_account, icuser etc. For LOGICAL transactions, it’s a plain-text name. This entry has a logical mapping to the iceventtype.icnsppath property in the Registry. |
 
|
tran_level |
varchar(50) |
NOT NULL |
LOGICAL or DATABASE transaction. |
 
|
timestamp |
date |
NOT NULL |
time stamp the transaction took place |
 
|
type |
nvarchar(50) |
NOT NULL |
event causing this transaction entry. ADDED, MODIFIED, DELETED etc. |
 
|
description |
nvarchar(256) |
NULL |
information about the event |
 
|
host |
varchar(50) |
NULL |
hostname, which is responsible for this event |
 
|
component_name |
nvarchar(50) |
NOT NULL |
component from which this event originated from. Registry/Billing/Metering/Logical etc. |
 
|
nsp_path |
varchar(128) |
NOT NULL |
namespace in which the affected object resides |
 
|
user_id |
nvarchar(100) |
NULL |
user who affected the change that caused this event |
 
|
domain |
varchar(50) |
NULL |
domain to which the user belongs |
 
|
object_id |
varchar(256) |
NULL |
object id of the affected object |
 
|
httpsession_id |
nvarchar(50) |
NULL |
HTTP Session ID of the user |
 
|
partial_event |
integer |
NOT NULL |
1 indicates that this event does not contain further details. 0 indicates that this event contains more details that need to be fetched from transaction_details and transaction_details_ext table. |
 
|
notified |
varchar(512) |
NULL |
List to be notified
Should research more on this field
|
usm_system_change_detail |
An event might occur when an object gets added, deleted or modified in the iCan system or external system. This table allows you to store the state of the object before modification and the state of the object after modification. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
varchar(128) |
NOT NULL |
non-displayable id used in the backend as a reference between tables. |
 
|
name |
nvarchar(50) |
NOT NULL |
name of the property of the object or the field |
 
|
data_type |
nvarchar(50) |
NULL |
data type of the field or property |
 
|
old_value |
nvarchar(1024) |
NULL |
property value before modification or change |
 
|
new_value |
nvarchar(1024) |
NULL |
property value after modification or change |
 
|
multi_value |
integer |
NULL |
0/1. If 0, this field is not a multi-value field. |
usm_system_change_detail_ext |
When storing the state of the object in the transaction_details table, some of the fields can be multi-valued. These multi-valued field values are propagated to the transaction_details_ext table. |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
id |
varchar(128) |
NOT NULL |
non-displayable id used in the backend as a reference between tables. |
 
|
name |
nvarchar(50) |
NOT NULL |
name of the property of the object or the field |
 
|
age |
int |
NULL |
This column is not used |
 
|
value |
nvarchar(256) |
NULL |
property value before or after modification |
usm_system_install |
Defines a installed system for iCanView, only machine which are registered in icsysteminstall can host iCanView.
icinstalledcomponentinfo is removed, instead should use link_systeminstall_installcomp table
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
system_install_id |
varchar(64) |
NOT NULL |
The unique id for the system install, this is the machine name on which the view is installed |
 
|
comment |
varchar(64) |
NULL |
Comment on the system install, if any |
 
|
domain_name |
varchar(64) |
NULL |
Not used |
 
|
host_name |
varchar(64) |
NULL |
Name of the host for this system install |
 
|
logon_reqd |
varchar(20) |
NULL |
1 - logon reqd, 0 - not required Flag indicating if authentication need to be done on this system, if false then the authentication in not done, but just the userid is validated |
 
|
name |
varchar(64) |
NULL |
Name of the system install |
 
|
timeout |
int |
NULL |
Default session timeout in seconds for the system install |
 
|
use_cache |
int |
NULL |
1- cache enabled, 0 - disabled, specifies if caching is enabled/disabled |
 
|
web_root |
varchar(256) |
NULL |
This is the installation path for the web application files |
 
|
document_root |
varchar(256) |
NULL |
This is the path where the documents will be uploaded |
 
|
port_no |
int |
NULL |
This is the default port where view will be running |
 
|
log_messages |
int |
NULL |
Not used |
 
|
servlet_name |
varchar(64) |
NULL |
The name of the servlet context |
 
|
news_to_domains |
varchar(256) |
NULL |
Configuration on weather one can send to multiple domains; Values SELF, defualt is all domains |
 
|
client_side_processing |
int |
NULL |
Flag to specify if the transformation is to be done, if 0 no transformation will be done and xml will be sent back to browser to do client transformation |
 
|
concurrent_logon |
int |
NULL |
Indicates if a user can login from multiple machines, 1 - concurrent login allowed, 0 - not allowed |
 
|
super_tenant_enabled |
int |
NULL |
Flag to indicate if Super tenant mode is available or not ; 1 - available, 0 - not available |
 
|
login_property |
varchar(64) |
NULL |
This is the default property in the tenant table that will be used for login purposes, say tenant_name if you want login to be based on tenant name and not on tenantid |
 
|
super_tenant_levels |
int |
NULL |
Indicates how many levels of super tenant is allowed, -1 for infinite levels |
 
|
secret_question |
varchar(64) |
NULL |
This is the system level secret question if someone forgets a password etc, Eg: What is your mother maiden name? etc |
 
|
pwd_policy_id |
varchar(50) |
NULL |
The unique identifier for the password policy |
 
|
comments |
nvarchar(64) |
NULL |
This holds the comments, comment is removed for oracle support |
usm_task |
Defines a task for the scheduler to pick up |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
task_id |
varchar(50) |
NOT NULL |
The unique task id, which identifies the task |
 
|
name |
nvarchar(128) |
NOT NULL |
The descriptive name of the task |
 
|
comment |
varchar(64) |
NULL |
Any specific comments for additional data for this task |
 
|
day_of_month |
int |
NULL |
Task execution day of month |
 
|
day_of_week |
int |
NULL |
Task execution day of week |
 
|
hour |
int |
NULL |
The hour which the task will be executed |
 
|
minute |
int |
NULL |
The minute which the task will be executed |
 
|
month |
int |
NULL |
The month which the task will be executed |
 
|
status |
int |
NULL |
The status of the task, 1 - ACTIVE, 0 - INACTIVE |
 
|
task_to_exec |
varchar(64) |
NULL |
The action, that need to be done as part of this task execution |
 
|
type |
varchar(20) |
NULL |
Specifies the type of the task |
 
|
year |
int |
NULL |
The year which the task will be executed |
 
|
start_date |
datetime |
NULL |
The start date, if this is a repeative task |
 
|
end_date |
datetime |
NULL |
The end date, if this is a repeative task |
 
|
requestor |
varchar(64) |
NOT NULL |
Specifies which component made the request for this task |
 
|
runtime_component_id |
varchar(50) |
NULL |
The runtime component handle which is responsible for the task |
 
|
action_type |
int |
NULL |
Inidacte the type of the action |
 
|
data1 |
varchar(64) |
NULL |
For external integration/implemenatation |
 
|
data2 |
varchar(64) |
NULL |
For external integration/implemenatation |
 
|
data3 |
varchar(64) |
NULL |
For external integration/implemenatation |
 
|
data4 |
varchar(64) |
NULL |
For external integration/implemenatation |
 
|
data5 |
varchar(64) |
NULL |
For external integration/implemenatation |
 
|
interval |
int |
NULL |
Interval between one execution and the next |
 
|
description |
ntext |
NULL |
The description of the task |
 
|
action_description |
varchar(128) |
NULL |
The detailed description of this action |
 
|
created_date |
datetime |
NULL |
The time recoreded for when the task is created |
 
|
last_exec_date |
datetime |
NULL |
The last executed time for this lask |
 
|
missed_action |
varchar(64) |
NULL |
The action, specifies what need to be done, if the task is missed |
 
|
user_id |
varchar(50) |
NULL |
The userid , who created this task |
 
|
modified_date |
datetime |
NULL |
The modified date for this task |
 
|
guinode_id |
varchar(50) |
NULL |
Hand to guinode if a guinode is to be invoked as a result of this task |
 
|
tenant_id |
varchar(50) |
NULL |
Handle to the tenant object if the task is organization based |
 
|
time_zone_code |
varchar(64) |
NULL |
time zone code is the code for a particular time zone, Eg- EST, PST etc |
 
|
comments |
nvarchar(64) |
NULL |
description for the comment field. field name has been changed to comments to support oracle
|
usm_tenant_ext |
Defines an organization/department which will contain users and accounts.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
tenant_id |
varchar(50) |
NOT NULL |
The unique tenantid that identifies this organization/tenant |
 
|
parent_tenant_id |
varchar(50) |
NOT NULL |
The handle to the parent tenant for a specific tenant, this determines the tree structure within tenants |
 
|
tenant_name |
nvarchar(50) |
NOT NULL |
The readable name of the tenant |
 
|
domain_type |
varchar(4) |
NOT NULL |
Specifies the type of the tenant, SP - Service Provider, ST - Super Tenant, TE - Tenant |
 
|
status |
nvarchar(256) |
NOT NULL |
Status of the tenant
0 Inactive(deleted), 1 active
|
 
|
login_domain |
varchar(64) |
NULL |
The login domain for a domanin based login, if the login is not tenant based |
 
|
opened_date |
datetime |
NOT NULL |
The date when the tenant is created |
 
|
closed_date |
datetime |
NULL |
The closed date, if this tenant is no longer active or deleted |
 
|
email |
varchar(128) |
NULL |
The email address for the tenant |
 
|
website |
varchar(128) |
NULL |
Tenants website address |
 
|
description |
nvarchar(64) |
NULL |
The description of the tenant |
 
|
federal_tax_payer_id |
nvarchar(32) |
NOT NULL |
This is the federal tax payer identification for financial purposes, only used to display, no logic associated |
 
|
state_tax_payer_id |
nvarchar(32) |
NOT NULL |
This is the state tax payer identification for financial purposes, only used to display, no logic associated
|
 
|
tax_region |
nvarchar(64) |
NOT NULL |
specifies the region of taxing, for financial purposes, only used to display, no logic associated
|
 
|
date_format |
varchar(256) |
NULL |
The format of date display, configurable at the tenant level |
 
|
time_format |
varchar(11) |
NULL |
The format of time display, configurable at the tenant level |
 
|
decimal_format |
int |
NULL |
0 period, 1 comma |
 
|
single_account_mode |
int |
NULL |
0 true, 1 false(default) |
 
|
data1 |
nvarchar(32) |
NULL |
For external integration/implemenatation |
 
|
data2 |
nvarchar(32) |
NULL |
For external integration/implemenatation |
 
|
data3 |
nvarchar(32) |
NULL |
For external integration/implemenatation |
 
|
data4 |
nvarchar(64) |
NULL |
For external integration/implemenatation |
 
|
data5 |
nvarchar(64) |
NULL |
For external integration/implemenatation |
 
|
data6 |
nvarchar(128) |
NULL |
For external integration/implemenatation |
 
|
data7 |
nvarchar(128) |
NULL |
For external integration/implemenatation |
 
|
currency_type_code |
varchar(3) |
NULL |
Handle to the currecy object |
 
|
time_zone_code |
varchar(64) |
NULL |
Handle to the time zone object |
 
|
location_uuid |
tinyint(16) |
NULL |
FK to ca_location table |
 
|
company_uuid |
tinyint(16) |
NULL |
FK to ca_company table |
 
|
organization_uuid |
tinyint(16) |
NULL |
FK to ca_organization table |
 
|
path |
varchar(1024) |
NOT NULL |
This specifies the path of the tenant with the parent hierarchy starting from sp teanant
|
 
|
contact_uuid |
tinyint(16) |
NULL |
This holds the FK for the location contact for this tenant
|
 
|
logo |
nvarchar(255) |
NULL |
used to save the logo url for each tenant |
usm_tenant_ext_ldap_conf |
Place holder for the external LDAP configuration at the organization level |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
tenant_id |
varchar(50) |
NOT NULL |
The handle to the tenant, to indicate which tenant for this configuration |
 
|
external_dir_type |
varchar(20) |
NULL |
The type of the external directory type, MSAD for Active Directory etc |
 
|
ldap_host |
varchar(64) |
NULL |
The host name for the external LDAP |
 
|
port_no |
int |
NULL |
The LDAP port number for the external LDAP |
 
|
filter |
varchar(20) |
NULL |
The specific user attribute in iCan user that is mapped to the "cn" of the external user |
 
|
user_base |
varchar(256) |
NULL |
The base DN for where the users will be added |
 
|
bind_user |
varchar(64) |
NULL |
The user DN in external directory which will be used to connect to the external directory |
 
|
password |
varbinary |
NULL |
Password to connect to the external directory, to do adminstrative task, like add user |
 
|
external_ous |
varchar(128) |
NULL |
This is deprecated functionality |
usm_transaction |
This table records all the transactions associated to a billing_account. The primary key is the account_no and the id. The id is calculated from the billing_account.last_transaction_id
the values for the overloaded fields for the transaction types supplied out-of-the-box. Users can created there own transcation plugins and override these fields meanings.
When type = 0 (Offering Transcations)
" enum_1 = pointer to the subscription, ie: subscription_details.subscription_id
" enum_2 = pointer to the offering, ie: offerings.offering_id
When type = 1 (Rateplan Transcations)
" enum_1 = pointer to the subscription, ie: subscription_details.subscription_id
" enum_2 = pointer to the offering, ie: offerings.offering_id
" enum_3 = pointer to the rate plan, ie: rate_plans.rate_plan_id
When type = 2 (Rateitem Transactions)
" enum_1 = pointer to the subscription, ie: subscription_details.subscription_id
" enum_2 = pointer to the offering, ie: offerings.offering_id
" enum_3 = pointer to the rate plan, ie: rate_plans.rate_plan_id
" enum_4 = pointer to the rate item, ie: rate_definition.item_id
" enum_5 = installment total. For transactions that are created from rate items that charge in installments
" enum_6 = installments. For transactions that are created from rate item that charge in installments this will specify how may installment to date have been made.
" enum_7 = rate item type
" enum_8 = show additional value from numeric_1 on the invoice(ie: metric result, user entered quantity, etc)
" numeric_1 = rate item result value (ie: metric result )
" date_1 = the transaction from date
" date_2 = the transaction to date
" prorate_value = the number of days in the billing period.
" period_multiplier = the factor calculated from prorating
" num_periods = the number of periods the transaction is being billed for
" advanced_periods = the number of perios the transaction is being billed in advance for.
" period_type: -1=onetime, 0=daily, 1=weekly, 2=mon
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
account_no |
varchar(50) |
NOT NULL |
The account to which this transaction is associated. |
 
|
id |
integer |
NOT NULL |
Integer that increments for each transaction associated to a particular account. |
 
|
domain |
varchar(50) |
NOT NULL |
This is the tenant ID of the account |
 
|
parent_domain |
varchar(50) |
NOT NULL |
This is the parent tenant ID, the value of this field is always either a Supert Tenant, Service Provider, or empty in the case when domain is the value of the Service Provider. |
 
|
statement_id |
integer |
NOT NULL |
this is the invoice that this transaction appeared on. A -1 indicates that this has not be invoiced yet. |
 
|
sequence_no |
integer |
NULL |
the ordering of transactions as they have been processed and the order in which they will show up on the invoice |
 
|
type |
integer |
NOT NULL |
the type of transaction. 0=offering, 1=rate plan, 2=rate item, 3=adjustment, 4=payments, 5=message. Users can create and plugin there own types of transactions, and should use values greater then 10000. |
 
|
post_date |
date |
NULL |
the date that the transaction was posted to the account. |
 
|
status |
integer |
NOT NULL |
0=deleted, 1=open |
 
|
description |
nvarchar(1024) |
NOT NULL |
the description of the transaction |
 
|
charge_type |
integer |
NOT NULL |
0=credit, 1=debit, 2=default. |
 
|
commit_phase |
integer |
NOT NULL |
0=not committed, 1=committed. This is used for components that integrate with iCanBill to track transactions. |
 
|
quantity |
float |
NOT NULL |
The quantity associated with the transaction. |
 
|
quantity_type |
integer |
NOT NULL |
0=quantity, 1=percent. Currently only 1 is supported. |
 
|
unit_cost |
float |
NOT NULL |
is the unit cost used for calculations |
 
|
unit_cost_text |
nvarchar(50) |
NOT NULL |
is the unit cost used for display. Used for resolving floating point errors. |
 
|
unit_type |
nvarchar(50) |
NULL |
used for display only to show the type of unit of the transaction |
 
|
cost |
float |
NOT NULL |
calculated from quantity x unit_cost |
 
|
code |
nvarchar(50) |
NULL |
codes from the subscriptions are passed to this field. This can be overloaded by other transaction type plugins |
 
|
enum_1 |
integer |
NULL |
See Table Comment |
 
|
enum_2 |
integer |
NULL |
See Table Comment |
 
|
enum_3 |
integer |
NULL |
See Table Comment |
 
|
enum_4 |
integer |
NULL |
See Table Comment |
 
|
enum_5 |
integer |
NULL |
See Table Comment |
 
|
enum_6 |
integer |
NULL |
See Table Comment |
 
|
enum_7 |
integer |
NULL |
See Table Comment |
 
|
enum_8 |
integer |
NULL |
See Table Comment |
 
|
text_1 |
nvarchar(50) |
NULL |
See Table Comment |
 
|
text_2 |
nvarchar(50) |
NULL |
See Table Comment |
 
|
text_3 |
nvarchar(50) |
NULL |
This column is not used |
 
|
numeric_1 |
float |
NULL |
See Table Comment |
 
|
date_1 |
date |
NULL |
See Table Comment |
 
|
date_2 |
date |
NULL |
See Table Comment |
 
|
date_3 |
date |
NULL |
This column consists of Invoice Date |
 
|
prorate_value |
integer |
NULL |
See Table Comment |
 
|
period_multiplier |
float |
NULL |
See Table Comment |
 
|
num_periods |
integer |
NULL |
See Table Comment |
 
|
advanced_periods |
integer |
NULL |
See Table Comment |
 
|
period_type |
integer |
NULL |
See Table Comment |
 
|
period_type_interval |
integer |
NULL |
See Table Comment |
 
|
is_reverse |
integer |
NOT NULL |
0=not a reverse transaction, 1=reverse transaction |
 
|
reverse_tran_id |
integer |
NOT NULL |
This colulmn is deprecated will allways contains -1 as value. |
 
|
suspension_id |
integer |
NULL |
id of the subscription_mgmt object that suspended this transaction |
 
|
suspension_instance |
date |
NULL |
This column is not used |
usm_unittype |
Defines the specific unit for a given metric category.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
unittype_id |
int |
NOT NULL |
Unique identity for this unit type |
 
|
description |
varchar(128) |
NULL |
A description |
 
|
metric_result |
varchar(20) |
NULL |
  |
 
|
name |
varchar(20) |
NULL |
The name of the unit type |
usm_user |
Defines the user in the system, inherited from inetOrgPerson, a standard ldap user class.
This is the physical user who will get authenticated and can login in into the system.
User belongs to a tenant( domain), and will login into the specific domain he is part of to acess the system
User also is tied to a role which determines what level of access he has
icgroupname is replaced by icroleid
icuserquery is replaced with user_query_history
icpwdhistrory is replaced with user_pwd_history
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
user_id |
varchar(50) |
NOT NULL |
The unique userid, user id is of the form username@domain |
 
|
domain |
varchar(50) |
NULL |
Handle to tenant object, specifying which organization this user belongs to |
 
|
common_name |
varchar(128) |
NULL |
  |
 
|
first_name |
varchar(128) |
NULL |
  |
 
|
last_name |
varchar(64) |
NULL |
  |
 
|
initials |
varchar(32) |
NOT NULL |
  |
 
|
address |
varchar(128) |
NOT NULL |
  |
 
|
city |
varchar(64) |
NOT NULL |
  |
 
|
state |
varchar(128) |
NULL |
  |
 
|
country |
varchar(64) |
NOT NULL |
  |
 
|
postal_code |
varchar(128) |
NULL |
  |
 
|
email |
varchar(128) |
NOT NULL |
  |
 
|
telephone |
varchar(256) |
NOT NULL |
  |
 
|
fax |
varchar(20) |
NULL |
  |
 
|
mobile |
varchar(256) |
NOT NULL |
  |
 
|
pager |
varchar(256) |
NOT NULL |
  |
 
|
home_phone |
varchar(256) |
NOT NULL |
  |
 
|
password |
varchar(128) |
NULL |
  |
 
|
title |
varchar(64) |
NOT NULL |
  |
 
|
description |
varchar(128) |
NOT NULL |
  |
 
|
status |
nvarchar(256) |
NULL |
Status, 0- deleted user 1 - active user |
 
|
manager |
varchar(64) |
NULL |
  |
 
|
employee_type |
varchar(32) |
NOT NULL |
  |
 
|
employee_number |
varchar(16) |
NULL |
  |
 
|
department_number |
varchar(128) |
NULL |
  |
 
|
secretary |
varchar(128) |
NULL |
  |
 
|
organization |
varchar(64) |
NULL |
  |
 
|
organization_unit |
varchar(128) |
NULL |
  |
 
|
uid |
varchar(128) |
NULL |
  |
 
|
car_licence |
varchar(16) |
NULL |
  |
 
|
url |
varchar(128) |
NOT NULL |
  |
 
|
external_ou |
varchar(256) |
NULL |
The path for the external LDAP user organization unit |
 
|
external_dn |
varchar(256) |
NULL |
The external LDAP distinguished name if the user lies in an external LDAP |
 
|
time_zone_code |
varchar(64) |
NULL |
handle to a timezone object |
 
|
locale_code |
varchar(4) |
NULL |
Handle to the locale object |
 
|
user_account_control |
int |
NULL |
  |
 
|
useruid |
varchar(64) |
NULL |
  |
usm_user_query_history |
Place holder for the query history, a list of queries done by the user are stored here and can be selected by used to run the queries |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
user_id |
nvarchar(100) |
NOT NULL |
User Unique ID |
 
|
guinode_id |
varchar(128) |
NOT NULL |
Guinode unique ID |
 
|
name |
nvarchar(128) |
NOT NULL |
Name of the user query |
 
|
user_query |
ntext |
NOT NULL |
user search queries which is saved |
 
|
shared_mode |
int |
NOT NULL |
default to 0 and 0 means "private". 1 means "shared" |
 
|
description |
nvarchar(1024) |
NULL |
description of the saved queries |
usm_webservice |
Defines a web service available as part of the product suite, the is the intefaces for SOAP protocal into the product |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
webservice_id |
varchar(50) |
NOT NULL |
The unique id which identifies the webservice |
 
|
display_name |
varchar(64) |
NULL |
The descriptive name of the web service |
 
|
urn |
varchar(64) |
NULL |
The Uniform Resource name for the webservice |
 
|
class |
varchar(64) |
NULL |
The java class for the webservice implementation |
 
|
load_on_startup |
int |
NULL |
Specifies if this a system specific webservice and is added for the system to work. Example: |
 
|
scope |
varchar(20) |
NULL |
Determines the scope of the webservice, Eg: Application scope etc |
 
|
static |
int |
NULL |
Specifies if the implementation is static or not |
 
|
is_system |
int |
NULL |
Specifies if this a system specific webservice and is added for the system to work. Example: |
usm_webservice_method |
Defines a web service method which can be accessed throught web services provided in the suite |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
webservice_method_id |
varchar(128) |
NOT NULL |
The unique method id for the webservice method implemenentation, This is the webserviceid.methodid |
 
|
webservice_method_name |
varchar(64) |
NULL |
The descriptive name of the web service |
 
|
method_name |
varchar(64) |
NULL |
The method id for the webservice method |
 
|
is_system |
int |
NULL |
Specifies if this a system specific webservice and is added for the system to work. Example: |
 
|
load_on_startup |
int |
NULL |
Specifies if this a system specific webservice and is added for the system to work. Example: |
 
|
use_cache |
int |
NULL |
Specifies if the cache can be used for this method |
 
|
output |
varchar(64) |
NULL |
Specifies the output format of the method, Eg: ISOAPObject etc |
 
|
webservice_id |
varchar(50) |
NULL |
Handle to the webservice, which is responsible for this method |
 
|
input |
varchar(512) |
NULL |
Specifies the input format of the method |
 
|
optinal_input |
varchar(1024) |
NULL |
Specifies the optional input |
usm_webservice_sessions |
To store the webservice session ids in the table |
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
session_id |
varchar(64) |
NOT NULL |
session id |
 
|
userid |
nvarchar(100) |
NOT NULL |
userid of the session |
 
|
timestamp |
double precision |
NOT NULL |
Timestamp in milisecond for when the session is created |
 
|
domain1 |
varchar(50) |
NULL |
user's tenant_id where he is logged into. |
 
|
credentials |
ntext |
NOT NULL |
credentials of the user |
 
|
proxy_userid |
nvarchar(100) |
NULL |
proxy user id |
 
|
proxy_tenant_id |
varchar(50) |
NULL |
The unique tenantid that identifies this organization/tenant |
usm_wmi_classes |
This table will hold a list of all of the WMI Classes that were found on a particular WMI gateway the last name a class query was made.
Keeping a list of these classes allows us to have a cache so that we do not need to connect to the gateway each time we set-up a WMI Metric Instance.
This also makes it easier to use filter the list of classes in the GUI by searching for certain strings in their names.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
server_id |
integer |
NOT NULL |
Unique identifier for one slm server |
 
|
class_name |
varchar(255) |
NOT NULL |
WMI class name |
usm_wmi_expression |
This table will be used to hold a list of the WMI expressions, which are used for the translation of data that is collected from a WMI Gateway to a format that is acceptable for the SLM r11 database.
For example, since strings are a valid type of information collected by the WMI and the events table can only store numeric information, we need a way to map the data into the database. This is accomplished by using an expression, which can be saved for future use, or applied to other types of WMI metric instances. The expression itself will probably use a language such as Tcl, which is used by the SNMP Metric Wizard expressions in SLM 3.5.
|
 
|
Column Name |
Column Datatype |
Column Null Option |
Column Comment |
 
|
expression_id |
int |
NOT NULL |
Unique identity for the expression |
 
|
expression_name |
nvarchar(255) |
NOT NULL |
Name of the expression |
 
|
expression_text |
varchar(4095) |
NOT NULL |
The expression text |