SAS Enterprise Case Management 6.3. Data Dictionary

Transcription

1 SAS Enterprise Case Management 6.3 Data Dictionary

2 The correct bibliographic citation for this manual is as follows: SAS Institute Inc SAS Enterprise Case Management 6.3: Data Dictionary. Cary, NC: SAS Institute Inc. SAS Enterprise Case Management 6.3: Data Dictionary Copyright 2015, SAS Institute Inc., Cary, NC, USA All rights reserved. Produced in the United States of America. For a hard-copy book: No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, or otherwise, without the prior written permission of the publisher, SAS Institute Inc. For a web download or e-book: Your use of this publication shall be governed by the terms established by the vendor at the time you acquire this publication. The scanning, uploading, and distribution of this book via the Internet or any other means without the permission of the publisher is illegal and punishable by law. Please purchase only authorized electronic editions and do not participate in or encourage electronic piracy of copyrighted materials. Your support of others rights is appreciated. U.S. Government License Rights; Restricted Rights: The Software and its documentation is commercial computer software developed at private expense and is provided with RESTRICTED RIGHTS to the United States Government. Use, duplication or disclosure of the Software by the United States Government is subject to the license terms of this Agreement pursuant to, as applicable, FAR , DFAR (a), DFAR (a) and DFAR and, to the extent required under U.S. federal law, the minimum restricted rights as set out in FAR (DEC 2007). If FAR is applicable, this provision serves as notice under clause (c) thereof and no other notice is required to be affixed to the Software or documentation. The Government's rights in Software and documentation shall be only those set forth in this Agreement. SAS Institute Inc., SAS Campus Drive, Cary, North Carolina January 2015 SAS provides a complete selection of books and electronic products to help customers use SAS software to its fullest potential. For more information about our offerings, visit sas.com/store/books or call SAS and all other SAS Institute Inc. product or service names are registered trademarks or trademarks of SAS Institute Inc. in the USA and other countries. indicates USA registration. Other brand and product names are trademarks of their respective companies.

3 Data Dictionary Table Name : CASE_CONFIG DefineDefines the rules which determine the ui definition to display for a given case, based on the case type, category and subcategory values. If a record includes null for category or subcategory, that is treated as a wildcard and that rule would apply for any value in that column. In situations where multiple rules apply, the sequence number is treated as the priority; the matching rule with the smallest sequence number will be selected. Option Type CASE_CONFIG_SEQ_NO Case sequence number. CASE_TYPE_CD Case type code. CASE_CATEGORY_CD Case category code. CASE_SUBCATEGORY_CD Case subcategory code. UI_DEF_FILE_NM User interface definition file name. INVESTIGATE_WORKFLOW_DEF_NM Investigate case workflow definition name. REOPEN_WORKFLOW_DEF_NM Reopen case workflow definition name. INVESTIGATOR_USER_ID Investigator who initially owns the case. Table Name : CASE_CONFIG_X_USER_GROUP Intersection table linking the initial groups of users who can access a case to a case configuration. Option Type CASE_CONFIG_SEQ_NO Case sequence number. USER_GROUP_NM User group name. Table Name : CASE_LIVE Details of a case involving one or more suspicious incidents. This table contains the current version of the Case. Option Type CASE_RK System-generated case surrogate key. VALID_TO_DTTM CASE_ID VARCHAR2(64) Case identifier. SOURCE_SYSTEM_CD Source system code. Page 1 of 48

4 Table Name : CASE_LIVE Details of a case involving one or more suspicious incidents. This table contains the current version of the Case. Option Type CASE_TYPE_CD Case type code. CASE_CATEGORY_CD Case category code. CASE_SUBCATEGORY_CD Case sub-category code. CASE_STATUS_CD Case status code. CASE_DISPOSITION_CD Case disposition code. CASE_DESC Case description. CASE_LINK_SK PRIORITY_CD REGULATORY_RPT_RQD_FLG System generated surrogate key for linking related cases. The priority code of a case is used for sorting (for example, High, Medium, and Low). Regulatory report required flag. INVESTIGATOR_USER_ID Investigator who owns the case. OPEN_DTTM Date and time when the cae was opened. REOPEN_DTTM Date and time when the case was last re-opened. CLOSE_DTTM Date and time when the case was closed. UI_DEF_FILE_NM Custom Page Builder user interface file name. CREATE_USER_ID User who created the case. CREATE_DTTM Date and time when the case was created. UPDATE_USER_ID User who last updated the case. VERSION_NO DELETE_FLG Version number used to implement optimistic locking. This flag indicates whether or not the case has been logically deleted and is now obsolete. Table Name : CASE_SEARCH_CRITERIA_FIELD Contains search criteria field configurations for the case search screen. Option Type USER_ID TABLE_NM User who this configuration applies to. Equals '*' for the default configuration for all users. Field table name. FIELD_NM Field name. DISPLAY_ORDER_NO NUMBER(6) Display order number. REF_TABLE_NM FORMAT_TXT VARCHAR2(40) Reference table name to render a selection list criteria filter for the field. Name of the resource bundle key that contains the display format for numeric fields. Page 2 of 48

5 Table Name : CASE_SEARCH_FILTER_FIELD Contains search filter field configurations for the case search screen. Option Type USER_ID TABLE_NM User who this configuration applies to. Equals '*' for the default configuration for all users. Field table name. FIELD_NM Field name. DISPLAY_ORDER_NO NUMBER(6) Display order number. REF_TABLE_NM Reference table name to render a selection list filter for the field. Table Name : CASE_SEARCH_RESULT_FIELD Contains search result field configurations for the case search screen. Option Type USER_ID TABLE_NM User who this configuration applies to. Equals '*' for the default configuration for all users. Field table name. FIELD_NM Field name. DISPLAY_ORDER_NO NUMBER(6) Display order number. REF_TABLE_NM FORMAT_TXT VARCHAR2(40) Reference table name to render coded values as displayable values. Contains one of two values: 1) A user_name - In this case the column is expected to be a user id, and that user's display name is looked up and rendered. 2) A number format understood by the java.text.decimalformat class. If this column contains a number format and the field type is BIGINT or DOUBLE, the number format is used to render the field value. Table Name : CASE_UDF_CHAR_VALUE Contains character data typed user defined field values for cases. Option Type CASE_RK System generated case surrogate key. ROW_NO Row number. VARCHAR2(4000) User-defined field value. Page 3 of 48

