Subject Area : 065 - Configuration Setting |
Subject Area Name | Definition | |||||
---|---|---|---|---|---|---|
065 - Configuration Setting |
The intent of the model is to provide for documentation, implementation, localization, and business behavior for the large amount and variety of Configuration Data in FootPrints. The Configuration is broken into Categories which are independently designed and developed. The information needed for the Administration UI, the developer, and query access are all facilitated. The same Definition object can be used at Design Time, Install Time, and Runtime. The actual properties of the Definition objects are stored as Configuration Setting Values, with a reference to a Configuration Setting. The Configuration Setting names are defined in Java code with annotations, and are bound to the database by the same name. So all possible names for Configuration Settings are known and stored via code scanning in the Configuration Setting table. The goal of this pattern is to quickly allow new metadata properties to be defined in code, to have these properties existence and possible values known in the database, to enable query optimization by holding a cache of long strings vs. lengthy names in name/value pairs, and to make it impossible to have errors in the binding of database values and coding values. Database views can be defined that will simplify the display of these properties. |
|||||
ER Diagram Name | Physical Display Level | |||||
Logical | Column | |||||
Physical | Column | |||||
Physical Name | Entity/Table Name | Logical Only | Do Not Generate | Definition | ||
app_role | Application Role | false | A User Security Role within Footprints. This includes Agent Users and Customer Users, and includes Role settings at the Instance and Container level. Workspace Role and CMDB Role may both be implemented as Container Role. The Role has associated Rights and Permissions, and is a way of granting Roles and Permissions to a User. There is some conceptual overlap between the User Profile and the Role. The User is assigned a single Role as part of the User Profile, and a User can only have one System Role and one Workspace Role. The User Profile can have property settings that override the Role Settings. | |||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
app_role_id | Application Role Id | The automatically generated primary key of the app_role table. | bigint | |||
tmpl_app_role_id | Template Application Role Id | A Foreign Key to the Application Role table. This indicates which Template Role was used to create a built-in role in case some features concerning new properties added to later release of the system will need to be added to existing templates. | bigint | |||
app_role_name | Application Role Name | The name of the Application Role. | varchar(255) | |||
defn_id | Definition Id | A Foreign Key to the Definition table. | bigint | |||
admin_type_id | Administrator Type Id | A Foreign Key to the Administrator Type table. | int | |||
is_built_in | Is Built In | Indicates that this instance of Application Role is a built-in instance that cannot be changed by the end user. | bit | |||
app_role_descr | Application Role Description | A descriptive name of the Application Role. This descriptive name may be localized. | varchar(1024) | |||
user_type_id | User Type Id | A Foreign Key to the User Type table. | int | |||
defn_subtype_id | Definition Subtype Id | A Foreign Key to the Definition Subtype table. | int | |||
tmpl_app_role_id | Template Application Role Id | A Foreign Key to the Application Role table. | bigint | |||
tmpl_level_name | tmpl_level_name | The value of a Built_in_level, stored as a string. | varchar(255) | |||
cfg_allow_val | Configuration Allowed Value | false | A Configuration Allowed Value represents a member of a list of possible values. | |||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
cfg_allow_val_id | Configuration Allowed Value Id | The automatically generated primary key of the cfg_allow_val table. | bigint | |||
cfg_val_list_id | Configuration Value List Id | A Foreign Key to the Configuration Value List table. | bigint | |||
string_val | String Value | The value of a Configuration Allowed Value, stored as a string. | varchar(255) | |||
text_val | Text Value | The value of a Configuration Allowed Value, stored as a long text object. | varchar(max) | |||
val_type_cd | Value Type Code | The data type for a Value Type Code. The choices are 'S' string, 'D' date, 'T' text, 'I' integer. | char(1) | |||
real_val | Real Value | The value of a Configuration Allowed Value stored as real. | numeric(38,20) | |||
long_val | Long Value | The value of a Configuration Allowed Value stored as Long. | bigint | |||
cfg_allow_val_descr | Configuration Allowed Value Description | A descriptive name of the Configuration Allowed Value. This descriptive name may be localized. | varchar(512) | |||
date_val | Date Value | The value of a Configuration Allowed Value, stored as a date. | datetime | |||
boolean | Boolean | The value of a Configuration Allowed Value stored as boolean. | bit | |||
int_val | Int Value | The value of a Configuration Allowed Value stored as boolean. | int | |||
cfg_area_type | Configuration Area Type | false |
The lookup table for the high level area of Configuration. Values include APPLICATION BUSINESS, CORE, DEPLOYMENT, INFRASTRUCTURE, TOOL |
|||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
cfg_area_type_name | Configuration Area Type Name | The unique string identifier for an instance of Configuration Area Type. This identifier must be kept in sync with programming code that uses an enumeration constant to identify particular values. A scan program is generally used to populate this table. | varchar(100) | |||
cfg_area_type_descr | Configuration Area Type Description | A descriptive name of the Configuration Area Type. This descriptive name may be localized. | varchar(512) | |||
cfg_ctgy | Configuration Category | false | A Category of Configuration, which corresponds to the namespace and name of an object that defines and contains the associated Configuration Settings. The intent is that the Category provides both a logical and physical grouping of configuration data so that developers working on different components do not have to compete with each other to check out the same files to define configuration, and do not have to merge changes. | |||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
cfg_ctgy_id | Configuration Category Id | The automatically generated primary key of the cfg_ctgy table. | bigint | |||
dflt_ctgy_descr | Default Category Description | A description of the category. | varchar(255) | |||
cfg_area_type_name | Configuration Area Type Name | The unique string identifier for an instance of Configuration Area Type. This identifier must be kept in sync with programming code that uses an enumeration constant to identify particular values. A scan program is generally used to populate this table. | varchar(100) | |||
cfg_ctgy_type_name | Configuration Category Type Name | The unique string identifier for an instance of Configuration Category Type. This identifier must be kept in sync with programming code that uses an enumeration constant to identify particular values. A scan program is generally used to populate this table. | varchar(100) | |||
cfg_ctgy_type | Configuration Category Type | false | The category of configuration lookup table. The category is like a namespace, it identifies where a setting is defined, and can be used to retrieve groups of settings via the API. The categories are defined in the Java code, but they are replicated to the Database for data integrity of the settings. They also serve to identify all possible categories, whether or not configuration settings are stored for them. Examples of the 70+ values include APPLICATION_HELP, BUSINESS_ADMIN_PIM_SYNCING, BUSINESS_ANALYTICS. | |||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
cfg_ctgy_type_name | Configuration Category Type Name | The unique string identifier for an instance of Configuration Category Type. This identifier must be kept in sync with programming code that uses an enumeration constant to identify particular values. A scan program is generally used to populate this table. | varchar(100) | |||
cfg_ctgy_type_descr | Configuration Category Type Description | A descriptive name of the Configuration Category Type. This descriptive name may be localized. | varchar(512) | |||
cfg_list_type | Configuration List Type | false | The type of list used for valid values and value lists of Configuration Settings. A single valued list, a list with X dimension, and a list with XY dimension are possible values. The Dimensions are used to construct the dynamic list based on dynamic key parts such as the Item Field Name, Item Status, Template Name, etc. | |||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
cfg_list_type_name | Configuration List Type Name | The unique string identifier for an instance of Configuration List Type. This identifier must be kept in sync with programming code that uses an enumeration constant to identify particular values. A scan program is generally used to populate this table. | varchar(255) | |||
cfg_list_type_descr | Configuration List Type Description | A descriptive name of the Configuration List Type. This descriptive name may be localized. | varchar(512) | |||
cfg_obj | Configuration Object | false | A configuration object holds configuration settings but is not versioned and published like a definition and definition version. | |||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
cfg_obj_id | Configuration Object Id | The automatically generated primary key of the cfg_obj table. | bigint | |||
cfg_obj_type | Configuration Object Type | The type of a Configuration Object, stored as a string. Values include: AUTHENTICATION_METHOD, AUTHENTICATION_METHOD, SYSTEM_PREFERENCES_CONFIGURATION, FILE_STORAGE_CONFIGURATION, LICENSING_CONFIGURATION, RULE_CONFIGURATION. | varchar(255) | |||
order_index | Order Index | deprecated and null. The value of a Configuration Object. The value is a string but it can be conformed to the datatype listed on the Configuration Setting. | int | |||
cfg_obj_subtype | Configuration Object Subtype | deprecated and null. The value of a Configuration Object, stored as a string. | varchar(255) | |||
owner_id | Owner Id | A Foreign Key to the Owning instance in either the Definition, Configuration Object, or User Profile tables. | bigint | |||
cfg_setting_owner_type_name | Configuration Setting Owner Type Name | deprecated and null. The unique string identifier for an instance of Configuration Setting Owner Type. This identifier must be kept in sync with programming code that uses an enumeration constant to identify particular values. A scan program is generally used to populate this table. | varchar(255) | |||
cfg_setting | Configuration Setting | false | A configuration variable that can be identified in programming code and which has an atomic value that affects the behavior of the application. Configuration values are either scalars, or are supported by value lists that also can be programmatically identified. They have localized labels and value choices, and are categorized to support organization and separation in programming namespaces and configuration screens. They support the concept of Built-In Values, Default Values, and Customized Values. Configuration should be supported by an Audit Trail, and should be able to determine if configuration has changed by level, category, and for the individual value in order to support cacheing. A configuration value has a definition to identify its usage, and a enum that identifies if a change will require a restart and what level of restart is required if the value changes. If a restart is required, both the currently running value and the value after restart should be accessible. This means that historical values of the Configuration Settings should be accessible. | |||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
cfg_ctgy_id | Configuration Category Id | A Foreign Key to the Configuration Category table. | bigint | |||
cfg_setting_const | Configuration Setting Constant | The constant name of the Configuration Setting Constant, which can be aligned with an enumeration or other compile time constant value for access in Java. | varchar(255) | |||
dflt_setting_label | Default Setting Label | The name of the Configuration Setting. | varchar(255) | |||
dflt_setting_descr | Default Setting Description | The description of the purpose and usage of the configuration setting. This description serves for documentation, and will be used to help develop UI strings for the Label, ToolTip, Helptext etc. of the UI for the configuration setting. | varchar(255) | |||
cfg_setting_id | Configuration Setting Id | The automatically generated primary key of the cfg_setting table. | bigint | |||
agent_only | Agent Only | Indicates if Agent Only. | bit | |||
unique_user_only | Unique User Only | Indicates if Unique User Only. | bit | |||
cfg_val_list_id | Configuration Value List Id | A Foreign Key to the Configuration Value List table. | bigint | |||
val_type_cd | Value Type Code | The data type for a Configuration Setting. The choices are 'S' string, 'D' date, 'T' text, 'L' Long, 'R' real, and 'A' for any type. | char(1) | |||
cfg_list_type_name | Configuration List Type Name | The unique string identifier for an instance of Configuration List Type. This identifier must be kept in sync with programming code that uses an enumeration constant to identify particular values. A scan program is generally used to populate this table. | varchar(255) | |||
spec_class_name | Specification Class Name | The value of a Configuration Setting, stored as a string. | varchar(255) | |||
cfg_is_val_mapped | Configuration Is Value Mapped | Indicates if Configuration Is Value Mapped. | bit | |||
cfg_setting_owner_type | Configuration Setting Owner Type | false | A lookup table for Owner Types of Configuration Setting Values. Values include: APPLICATION_USER, DEFINITION, IMPORTS, ROLE, SIMPLE_CONFIGURABLE_OBJECT, USER_PROFILE. | |||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
cfg_setting_owner_type_descr | Configuration Setting Owner Type Description | A descriptive name of the Configuration Setting Owner Type. This descriptive name may be localized. | varchar(512) | |||
cfg_setting_owner_type_name | Configuration Setting Owner Type Name | The unique string identifier for an instance of Configuration Setting Owner Type. This identifier must be kept in sync with programming code that uses an enumeration constant to identify particular values. A scan program is generally used to populate this table. | varchar(255) | |||
cfg_setting_val | Configuration Setting Value | false | Configuration Setting Value is an association between the Configuration Setting entity and a container entity (i.e. User Profile, Role, and Definition). This association contains a distinct value for each of the intersection points between the two entities. | |||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
cfg_setting_val_id | Configuration Setting Value Id | The automatically generated primary key of the cfg_setting_val table. | bigint | |||
cfg_setting_id | Configuration Setting Id | A Foreign Key to the Configuration Setting table. | bigint | |||
val_type_cd | Value Type Code | The data type for a Configuration Setting Value. The choices are 'S' string, 'D' date, 'T' text, 'I' integer. | char(1) | |||
string_val | String Value | The value of a Configuration Setting Value, stored as a string. | nvarchar(4000) | |||
text_val | Text Value | The value of a Configuration Setting Value, stored as a long text object. | nvarchar(max) | |||
real_val | Real Value | The value of a Configuration Setting Value stored as a real. | numeric(38,20) | |||
long_val | Long Value | The value of a Configuration Setting Value stored as Long. | bigint | |||
date_val | Date Value | The value of a Configuration Setting Value, stored as a date. | datetime | |||
boolean_val | Boolean Value | The value of a Configuration Setting Value stored as Boolean. | bit | |||
int_val | Int Value | The value of a Configuration Setting Value stored as Int. | int | |||
owner_id | Owner Id | A Foreign Key to the Owning instance in either the Definition, Definition Version , Role, or User Profile tables. | bigint | |||
val_map_key | Value Map Key | The value of a Configuration Setting Value, stored as a string. | varchar(255) | |||
cfg_setting_owner_type_name | Configuration Setting Owner Type Name | The unique string identifier for an instance of Configuration Setting Owner Type. This identifier must be kept in sync with programming code that uses an enumeration constant to identify particular values. A scan program is generally used to populate this table. | varchar(255) | |||
cfg_val_list | Configuration Value List | false | false |
The Configuration Value List is a class that represents a set of values. It is meant to be inherited by a sub category with the structure of the set of values more concretely defined in the lower entity. Example: Configuration Dynamic List The Configuration Dynamic List inherits from the Configuration Value List but maps the values into a linear list so that the values can be identified by their position in the overall list of values. |
||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
cfg_val_list_id | Configuration Value List Id | The automatically generated primary key of the cfg_val_list table. | bigint | |||
cfg_list_type_name | Configuration List Type Name | The unique string identifier for an instance of Configuration List Type. This identifier must be kept in sync with programming code that uses an enumeration constant to identify particular values. A scan program is generally used to populate this table. | varchar(255) | |||
dflt_cfg_setting_val | Default Configuration Setting Value | false | ||||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
dflt_cfg_setting_val_id | Default Configuration Setting Value Id | The automatically generated primary key of the dflt_cfg_setting_val table. | bigint | |||
cfg_setting_id | Configuration Setting Id | A Foreign Key to the Configuration Setting table. | bigint | |||
val_type_cd | Value Type Code | The data type for a Value Type Code. The choices are 'S' string, 'D' date, 'T' text, 'I' integer. | char(1) | |||
string_val | String Value | The value of a Default Configuration Setting Value, stored as a string. | varchar(255) | |||
text_val | Text Value | The value of a Default Configuration Setting Value, stored as a long text object. | varchar(max) | |||
date_val | Date Value | The value of a Default Configuration Setting Value, stored as a date. | datetime | |||
real_val | Real Value | The value of a Default Configuration Setting Value stored as real. | numeric(38,20) | |||
int_val | Int Value | The value of a Default Configuration Setting Value stored as boolean. | int | |||
long_val | Long Value | The value of a Default Configuration Setting Value stored as Long. | bigint | |||
boolean_val | Boolean Value | The value of a Configuration Setting Value stored as boolean. | bit | |||
val_map_key | Value Map Key | The value of a Default Configuration Setting Value, stored as a string. | varchar(255) | |||
cfg_setting_owner_type_name | Configuration Setting Owner Type Name | The unique string identifier for an instance of Configuration Setting Owner Type. This identifier must be kept in sync with programming code that uses an enumeration constant to identify particular values. A scan program is generally used to populate this table. | varchar(255) | |||
defn | Definition | false | A definition holds the structural and behavioral information needed for an application element that is configuarable by the system designer and/or the end user at definition time. Current Footrpints uses a combination of directories, files, tables, and programming code to represent this information. The new FootPrints will provide all of the same information within the definition. The definition can be persisted in a structure that is isolated at the Instance Level. The data for the definition will be stored as Configuration Settings associated with the Definition Version. See the database views v_defn_ver_active, v_cntnr_item_field. | |||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
defn_id | Definition Id | The automatically generated primary key of the defn table. | bigint | |||
defn_name | Definition Name | The name of the Definition. | nvarchar(4000) | |||
dsble_date | Disabled Date | The date that this instance of Definition is logically deleted and disabled. | datetime | |||
defn_guid | Definition GUID | A Global Unique IDentifier search key for the Definition, composed of letters and numbers. It is computed by the client and typically used in unstructured data. | varchar(50) | |||
defn_type_name | Definition Type Name | The unique string identifier for an instance of Definition Type. This identifier must be kept in sync with programming code that uses an enumeration constant to identify particular values. A scan program is generally used to populate this table. | varchar(255) | |||
defn_subtype_id | Definition Subtype Id | A Foreign Key to the Definition Subtype table. | int | |||
tmpl_export_guid | Template Export GUID | The value of a Definition, stored as a string. | VARCHAR(50) | |||
defn_ver | Definition Version | false | A version of a Definition with a version identifier that changes when data changes are made to the template. The definition version will suffice to store the current state of the FootPrints Configuration. A full copy of the definition tree is versioned when a container is published. See the database views v_defn_ver_active, v_cntnr_item_field. | |||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
defn_id | Definition Id | A Foreign Key to the Definition table. | bigint | |||
defn_ver_id | Definition Version Id | The automatically generated primary key of the defn_ver table. | bigint | |||
defn_ver_name | Definition Version Name | The name of the Definition Version. | nvarchar(4000) | |||
defn_ver_status_id | Definition Version Status Id | A Foreign Key to the Definition Version Status table. | int | |||
defn_ver_guid | Definition Version GUID | A Global Unique IDentifier search key for the Definition Version, composed of letters and numbers. It is computed by the client and typically used in unstructured data. | varchar(50) | |||
tmp_cfg_setting_val | tmp_cfg_setting_val | false | false | |||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
cfg_setting_val_id | cfg_setting_val_id | BIGINT | ||||
cfg_setting_owner_type_name | cfg_setting_owner_type_name | cfg_setting_owner_type_name. | VARCHAR(255) | |||
cfg_setting_id | cfg_setting_id | BIGINT | ||||
owner_id | owner_id | BIGINT | ||||
val_type_cd | val_type_cd | val_type_cd. | CHAR(1) | |||
string_val | string_val | string_val. | nvarchar(4000) | |||
text_val | text_val | text_val. | nvarchar(max) | |||
date_val | date_val | datetime | ||||
real_val | real_val | NUMERIC(38,20) | ||||
int_val | int_val | int | ||||
long_val | long_val | BIGINT | ||||
boolean_val | boolean_val | BIT | ||||
val_map_key | val_map_key | val_map_key. | VARCHAR(255) | |||
user_prof | User Profile | false |
A container for Permissions and Settings (the composite parts are the associated Role and the User Preferences). The permissions for a User to access a particular container according to the capabilities defined. In most cases this will be more defined in a subcategory. Example: Shared User Profile This profile will be shared between multiple users that access the system with the same User ID. |
|||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
user_prof_id | User Profile Id | The automatically generated primary key of the user_prof table. | bigint | |||
tmpl_user_prof_id | Template User Profile Id | A Foreign Key to the User Profile table. This will not be a navigable key in the object model. This indicates which Template User Profile was used to create a built-in template in case some features concerning new properties added to later release of the system will need to be added to existing templates. | bigint | |||
role_grp_id | Role Group Id | A Foreign Key to the Role Group table. A system level user profile can have a role group, which will have the effect of assigning a collection of workspace, cmdb, and address book roles at the container role level. | bigint | |||
defn_id | Definition Id | A Foreign Key to the Definition table. Optionally, the container that owns the profile. | bigint | |||
app_role_id | Application Role Id | A Foreign Key to the Application Role table. The User Profile is the means for setting the default role at the system and workspace levels, and is also the role of a Unique User Profile tied to a application user. | bigint | |||
agent_authcn_type_id | Agent Authentication Type Id | A Foreign Key to the Agent Authentication Type table. | int | |||
user_prof_name | User Profile Name | The name of the User Profile. | varchar(255) | |||
is_built_in | Is Built In | Indicates that this instance of User Profile is a built-in instance that cannot be changed by the end user. | bit | |||
user_type_id | User Type Id | A Foreign Key to the User Type table. | int | |||
cust_authcn_type_id | Customer Authentication Type Id | A Foreign Key to the Customer Authentication Type table. | int | |||
is_sys | Is System | Indicates if this is a system level profile. | bit | |||
defn_subtype_id | Definition Subtype Id | A Foreign Key to the Definition Subtype table. | int | |||
delete_date | Delete Date | The value of a User Profile, stored as a date. | datetime | |||
last_login | Last Login | date time of last login in UTC. | datetime | |||
tmpl_level_name | tmpl_level_name | The value of a Built_in_level, stored as a string. | varchar(255) | |||
val_type_cd | Value Type Code | false |
A lookup table for the data value type discriminator. Many tables share this discriminator for name value pair datatypes. Values include: B Boolean D Timestamp - Date + Time I Integer L Long R Real Number S String T Text - long string |
|||
Physical Name | Attribute/Column Name | Definition | Physical Data Type | |||
val_type_cd | Value Type Code | The data type for a Value Type Code. The choices are 'S' string, 'D' date, 'T' text, 'I' integer. | char(1) | |||
val_type_name | Value Type Name | The name of the Value Type Code. | varchar(255) |