Database Tables
All KB_ and LCL_ tables have the following fields:
| Name | Description |
|---|---|
| OWNER | For customer owned data: should be displayed as R.customer.instance For all data distributed by ExL, the owner should be otb |
| AVAILABLE_FOR | In LCL_ tables, the field is used to indicate to whom the local data pertains – either DEFAULT or a specific group/institute. The format is either R.customer.instance or R.customer.instance.institute In KB_ tables, the field is used to indicate for whom the entry is visible in KBManager. The format is R.customer.instance or R.customer.instance.institute |
| CREATION_DATE | Date the DB entry was created |
| CREATED_BY | Name of the SFX administrator user that created the DB entry |
| LAST_UPDATE_DATE | Date the DB entry was last updated |
| LAST_UPDATED_BY | Name of the SFX administrator user that last updated the DB entry |
All KB_ tables have the following fields:
| Name | Value | Description |
|---|---|---|
| VERSION_NUMBER | DCS version number | |
| RELEASE_NUMBER | Revision release number | |
| CRUD_TYPE | Create-Read-Update-Delete - stores latest change of DB record |
Only the KB_ tables listed in Table have the following additional fields:
- KB_INTERFACES
- KB_OBJECTS
- KB_OBJECT_IDENTIFIERS
- KB_OBJECT_PORTFOLIOS
- KB_RELATIONS
- KB_TARGETS
- KB_TARGET_SERVICES
- KB_MULTILANGUAGE
List of KB_ Tables
List of LCL_ Tables
| Table Name | Field Name | Field Value | Field Description |
|---|---|---|---|
| LCL_CAT | CAT_ID | Internal ID | |
| CAT_NORMALIZED | will store the local category information - after normalization | ||
| CAT_DISPLAY | will store the local category information - for display purposes | ||
| LCL_CAT_ASSIGN | CAT_ASSIGN_INTERNAL_ID | CAT_ASSIGN_ID | Internal ID |
| CAT_SUBCAT_INTERNAL_ID | Internal ID of a local category/subcategory combination | ||
| OBJECT_ID | Internal ID of the object | ||
| LCL_CAT_SUBCAT | CAT_SUBCAT_INTERNAL_ID | CAT_SUBCAT_ID | Internal ID |
| CAT_ID | Internal ID of a local category | ||
| SUBCAT_ID | Internal ID of a local subcategory | ||
| LCL_LINKING_PARAMETERS | INTERNAL_ID | Internal ID | |
| LINKING_PARAM_ID | Internal ID of KB_LINKING_PARAMETERS entry for which value is stored | ||
| VALUE | Stores linking parameter value | ||
| LCL_MULTILANGUAGE | MULTILANGUAGE_INTERNAL_ID | Internal ID | |
| MULTILANGUAGE_GROUP | SFX application in which translation element is used | ||
| MULTILANGUAGE_MESSAGE_CODE | HTML template code to refer to this translation element | ||
| MULTILANGUAGE_MESSAGE_DETAILS | Description for this translation element | ||
| MULTILANGUAGE_LANGUAGE_CODE | Language of the multilanguage translation element - using 3-letter ISO 639-2 standard language code | ||
| MULTILANGUAGE_MESSAGE_TEXT | Actual value for this translation element | ||
| LCL_OBJECT_IDENTIFIERS | OBJECT_IDENTIFIER_ID | Internal ID | |
| OBJECT_ID | Internal ID of the object | ||
| TYPE | Identifier type - table is currently only used to store LOCAL attribute | ||
| SUB_TYPE | Identifier subtype | ||
| VALUE | Value | ||
| LCL_OBJECT_PORTFOLIO_INVENTORY | INTERNAL_ID | Internal ID | |
| OP_ID | Internal ID of KB_OBJECT_PORTFOLIOS entry for which activation information is stored | ||
| ACTIVATION_STATUS | ACTIVE, INACTIVE | Activation status | |
| DEACTIVATION_REASON | Reason for deactivation | ||
| LCL_OBJECT_PORTFOLIO_LINKING_INFO | INTERNAL_ID | Internal ID | |
| OP_ID | Internal ID of KB_OBJECT_PORTFOLIOS entry for which activation information is stored | ||
| AUTHENTICATION_NOTE | Authentication note - will be displayed in SFX menu to endusers | ||
| PUBLIC_NOTE | General note - will be displayed in SFX menu to endusers | ||
| INTERNAL_DESCRIPTION | Internal description - used by SFX administrator for internal purposes | ||
| TARGET_PARSER_PROGRAM | Override of KB_ TARGET_PARSER_PROGRAM value | ||
| PARSE_PARAM | Override of KB_ PARSE_PARAM value | ||
| THRESHOLD | Override of KB_ THRESHOLD value | ||
| LCL_SERVICE_INVENTORY | INTERNAL_ID | Internal ID | |
| TARGET_ID | Internal ID of KB_TARGETS entry for which activation information is stored | ||
| TARGET_SERVICE_ID | Internal ID of KB_TARGET_SERVICES entry for which activation information is stored | ||
| AUTO_ACTIVE | YES, NO, INHERIT |
If field is set to 'YES', this means that during updates, new OP will be added as ACTIVE, in case the KB_TARGET_SERVICE has a LCL_SERVICE_INVENTORY record with ACTIVATION_STATUS set to be ACTIVE. If field is set to 'NO', this means that during updates, new OP will be added as INACTIVE. Ifi field is set to 'INHERIT', this means inherit behavior from value from the KB_TARGETS AGGREGATOR field. |
|
| ACTIVATION_STATUS | ACTIVE, INACTIVE | Activation status | |
| DEACTIVATION_REASON | Reason for deactivation | ||
| SITE_DOWN | 0, 1 |
Field is either set in KBManager or triggered by Verde soap service. When a TARGET_SERVICE has status SITE DOWN, then SFX menu will display an icon that shows that the target service is down. Additionally, the ‘Go’ button and link to target window not be presented, instead a text saying site down will appear |
|
| SITE_DOWN_DATE | Site_down_date can be used to describe, for the SFX administrator, the date of the downtime. | ||
| SITE_DOWN_REASON | site_down_reason can be used to describe, for the SFX administrator, in more details the reason of the downtime. | ||
| LCL_SERVICE_LINKING_INFO | INTERNAL_ID | Internal ID | |
| TARGET_SERVICE_ID | Internal ID of KB_TARGET_SERVICES entry for which activation information is stored | ||
| SERVICE_PUBLIC_DESCRIPTION | Text describing service - will be displayed in SFX menu to endusers - overrides default text describing service | ||
| AUTHENTICATION_NOTE | Authentication note - will be displayed in SFX menu to endusers | ||
| PUBLIC_NOTE | General note - will be displayed in SFX menu to endusers | ||
| INTERNAL_DESCRIPTION | Internal description - used by SFX administrator for internal purposes | ||
| TARGET_PARSER_PROGRAM | Override of KB_ TARGET_PARSER_PROGRAM value | ||
| PARSE_PARAM | Override of KB_ PARSE_PARAM value | ||
| TARGET_DISPLAYER_PROGRAM | Override of KB_ THRESHOLD value | ||
| PROXY_ENABLED | Used for selective proxy use | ||
| OBJECT_LOOKUP | Y, N, INHERIT | Local field to override KB_SOURCE_SERVICES OBJECT_LOOKUP field | |
| CROSSREF_ENABLED | INHERIT, NO | Local field to override KB_SOURCE_SERVICES CROSSREF_ENABLED field | |
| THRESHOLD | Override of KB_ THRESHOLD value | ||
| LCL_SOURCE_LINKING_INFO | INTERNAL_ID | Internal ID | |
| SOURCE_ID | Internal ID of KB_SOURCES entry for which activation information is stored | ||
| INTERNAL_DESCRIPTION | Internal description - used by SFX administrator for internal purposes | ||
| SHOW_AVAILABILITY | YES, NO, INHERIT | Field to override the KB_SOURCES SHOW_AVAILABILITY value (by setting this option to 'Yes' will make sure the availability information (available from 2009, 12, 1 until …') is shown in the SFX menu screen for a particular SOURCE) | |
| LCL_SOURCE_SERVICE_INVENTORY | INTERNAL_ID | Internal ID | |
| SOURCE_ID | Internal ID of KB_SOURCES entry for which activation information is stored | ||
| SOURCE_SERVICE_ID | Internal ID of KB_SOURCE_SERVICES entry for which activation information is stored | ||
| ACTIVATION_STATUS | ACTIVE, INACTIVE | Activation status | |
| DEACTIVATION_REASON | Reason for deactivation | ||
| LCL_SUBCAT | SUBCAT_ID | Internal ID | |
| SUBCAT_NORMALIZED | will store the local subcategory information - after normalization | ||
| SUBCAT_DISPLAY | will store the local subcategory information - for display purposes | ||
| LCL_TARGET_INVENTORY | INTERNAL_ID | Internal ID | |
| TARGET_ID | Internal ID of KB_TARGETS entry for which activation information is stored | ||
| ACTIVATION_STATUS | ACTIVE, INACTIVE | Activation status | |
| DEACTIVATION_REASON | Reason for deactivation | ||
| SITE_DOWN | Y, N | Field for future use only - not displayed in KBManager | |
| SITE_DOWN_REASON | SITE_NOT_AVAILABLE | Field for future use only - not displayed in KBManager | |
| SITE_DOWN_DATE | Field for future use only - not displayed in KBManager | ||
| LCL_TARGET_LINKING_INFO | INTERNAL_ID | Internal ID | |
| TARGET_ID | Internal ID of KB_TARGET | ||
| TARGET_PUBLIC_NAME | Override of KB_TARGET public name | ||
| AUTHENTICATION_NOTE | Authentication note - will be displayed in SFX menu to endusers | ||
| PUBLIC_NOTE | General note - will be displayed in SFX menu to endusers | ||
| INTERNAL_DESCRIPTION | Internal description - used by SFX administrator for internal purposes | ||
| THRESHOLD | Override of KB_ THRESHOLD value | ||
| LCL_TITLE | INTERNAL_ID | Internal ID | |
| TITLE_ID | Internal ID of the corresponding KB_TITLE entry | ||
| OBJECT_ID | Internal ID of the object | ||
| TITLE_VALUE | title value | ||
| NON_FILING_CHAR | stores the number of characters at the beginning of a title which should be ignored when sorting. By default or when no non‐filing character is loaded, the value will be ‘0’. | ||
| LCL_TITLE_KEYS | TITLE_KEY_ID | Internal ID | |
| OBJECT_ID | Internal ID of the object | ||
| TITLE_ID | Internal ID of the corresponding title | ||
| TITLE_KEY_USE | SEARCH', 'SORT', 'BOTH | defines what title will be used for - searching or sorting purposes | |
| TITLE_KEY_TYPE | generalDiacritics', 'diacriticsGerman', 'diacriticsSwedish', 'diacriticsDanish', 'diacriticsUSA, Hangul', 'PinyinNormalization', 'StrokeSequence', 'StrokeCount', 'Katakana', 'Hiragana', 'KoreanNormalization, JapaneseNormalization', 'ChineseNormalization, TaiwaneseNormalization | title key type | |
| TITLE_KEY_VALUE | title value | ||
| NON_FILING_CHAR | stores the number of characters at the beginning of a title which should be ignored when sorting. By default or when no non‐filing character is loaded, the value will be ‘0’. | ||
| LCL_TRANS_CAT | CAT_ID | Internal ID of KB_CAT table | |
| CAT_TRANS_NORMALIZED | will store the translated version of the global category information provided by ExL - after normalization | ||
| CAT_TRANS_DISPLAY | will store the translated version of the global category information provided by ExL - for display purposes | ||
| LCL_TRANS_SUBCAT | SUBCAT_ID | Internal ID of KB_SUBCAT table | |
| SUBCAT_TRANS_NORMALIZED | will store the translated version of the global subcategory information provided by ExL - after normalization | ||
| SUBCAT_TRANS_DISPLAY | will store the translated version of the global subcategory information provided by ExL - for display purposes | ||
| CONTROL | CONTROL_INTERNAL_ID | Internal ID of CONTROL table | |
| CONTROL_GROUP | Group of configuration settings | ||
| CONTROL_SECTION | Section within configuration group | ||
| INSTITUTE_ID | Institute ID information | ||
| CONTROL_NAME | Configuration setting name | ||
| CONTROL_VALUE | Configuration setting value | ||
| CONTROL_VARTYPE | SCALAR, ARRAY | ||
| INSTITUTE_IP | INSTITUTE_IP_ID | Internal ID of INSTITUTE_IP table | |
| INSTITUTE_ID | |||
| INSTITUTE_IP_FROM | |||
| INSTITUTE_IP_TO | |||
| INSTITUTE | INSTITUTE_ID | Internal ID of INSTITUTE table | |
| INSTITUTE_NAME | |||
| INSTITUTE_TYPE | I, G | ||
| SYNONYM | INSTITUTE_ID | Internal ID of SYNONYM table | |
| SYNONYM_ID | |||
| SYNONYM_RANK | |||
| SFX_REQUEST | INTERNAL_ID | Internal ID of KB_SFX_REQUEST table | |
| SERIALIZED | |||
| SERVICES | |||
| MODIFIED | |||
| STAT_OBJECT and | REQUEST_ID | Internal ID | |
| STAT_OBJECT_OFFLINE | ISSN | ||
| ISBN | |||
| LCCN | |||
| LOCAL | |||
| TITLE | |||
| ATITLE | |||
| JTITLE | |||
| BTITLE | |||
| CTITLE | |||
| SERIES | |||
| PUBLISHER | |||
| PLACE_OF_PUBLICATION | |||
| OBJECT | |||
| SUBCATEGORY | |||
| STATUS | |||
| DOI | |||
| DATE | |||
| TIME | |||
| SOURCE | |||
| IP | |||
| OBJECT_TYPE | |||
| INSTITUTE | |||
| USER_GROUP | |||
| FACULTY | |||
| HAS_FULLTXT | |||
| DATE_OF_PUBLICATION | |||
| SPAGE | |||
| EPAGE | |||
| PRESENTATION_FORMAT | |||
| SESSION_ID | |||
| OPEN_URL | |||
| STAT_REPEATABLES and | INTERNAL_ID | Internal ID | |
| STAT_REPEATABLES_OFFLINE | REQUEST_ID | ||
| ATTRIBUTE | |||
| VALUE | |||
| STAT_TARGET_SERVICE and | REQUEST_ID | ||
| STAT_TARGET_SERVICE_OFFLINE | TARGET | ||
| CLICKS | |||
| SERVICE | |||
| URL | |||
| USERS | INTERNAL_ID | Internal ID of USERS table | |
| USER_ID | |||
| PASSWORD | |||
| PROFILE | |||
| NAME | |||
| DESCRIPTION | |||
| INSTITUTE_ID | |||
| SESSION_ID | |||
ERD Diagram
The following diagram illustrates the connections between objects (with title and Identifier information), targets, target services and object portfolios. It includes connections from the global KB_ tables to LCL_ tables with inventory and local linking information.