6 Table Name : CASE_UDF_DATE_VALUE Contains date data typed user defined field values for cases. Option Type CASE_RK System generated case surrogate key. ROW_NO Row number. User-defined field value. Table Name : CASE_UDF_DEF Details of user defined field definitions for cases. Option Type UDF_TYPE_NM UDF_DESC User-defined field data type (VARCHAR, BIGINT, DOUBLE, BOOLEAN, DATE, ). User-defined field description. MAX_CHAR_CNT REF_TABLE_NM NUMBER(6) Maximum number of characters for a CHAR data typed user-defined field. The name of the (optional) reference table used to display values for this field. Table Name : CASE_UDF_LGCHR_VALUE Contains CLOB datatypes for user defined field values for cases. Option Type CASE_RK System generated case surrogate key. ROW_NO Row number. CLOB User-defined field value. Page 4 of 48

7 Table Name : CASE_UDF_NUM_VALUE Contains number data typed user defined field values for cases. Option Type CASE_RK System generated case surrogate key. ROW_NO Row number. DOUBLE PRECISION User-defined field value. Table Name : CASE_VERSION Details of a case involving one or more suspicious incidents. Option Type CASE_RK System generated case surrogate key. VALID_TO_DTTM CASE_ID VARCHAR2(64) Case identifier. SOURCE_SYSTEM_CD Source system code. CASE_TYPE_CD Case type code. CASE_CATEGORY_CD Case category code. CASE_SUBCATEGORY_CD Case sub-category code. CASE_STATUS_CD Case status code. CASE_DISPOSITION_CD Case disposition code. CASE_DESC Case description. CASE_LINK_SK PRIORITY_CD REGULATORY_RPT_RQD_FLG System generated surrogate key for linking related cases. The priority code of a case is used for sorting (for example, High, Medium, and Low). Regulatory report required flag. INVESTIGATOR_USER_ID Investigator who owns the case. OPEN_DTTM Date and time when the case was opened. REOPEN_DTTM Date and time when the case was last re-opened. CLOSE_DTTM Date and time when the case was closed. Page 5 of 48

8 Table Name : CASE_VERSION Details of a case involving one or more suspicious incidents. Option Type UI_DEF_FILE_NM Custom Page Builder user interface file name. CREATE_USER_ID User who created the case. CREATE_DTTM Date and time when the case was created. UPDATE_USER_ID User who last updated the case. VERSION_NO DELETE_FLG Version number used to implement optimistic locking. This flag indicates whether or not the Case has been logically deleted and is now obsolete. Table Name : CASE_X_PARTY Intersection table linking parties to cases. Option Type CASE_RK System-generated case surrogate key. PARTY_RK System-generated party retained surrogate key. RELATION_TYPE_CD Relationship type code. RELATION_DESC Relationship description. CREATE_DTTM Date and time when the case and party relationship was created. Table Name : CASE_X_USER_GROUP Intersection table linking cases to groups of users who can access the case. Option Type CASE_RK System generated case surrogate key. USER_GROUP_NM User group name. Equals '*' if any user may access the case. Table Name : ECM_COLUMN_LABEL Contains column label translation information. Option Type SOURCE_NM OBJECT_NM The source of the translation entry. Valid values are 'application' if the label translation comes from the standard application translation files or 'custom' if they come from one of the custom properties files. The name of the object that the label is associated with. Valid values include 'CASE', 'INCIDENT', 'PARTY', 'FINANCIAL_ITEM' or '*' if the label applies to all objects. Page 6 of 48

9 Table Name : ECM_COLUMN_LABEL Contains column label translation information. Option Type TABLE_NM COLUMN_NM LOCALE LABEL_TXT VARCHAR2(5) The name of the object or the name of the user-defined table that the column is associated with. The name of the column that the label is associated with. A locale supported by the application. The locale should follow the Java locale naming convention: a valid two-letter lowercase ISO 639 language code optionally appended with an underscore and a two-letter uppercase ISO 3166 country code. The translated label. Table Name : ECM_ENTITY_LOCK Allows any user-editable ECM object to be locked before editing. Option Type ENTITY_RK ENTITY_NM A sequential system generated key. A surrogate key is added in the ETL process to ensure a unique identifier. May be used with validity date ranges in order to establish historical changes in the data. Entity name. LOCK_USER_ID LOCK_DTTM User ID that is locking the SAS Enterprise Case Management object. Date and time the lock on the object occurred. Table Name : ECM_EVENT Consolidated audit trail table for all objects. Option Type EVENT_RK System generated event surrogate key. BUSINESS_OBJECT_NM BUSINESS_OBJECT_RK EVENT_TYPE_CD Name of the type of object this event is associated with: CASE, INCIDENT, PARTY, RR, EFILE. Key value of the event that is associated with this object. Event type code. EVENT_DESC VARCHAR2(256) Event description. CREATE_USER_ID User who created the event. CREATE_DTTM Date and time when the event was created. LINKED_OBJECT_NM Linked object name. LINKED_OBJECT_RK Linked object surrogate key. Page 7 of 48

10 Table Name : ECM_LOCALE Contains localization data supported by the application. Option Type LOCALE FALLBACK_LOCALE VARCHAR2(5) VARCHAR2(5) A locale supported by the application. The locale should follow the Java locale naming convention: a valid two-letter lowercase ISO 639 language code optionally appended with an underscore and a two-letter uppercase ISO 3166 country code. The locale to consult next if there is no translation available for the locale specified by the LOCALE column. For example, if en_gb is a supported locale, it s fallback would be en. If the supported locale is en, then the fallback would be the default. Table Name : ECM_TABLE_LABEL Contains table label translation information. Option Type SOURCE_NM OBJECT_NM TABLE_NM LOCALE LABEL_TXT VARCHAR2(5) The source of the translation entry. Valid values are 'application' if the label translation comes from the standard application translation files or 'custom' if they come from one of the custom properties files. The name of the object that the label is associated with. Valid values include 'CASE', 'INCIDENT', 'PARTY', 'FINANCIAL_ITEM' or '*' if the label applies to all objects. The name of the table that the label is associated with. A locale supported by the application. The locale should follow the Java locale naming convention: a valid two-letter lowercase ISO 639 language code optionally appended with an underscore and a two-letter uppercase ISO 3166 country code. The translated label. Table Name : EFILE_CONFIG DefineDefines the rules which determine the ui definition to display for a given efile, based on the efile s type, category and subcategory values. If a record includes null for category or subcategory, that is treated as a wildcard and that rule would apply for any value in that column. In situations where multiple rules apply, the sequence number is treated as the priority; the matching rule with the smallest sequence number will be selected. Option Type EFILE_CONFIG_SEQ_NO E-file configuration record sequence number. EFILE_TYPE_CD First code to classify an e-file. EFILE_CATEGORY_CD Second code to classify an e-file. EFILE_SUBCATEGORY_CD Third code to classify an e-file. UI_DEF_FILE_NM FORM_AGENCY_CD File name of the user interface definition to be used for the type of e-file. Unique code to define the government agency who published the form. Page 8 of 48

11 Table Name : EFILE_CONFIG DefineDefines the rules which determine the ui definition to display for a given efile, based on the efile s type, category and subcategory values. If a record includes null for category or subcategory, that is treated as a wildcard and that rule would apply for any value in that column. In situations where multiple rules apply, the sequence number is treated as the priority; the matching rule with the smallest sequence number will be selected. Option Type FORM_TYPE_CD Unique code to define the government form published by the agency defined in FORM_AGENCY_CD. Table Name : EFILE_CONFIG_X_USER_GROUP Intersection table linking the initial groups of users who can access an efile to an efile configuration Option Type EFILE_CONFIG_SEQ_NO USER_GROUP_NM Key to link e-file configuration record to a user group. Unique key to link the user group with an e-file configuration record. Table Name : EFILE_LIVE Details of an efile. This table contains the current version of the efile. Option Type EFILE_RK VALID_TO_DTTM EFILE_ID VARCHAR2(64) Since source data for EFILE_LIVE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for EFILE_LIVE. Used with valid_from_dttm for versioning of rows. E-file identifier within the source system. SOURCE_SYSTEM_CD FORM_CONFIG_RK EFILE_TYPE_CD EFILE_CATEGORY_CD EFILE_SUBCATEGORY_CD Source system code.efile_id and SOURCE_SYSTEM_CD unique identity an e-file record. Since source data for EFILE_LIVE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for EFILE_LIVE. Used with valid_from_dttm for versioning of rows. E-file Type Code. First code to classify an efile. First code to classify an efile. E-file category code. Second code to classify an efile. E-file subcategory code. Third code to classify an efile. Page 9 of 48

12 Table Name : EFILE_LIVE Details of an efile. This table contains the current version of the efile. Option Type EFILE_STATUS_CD EFILE_DESC OUTPUT_PATH_NM E-file status code, such as A for accepted and R for Rejected. Description of the e-file entered by the user or set by the batch program. Subdirectory where the output e-file is stored. OUTPUT_NM Name of the output e-file. OUTPUT_RR_CNT Number of reports in the output e-file. OUTPUT_LINE_CNT Number of lines in the output e-file. OUTPUT_FILE_SIZE Size of the output e-file. OUTPUT_CREATE_DTTM Date and time when the output is created. TRANSMISSION_ID TRANSMISSION_DTTM Transmission ID provided by the agency after an e-file is submitted. Date and time when the e-file was transmitted. EFILE_AGENCY_REF_ID EFILE_AGENCY_STATUS_CD COVERAGE_START_DT DATE The reference ID provided by the agency to identify an accepted Efile. It is equivalent to Document Control Number from FINCEN. The e-file status provided by the agency. For example: Accepted, Accepted with Warnings, Rejected. Date of the earliest report activity in the e-file. COVERAGE_END_DT DATE Date of the latest report activity in the e-file. CORRECTION_FLG Flag indicates if it is correction report. OWNER_USER_ID User who initially owns the report. UI_DEF_FILE_NM User interface definition file name. CREATE_USER_ID The ID of the user that added the record. CREATE_DTTM The date and time when the record was added. UPDATE_USER_ID The ID of the user who updated the record. VERSION_NO The date and time when the record was updated. DELETE_FLG A flag indicating whether the record is active. Table Name : EFILE_SEARCH_CRITERIA_FIELD Contains search criteria field configurations for the case search screen. Option Type USER_ID TABLE_NM FIELD_NM DISPLAY_ORDER_NO NUMBER(6) User who this configuration applies to. Equals '*' for the default configuration for all users. Table name of the field that is use for searching efiles. Field name of the field that is used for searching efiles. Order number for displaying the search fields in the e-file search UI. Page 10 of 48

13 Table Name : EFILE_SEARCH_CRITERIA_FIELD Contains search criteria field configurations for the case search screen. Option Type REF_TABLE_NM FORMAT_TXT VARCHAR2(40) Reference table name to render a selection list criteria filter for the field. Name of the resource bundle key that contains the display format for numeric fields. Table Name : EFILE_SEARCH_FILTER_FIELD Contains search filter field configurations for the case search screen. Option Type USER_ID TABLE_NM FIELD_NM DISPLAY_ORDER_NO REF_TABLE_NM NUMBER(6) User who this configuration applies to. Equals '*' for the default configuration for all users. Table name of field that can be used for filtering e-files. Field name of the field that can be used for filtering e-files. Order number for displaying the search fields in the e-file filter UI. Reference table name to render a selection list filter for the field. Table Name : EFILE_SEARCH_RESULT_FIELD Contains search result field configurations for the case search screen. Option Type USER_ID TABLE_NM FIELD_NM DISPLAY_ORDER_NO REF_TABLE_NM FORMAT_TXT NUMBER(6) VARCHAR2(40) User who this configuration applies to. Equals '*' for the default configuration for all users. Table name of the field that will be displayed in the search result list. Field name of the field that will be displayed in the search result list. Order number for displaying the fields for filtering e-files. Reference table name to render coded values as displayable values. Contains one of two values: 1) A user_name - In this case the column is expected to be a user id, and that user's display name is looked up and rendered. 2) A number format understood by the java.text.decimalformat class. If this column contains a number format and the field type is BIGINT or DOUBLE, the number format is used to render the field value. Table Name : EFILE_UDF_CHAR_VALUE Contains character data typed user defined field values for cases. Option Type Page 11 of 48

14 Table Name : EFILE_UDF_CHAR_VALUE Contains character data typed user defined field values for cases. Option Type EFILE_RK Since source data for EFILE_UDF_CHAR_VALUE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for EFILE_UDF_CHAR_VALUE. Used with valid_from_dttm for versioning of rows. ROW_NO Row number of the UDF table VARCHAR2(4000) Value of the user defined field (char). Table Name : EFILE_UDF_DATE_VALUE Contains date data typed user defined field values for cases. Option Type EFILE_RK Since source data for EFILE_UDF_DATE_VALUE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for EFILE_UDF_DATE_VALUE. Used with valid_from_dttm for versioning of rows. ROW_NO Row number of the UDF table. User-defined field value (date). Table Name : EFILE_UDF_DEF Details of user defined field definitions for cases. Option Type UDF_TYPE_NM UDF_DESC User-defined field data type (VARCHAR, BIGINT, DOUBLE, BOOLEAN, DATE, ). User-defined field description. Page 12 of 48

15 Table Name : EFILE_UDF_DEF Details of user defined field definitions for cases. Option Type MAX_CHAR_CNT REF_TABLE_NM NUMBER(6) Maximum number of characters for a CHAR data typed user defined field. The name of the (optional) reference table used to display values for this field. Table Name : EFILE_UDF_LGCHR_VALUE Contains CLOB datatypes for user defined field values for cases. Option Type EFILE_RK Since source data for EFILE_UDF_LGCHR_VALUE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for EFILE_UDF_LGCHR_VALUE. Used with valid_from_dttm for versioning of rows. ROW_NO Row number. CLOB User-defined field value. Table Name : EFILE_UDF_NUM_VALUE Contains number data typed user defined field values for cases. Option Type EFILE_RK Since source data for EFILE_UDF_NUM_VALUE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for EFILE_UDF_NUM_VALUE. Used with valid_from_dttm for versioning of rows. ROW_NO Row number. DOUBLE PRECISION User-defined field value. Page 13 of 48

16 Table Name : EFILE_VERSION Details of an efile. This table contains all versions of the efile. Option Type EFILE_RK VALID_TO_DTTM EFILE_ID VARCHAR2(64) Since source data for EFILE_VERSION may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for EFILE_VERSION. Used with valid_from_dttm for versioning of rows. The e-file indentifier within the source system. SOURCE_SYSTEM_CD FORM_CONFIG_RK EFILE_TYPE_CD The EFILE_ID and SOURCE_SYSTEM_CD unique identity an e-file record. Since source data for EFILE_VERSION may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for EFILE_VERSION. Used with valid_from_dttm for versioning of rows. E-file type code. EFILE_CATEGORY_CD E-file category code. EFILE_SUBCATEGORY_CD E-file subcategory code. EFILE_STATUS_CD E-file status code. EFILE_DESC E-file description OUTPUT_PATH_NM Subdirectory where the output e-file is stored. OUTPUT_NM Name of the output e-file. OUTPUT_RR_CNT Number of reports in the output e-file. OUTPUT_LINE_CNT Number of lines in the output e-file. OUTPUT_FILE_SIZE Size of the output e-file. OUTPUT_CREATE_DTTM Date and time when the output is created. TRANSMISSION_ID TRANSMISSION_DTTM Transmission ID provided by the agency after an e-fle is submitted. Date and time when the e-file was transmitted. EFILE_AGENCY_REF_ID EFILE_AGENCY_STATUS_CD COVERAGE_START_DT DATE The reference ID provided by the agency to identify an accepted Efile. It is equivalent to Document Control Number from FINCEN. The e-file status provided by the agency. For example: Accepted, Accepted with Warnings, and Rejected. Date of the earliest report activity in the e-file. COVERAGE_END_DT DATE Date of the latest report activity in the e-file. CORRECTION_FLG Flag indicates if it is correction report Page 14 of 48

17 Table Name : EFILE_VERSION Details of an efile. This table contains all versions of the efile. Option Type OWNER_USER_ID User who initially owns the report. UI_DEF_FILE_NM User interface definition file name. CREATE_USER_ID The ID of the user that added the record. CREATE_DTTM The date and time when the record was added. UPDATE_USER_ID The ID of the user who updated the record. VERSION_NO The date and time when the record was updated. DELETE_FLG A flag indicating whether the record is active. Table Name : EFILE_X_USER_GROUP Intersection table linking efiles to groups of users who can access the efile. Option Type EFILE_RK USER_GROUP_NM Since source data for EFILE_X_USER_GROUP may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for EFILE_X_USER_GROUP. Used with valid_from_dttm for versioning of rows. User group name. Table Name : FINANCIAL_ITEM_CONFIG The financial_item config table maps which ui definition to use for each financial_item type. The financial_item_config tablediffers from the other config tables. Financial items are configured solely on the financial_item type code. Case, Incident and Party are configured based on type, category and sub-category. Option Type FINANCIAL_ITEM_CONFIG_SEQ_NO FINANCIAL_ITEM_TYPE_CD UI_DEF_FILE_NM The primary key for the FINANCIAL_ITEM_CONFIG table. The financial item type being configured. This value should reference an entry in the financial item type reference table (stored in the REF_TABLE_VALUE table with REF_TABLE_NM = RT_FINANCIAL_ITEM_TYPE ). The UI definition file to use for financial items of the given financial item type. Table Name : FINANCIAL_ITEM_LIVE A Financial Item is associated with a Case or an Incident and stores the monetary value associated with a suspicious transaction or exposure. This table contains the current version of the Financial Item. Option Type Page 15 of 48

18 Table Name : FINANCIAL_ITEM_LIVE A Financial Item is associated with a Case or an Incident and stores the monetary value associated with a suspicious transaction or exposure. This table contains the current version of the Financial Item. Option Type FINANCIAL_ITEM_RK FINANCIAL_ITEM_ID VARCHAR2(64) Since source data for FINANCIAL_ITEM_LIVE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for FINANCIAL_ITEM_LIVE. Used with valid_from_dttm for versioning of rows. Financial item ID. SOURCE_SYSTEM_CD FINANCIAL_ITEM_TYPE_CD The source system from which this financial item originated. This value should reference an entry in the source system reference table (stored in the REF_TABLE_VALUE table with REF_TABLE_NM = RT_SOURCE_SYSTEM ). Financial item type code. LOCAL_AMT REAL Local amount. LOCAL_CURRENCY_CD Local currency code. BASE_AMT REAL Base amount. CURRENCY_CONVERSION_DT DATE Currency conversion date. PARENT_OBJECT_NM PARENT_OBJECT_RK SOURCE_FINANCIAL_ITEM_RK UI_DEF_FILE_NM The parent object name links a financial item to a case or an incident, along with the surrogate key of that parent object. This key links the financial item to a case or an incident. This contains the key to link multiple financial items together. Custom Page Builder user interface file name. INCLUDE_IN_SUMMARY_FLG Include in summary flag. CREATE_USER_ID User who created the financial item. CREATE_DTTM Date and time of the financial item. UPDATE_USER_ID User who last updated the financial item. VALID_TO_DTTM VERSION_NO Version number. DELETE_FLG Has the financial item been logically deleted? Table Name : FINANCIAL_ITEM_UDF_CHAR_VALUE Contains character data typed user defined field values for cases. Option Type Page 16 of 48

19 Table Name : FINANCIAL_ITEM_UDF_CHAR_VALUE Contains character data typed user defined field values for cases. Option Type FINANCIAL_ITEM_RK Since source data for FINANCIAL_ITEM_UDF_CHAR_VALUE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for FINANCIAL_ITEM_UDF_CHAR_VALUE. Used with valid_from_dttm for versioning of rows. ROW_NO Row number. VARCHAR2(4000) User-defined field value. Table Name : FINANCIAL_ITEM_UDF_DATE_VALUE Contains date data typed user defined field values for financial items. Option Type FINANCIAL_ITEM_RK Since source data for FINANCIAL_ITEM_UDF_DATE_VALUE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for FINANCIAL_ITEM_UDF_DATE_VALUE. Used with valid_from_dttm for versioning of rows. ROW_NO Row number. User-defined field value. Table Name : FINANCIAL_ITEM_UDF_DEF Details of user defined field definitions for financial items. Option Type UDF_TYPE_NM User-defined field data type (VARCHAR, BIGINT, DOUBLE, BOOLEAN, DATE, ). Page 17 of 48

20 Table Name : FINANCIAL_ITEM_UDF_DEF Details of user defined field definitions for financial items. Option Type UDF_DESC User-defined field description. MAX_CHAR_CNT REF_TABLE_NM NUMBER(6) Maximum number of characters for a CHAR data typed user defined field. The name of the (optional) reference table used to display values for this field. Table Name : FINANCIAL_ITEM_UDF_LGCHR_VALUE Contains CLOB datatypes for Financial Items. Option Type FINANCIAL_ITEM_RK Since source data for FINANCIAL_ITEM_UDF_LGCHR_VALUE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for FINANCIAL_ITEM_UDF_LGCHR_VALUE. Used with valid_from_dttm for versioning of rows. ROW_NO Row Number CLOB User-defined field value. Table Name : FINANCIAL_ITEM_UDF_NUM_VALUE Contains number data typed user defined field values for financial items. Option Type FINANCIAL_ITEM_RK Since source data for FINANCIAL_ITEM_UDF_NUM_VALUE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for FINANCIAL_ITEM_UDF_NUM_VALUE. Used with valid_from_dttm for versioning of rows. ROW_NO Row number. Page 18 of 48

21 Table Name : FINANCIAL_ITEM_UDF_NUM_VALUE Contains number data typed user defined field values for financial items. Option Type DOUBLE PRECISION User-defined field value. Table Name : FINANCIAL_ITEM_VERSION A Financial Item is associated with a Case or an Incident and stores the monetary value associated with a suspicious transaction or exposure. Option Type FINANCIAL_ITEM_RK FINANCIAL_ITEM_ID VARCHAR2(64) Since source data for FINANCIAL_ITEM_VERSION may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for FINANCIAL_ITEM_VERSION. Used with valid_from_dttm for versioning of rows. Financial item ID. SOURCE_SYSTEM_CD Source system code. FINANCIAL_ITEM_TYPE_CD Financial item type code. LOCAL_AMT REAL Local amount. LOCAL_CURRENCY_CD Local currency code. BASE_AMT REAL Base amount. CURRENCY_CONVERSION_DT DATE Currency conversion date. PARENT_OBJECT_NM PARENT_OBJECT_RK SOURCE_FINANCIAL_ITEM_RK UI_DEF_FILE_NM The parent object name links a financial item to a case or an incident, along with the surrogate key of that parent object. This key links the financial item to a case or an incident. This contains the key to link multiple financial items together. Custom Page Builder user interface file name. INCLUDE_IN_SUMMARY_FLG Include in summary flag CREATE_USER_ID User who created the financial item. CREATE_DTTM Date and time of the financial item. UPDATE_USER_ID User who last updated the financial item. VALID_TO_DTTM VERSION_NO Version number. DELETE_FLG Has the financial item been logically deleted? Page 19 of 48

22 Table Name : FORM_CONFIG Form configuration table to link report and efile configuration Option Type FORM_CONFIG_RK FORM_AGENCY_CD FORM_TYPE_CD FORM_COUNTRY_CD VARCHAR2(3) A sequential system generated key A surrogate key is added in the ETL process to ensure a unique identifier. May be used with validity date ranges in order to establish historical changes in the data. A unique code to identify the government agency that published the form. A unique code to identify the government form published by the agency defined in FORM_AGENCY_CD. A three character country code of the form. EFFECTIVE_FROM_DTTM EFFECTIVE_TO_DTTM FORM_DESC Start datetime when the form is effective to use. This field is for documentation purpose only. It is not used to determine if the form is effective. End datetime when the form is effective. in this column is used to indicate that the form is currently effective. The description of the form. PREVIEW_MIME_TYPE_CD VARCHAR2(255) The standard mimetype of the preview report. PREVIEW_FILE_PREFIX The common prefix of all preview templates. PREVIEW_DRIVER_PGM_NM PREVIEW_PREPROCESS_PGM_NM EFILE_FILE_PREFIX EFILE_DRIVER_PGM_NM EFILE_PREPROCESS_PGM_NM EFILE_MAX_RR_CNT CREATE_USER_ID NUMBER(6) The SAS macro to be called by the ECMRR_PREVIEW stored process. The SAS macro to be called by the preview driver program for transforming the RR data into form-ready data. The name of the output folder that will be used to store the output files. The SAS macro to be called by the EFILE Driver stored process. The SAS macro to be called by the EFILE Driver program for transforming the RR data into e-file-ready data. Indicates the maximum number of RR (reports) that can be included in an efile for that particular form. The ID of the user that added the record. CREATE_DTTM The datetime when the record was added. UPDATE_USER_ID The ID of the user who updated the record. UPDATE_DTTM The datetime when the record was updated. DELETE_FLG A flag indicating whether the record is active. Table Name : FORM_EFILE_FIELD_CONFIG Defines the mapping of the source data fields to the target fields in EFILE. Option Type FORM_CONFIG_RK A sequential system generated key A surrogate key is added in the ETL process to ensure a unique identifier. May be used with validity date ranges in order to establish historical changes in the data. Page 20 of 48

23 Table Name : FORM_EFILE_FIELD_CONFIG Defines the mapping of the source data fields to the target fields in EFILE. Option Type FORM_EFILE_RECORD_SEQ_NO FORM_EFILE_FIELD_SEQ_NO TARGET_FIELD_START_POS_NO TARGET_FIELD_END_POS_NO TARGET_FIELD_NM TARGET_FIELD_LENGTH_NO TARGET_FIELD_DESC SOURCE_FIELD_NM SOURCE_FIELD_NUM_FLG SOURCE_FIELD_EXP VARCHAR2(1000) VARCHAR2(4000) The sequence number used to uniquely identify the record type of an e-flie. The sequence number used to uniquely identify the data fields of an e-file. The start position of the e-file field published by the government agency. The end position of the e-file field published by the government agency. The name of the e-file field published by the government agency. The length of the e-file field published by the government agency. The description of the e-file field published by the government agency. The name of the field in the source table to be used for populating the form fields. A flag that indicates if the source field or the result of the source field expression is numeric. The expression used to transform the source field. SAS_FORMAT_NM VARCHAR2(40) The name of the SAS format used to output the source field or the result of the source field expression. If the field is missing, the default format will be used. Table Name : FORM_EFILE_RECORD_CONFIG Controls the records of the output efile. Option Type FORM_CONFIG_RK FORM_EFILE_RECORD_SEQ_NO FORM_EFILE_RECORD_ID FORM_EFILE_RECORD_DESC VARCHAR2(1000) A sequential system generated key A surrogate key is added in the ETL process to ensure a unique identifier. May be used with validity date ranges in order to establish historical changes in the data. The sequence number used to uniquely identify the record type of an e-file. The ID used to uniquely identify the record type of an e-file. The description of the e-file record. RECORD_SORT_ORDER_NO RECORD_LENGTH_NO The order number in which the records will be placed into the e-file. The record length of the w-file. SOURCE_TABLE_NM PAGE_BY_FIELD_NM The name of the source table that will be used to populate the e-file record. The name of the field for grouping the depending records together. For example, for FINCEN, the page types are BATCH, INSTITUTION, BRANCH an RR. Page 21 of 48

24 Table Name : FORM_PREVIEW_FIELD_CONFIG Defines the mapping of the source data fields to the form fields. Option Type FORM_CONFIG_RK FORM_PREVIEW_SECTION_SEQ_NO FORM_PREVIEW_FIELD_SEQ_NO SOURCE_FIELD_NM SOURCE_FIELD_NUM_FLG SOURCE_FIELD_EXP NUMBER(10,2) VARCHAR2(4000) A sequential system generated key A surrogate key is added in the ETL process to ensure a unique identifier. May be used with validity date ranges in order to establish historical changes in the data. The sequence number used to uniquely identify the form templates of a form. The sequence number used to uniquely identify the form fields in the form template. The name of the source table field to be used for populating the form fields. A flag that indicates if the source field or the result of the source field expression is numeric. The expression used to transform the source field. TARGET_FIELD_NM TARGET_FIELD_TYPE_CD TARGET_FIELD_TYPE_PARM_LIST VARCHAR2(1000) The name of the form field defined in the form template. The code for each type of form field. For example P1, P2, P3 and other depending on the number of parameters defined in the list. The list of ' ' separated parameters to be passed to the macros. Table Name : FORM_PREVIEW_SECTION_CONFIG Controls the sections of the output efile. Option Type FORM_CONFIG_RK FORM_PREVIEW_SECTION_SEQ_NO FORM_PREVIEW_SECTION_ID SECTION_DESC VARCHAR2(1000) A sequential system generated key A surrogate key is added in the ETL process to ensure a unique identifier. May be used with validity date ranges in order to establish historical changes in the data. The sequence number used to uniquely identify the form templates of a form. The ID used to uniquely identify each form template. The description of the form template. SECTION_ORDER_NO SECTION_FILE_SUFFIX The order number in which the form templates will be placed into the final output. The suffix of the file name for the form template. SOURCE_TABLE_NM The name of the source table used to populate the form template. Table Name : GENERIC_DATA_UDF_CHAR_VALUE Contains character data types for generic user defined values. Option Type Page 22 of 48

25 Table Name : GENERIC_DATA_UDF_CHAR_VALUE Contains character data types for generic user defined values. Option Type GENERIC_DATA_RK Since source data for GENERIC_DATA_UDF_CHAR_VALUE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for GENERIC_DATA_UDF_CHAR_VALUE. Used with valid_from_dttm for versioning of rows. VALID_TO_DTTM VARCHAR2(4000) User-defined field value. Table Name : GENERIC_DATA_UDF_DATE_VALUE Contains date data types for generic user defined values Option Type GENERIC_DATA_RK Since source data for GENERIC_DATA_UDF_DATE_VALUE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for GENERIC_DATA_UDF_DATE_VALUE. Used with valid_from_dttm for versioning of rows. VALID_TO_DTTM User-defined field value. Page 23 of 48

26 Table Name : GENERIC_DATA_UDF_DEF Details of user defined field definitions for a generic item. Option Type UDF_TYPE_NM UDF_DESC User-defined field data type (VARCHAR, BIGINT, DOUBLE, BOOLEAN, DATE, ). User-defined field description. MAX_CHAR_CNT REF_TABLE_NM NUMBER(6) Maximum number of characters for a CHAR data typed user-defined field. The name of the (optional) reference table used to display values for this field. Table Name : GENERIC_DATA_UDF_LGCHR_VALUE Contains CLOB data types for generic user defined values Option Type GENERIC_DATA_RK Since source data for GENERIC_DATA_UDF_LGCHR_VALUE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for GENERIC_DATA_UDF_LGCHR_VALUE. Used with valid_from_dttm for versioning of rows. VALID_TO_DTTM CLOB User-defined field value. Table Name : GENERIC_DATA_UDF_NUM_VALUE Contains number data types for generic user defined values. Option Type GENERIC_DATA_RK Since source data for GENERIC_DATA_UDF_NUM_VALUE may come from multiple systems, the business supplied keys may not be unique. A surrogate key is added in the ETL process to ensure a unique identifier for GENERIC_DATA_UDF_NUM_VALUE. Used with valid_from_dttm for versioning of rows. Page 24 of 48

27 Table Name : GENERIC_DATA_UDF_NUM_VALUE Contains number data types for generic user defined values. Option Type VALID_TO_DTTM DOUBLE PRECISION User-defined field value. Table Name : INCIDENT_CONFIG Defines the rules which determine the ui definition to display for a given incident, based on the incidnet s type, category and subcategory values. If a record includes null for category or subcategory, that is treated as a wildcard and that rule would apply for any value in that column. In situations where multiple rules apply, the sequence number is treated as the priority; the matching rule with the smallest sequence number will be selected. Option Type INCIDENT_CONFIG_SEQ_NO INCIDENT_TYPE_CD Incident configuration sequence number. The sequence number is also used as a priority when multiple configurations apply for a given incident. If multiple configurations apply, the one with the smaller sequence number will be chosen. Incident type code. INCIDENT_CATEGORY_CD Incident category code. INCIDENT_SUBCATEGORY_CD Incident subcategory code. UI_DEF_FILE_NM User interface definition file name. Table Name : INCIDENT_CONFIG_X_USER_GROUP Intersection table linking the initial groups of users who can access an incident to an incident configuration. Option Type INCIDENT_CONFIG_SEQ_NO Incident configuration sequence number. USER_GROUP_NM User group name. Table Name : INCIDENT_LIVE Details of a suspicious incident. This table contains the current version of the Incident. Option Type INCIDENT_RK System generated incident surrogate key. Page 25 of 48

28 Table Name : INCIDENT_LIVE Details of a suspicious incident. This table contains the current version of the Incident. Option Type VALID_TO_DTTM CASE_RK System generated case surrogate key. INCIDENT_ID VARCHAR2(64) Incident identifier. SOURCE_SYSTEM_CD Source system code. INCIDENT_TYPE_CD Incident type code. INCIDENT_CATEGORY_CD Incident category code. INCIDENT_SUBCATEGORY_CD Incident sub-category code. INCIDENT_DESC Incident description. INCIDENT_FROM_DT DATE Incident start date. INCIDENT_FROM_TM CHAR(8) Incident start time (format = HH:MM:SS). INCIDENT_TO_DT DATE Incident end date. INCIDENT_TO_TM CHAR(8) Incident end time (format = HH:MM:SS). DETECTION_DT DATE Incident detection date. DETECTION_TM CHAR(8) Incident detection time (format = HH:MM:SS). NOTIFICATION_DT DATE Incident notification date. NOTIFICATION_TM CHAR(8) Incident notification time (format = HH:MM:SS). UI_DEF_FILE_NM Custom Page Builder user interface file name. CREATE_USER_ID User who created the incident. CREATE_DTTM Date and time when the incident was created. UPDATE_USER_ID User who last updated the incident. VERSION_NO DELETE_FLG Version number used to implement optimistic locking. Has the incident been logically deleted? INVESTIGATOR_USER_ID Investigator for the incident. INCIDENT_DISPOSITION_CD Incident disposition code. CLOSE_DTTM Date and time when the incident was closed. INCIDENT_STATUS_CD Incident status code. Page 26 of 48

29 Table Name : INCIDENT_SEARCH_CRITERIA_FIELD Contains search criteria field configurations for the incident search screen. Option Type USER_ID TABLE_NM User who this configuration applies to. Equals '*' for the default configuration for all users. Field table name. FIELD_NM Field name. DISPLAY_ORDER_NO NUMBER(6) Display order number. REF_TABLE_NM FORMAT_TXT VARCHAR2(40) Reference table name to render a selection list criteria filter for the field. Name of the resource bundle key that contains the display format for numeric fields. Table Name : INCIDENT_SEARCH_FILTER_FIELD Contains search filter field configurations for the incident search screen. Option Type USER_ID TABLE_NM User who this configuration applies to. Equals '*' for the default configuration for all users. Field table name. FIELD_NM Field name. DISPLAY_ORDER_NO NUMBER(6) Display order number. REF_TABLE_NM Reference table name to render a selection list filter for the field. Table Name : INCIDENT_SEARCH_RESULT_FIELD Contains search result field configurations for the incident search screen. Option Type USER_ID TABLE_NM User who this configuration applies to. Equals '*' for the default configuration for all users. Field table name. FIELD_NM Field name. DISPLAY_ORDER_NO NUMBER(6) Display order number. REF_TABLE_NM FORMAT_TXT VARCHAR2(40) Reference table name to render coded values as displayable values. Contains one of two values: 1) A user_name - In this case the column is expected to be a user id, and that user's display name is looked up and rendered. 2) A number format understood by the java.text.decimalformat class. If this column contains a number format and the field type is BIGINT or DOUBLE, the number format is used to render the field value. Page 27 of 48

30 Table Name : INCIDENT_UDF_CHAR_VALUE Contains character data typed user defined field values for incidents. Option Type INCIDENT_RK System generated incident surrogate key. ROW_NO Row number. VARCHAR2(4000) User-defined field value. Table Name : INCIDENT_UDF_DATE_VALUE Contains date data typed user defined field values for incidents. Option Type INCIDENT_RK System generated incident surrogate key. ROW_NO Row number. User-defined field value. Table Name : INCIDENT_UDF_DEF Details of user defined field definitions for incidents. Option Type UDF_TYPE_NM UDF_DESC User-defined field data type (VARCHAR, BIGINT, DOUBLE, BOOLEAN, DATE, ). User-defined field description. MAX_CHAR_CNT REF_TABLE_NM NUMBER(6) Maximum number of characters for a CHAR data typed user defined field. The name of the (optional) reference table used to display values for this field. Page 28 of 48

31 Table Name : INCIDENT_UDF_LGCHR_VALUE Contains CLOB or long character data typed user defined field values for incidents. Option Type INCIDENT_RK System-generated incident surrogate key. ROW_NO Row number. CLOB User-defined field value. Table Name : INCIDENT_UDF_NUM_VALUE Contains number data typed user defined field values for incidents. Option Type INCIDENT_RK System-generated incident surrogate key. ROW_NO Row number. DOUBLE PRECISION User-defined field value. Table Name : INCIDENT_VERSION Details of a suspicious incident. Option Type INCIDENT_RK System generated incident surrogate key. VALID_TO_DTTM CASE_RK System-generated case surrogate key. INCIDENT_ID VARCHAR2(64) Incident identifier. Page 29 of 48

32 Table Name : INCIDENT_VERSION Details of a suspicious incident. Option Type SOURCE_SYSTEM_CD Source system code. INCIDENT_TYPE_CD Incident type code. INCIDENT_CATEGORY_CD Incident category code. INCIDENT_SUBCATEGORY_CD Incident sub-category code. INCIDENT_DESC Incident description. INCIDENT_FROM_DT DATE Incident start date. INCIDENT_FROM_TM char(8) Incident start time (format = HH:MM:SS). INCIDENT_TO_DT DATE Incident end date. INCIDENT_TO_TM char(8) Incident end time (format = HH:MM:SS). DETECTION_DT DATE Incident detection date. DETECTION_TM char(8) Incident detection time (format = HH:MM:SS). NOTIFICATION_DT DATE Incident notification date. NOTIFICATION_TM char(8) Incident notification time (format = HH:MM:SS). UI_DEF_FILE_NM Custom Page Builder user interface file name. CREATE_USER_ID User who created the incident. CREATE_DTTM Date and time when the incident was created. UPDATE_USER_ID User who last updated the incident. VERSION_NO DELETE_FLG char(1) Version number used to implement optimistic locking. Has the incident been logically deleted? INVESTIGATOR_USER_ID Investigator for the incident. INCIDENT_DISPOSITION_CD Incident disposition code. CLOSE_DTTM Date and time when the incident was closed. INCIDENT_STATUS_CD Incident status code. Table Name : INCIDENT_X_PARTY Intersection table linking parties to incidents. Option Type INCIDENT_RK System-generated incident surrogate key. PARTY_RK System-generated party retained surrogate key. RELATION_TYPE_CD Relationship type code. RELATION_DESC Relationship description. CREATE_DTTM Date and time when the incident/party relationship was created. Page 30 of 48

33 Table Name : INCIDENT_X_USER_GROUP Intersection table linking incidents to groups of users who can access the indicent. Option Type INCIDENT_RK System-generated incident surrogate key. USER_GROUP_NM User group name. Equals '*' if any user may access the incident. Table Name : PARTY_CONFIG Defines the rules which determine the ui definition to display for a given party, based on the party s type, category and subcategory values. If a record includes null for category or subcategory, that is treated as a wildcard and that rule would apply for any value in that column. In situations where multiple rules apply, the sequence number is treated as the priority; the matching rule with the smallest sequence number will be selected. Option Type PARTY_CONFIG_SEQ_NO PARTY_TYPE_CD Party configuration sequence number. The sequence number is also used as a priority when multiple configurations apply for a given party. If multiple configurations apply, the one with the smaller sequence number will be chosen. Party type code. PARTY_CATEGORY_CD Party category code. PARTY_SUBCATEGORY_CD Party sub-category code. UI_DEF_FILE_NM Custom Page Builder user interface definition file name. Table Name : PARTY_CONFIG_X_USER_GROUP Intersection table linking the initial groups of users who can access a party to a party configuration. Option Type PARTY_CONFIG_SEQ_NO Party configuration sequence number. USER_GROUP_NM User group name. Table Name : PARTY_LIVE Details of an individual or organization that plays a role in a case or a suspicious incident. This table contains the current version of the Party. Option Type PARTY_RK System-generated party retained surrogate key. VALID_TO_DTTM PARTY_ID VARCHAR2(64) Party identifier. Page 31 of 48