Table Detail Report
REQUESTER
| Column Section | Relationship Section | Top of Page |
Table-level Detail
| Description: | Requester |
| Definition: | This is table is used to identify the ROI requesters.This table has requester specific fields such as billable ind, prebill, delivery method... |
| Table Type: | REFERENCE |
Column Detail - REQUESTER
| Column Name | Type | Null? | Definition |
|---|---|---|---|
| ACTIVE_IND | NUMBER | Y | The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc. |
| ACTIVE_STATUS_CD | NUMBER | Y | Indicates the status of the row itself (not the data in the row) such as active, inactive, combined away, pending purge, etc. |
| ACTIVE_STATUS_DT_TM | DATE | Y | The date and time that the active_status_cd was set. |
| ACTIVE_STATUS_PRSNL_ID | NUMBER | Y | The person who caused the active_status_cd to be set or change. |
| APPROVAL_IND | NUMBER | Y | This indicates if a request has bee approved |
| BEG_EFFECTIVE_DT_TM | DATE | Y | The date and time for which this table row becomes effective. Normally, this will be the date and time the row is added, but could be a past or future date and time. |
| BILLABLE_IND | NUMBER | Y | this indicates if the request is billable |
| BILL_TO_ADDRESS_CD | NUMBER | Y | The address type code that the bill will be sent to |
| BILL_TO_ADDRESS_ID | NUMBER | Y | This is the unique key to the address table. |
| BILL_TO_ADDRESS_TYPE_CD | NUMBER | N | bill to address type code |
| BILL_TO_ADDRESS_TYPE_SEQ | NUMBER | N | bill to address type sequence |
| BILL_TO_FAX_ID | NUMBER | Y | This is the unique key to the Phone table |
| BILL_TO_PHONE_ID | NUMBER | Y | This the Phone number associated with the bill to address. It is the unique identifier to the phone table |
| CHARGES_PER_PAGE | FLOAT | Y | This is the charges per page to be billed |
| DELIVERY_METHOD_CD | NUMBER | Y | This is the delivery method |
| END_EFFECTIVE_DT_TM | DATE | Y | The date/time after which the row is no longer valid as active current data. This may be valued with the date that the row became inactive. |
| EXPECTED_TURN_AROUND | NUMBER | Y | This is the expected turn around time |
| LOGICAL_DOMAIN_ID | NUMBER | N | The unique identifier for a logical domain. This identifier allows the data to be grouped by logical domain. For example, If you assign clients a logical_domain_id this would allow you to store data for multiple clients on this table. |
| MAIL_TO_ADDRESS_CD | NUMBER | Y | This is the address type that the request will be mailed to |
| MAIL_TO_ADDRESS_ID | NUMBER | Y | This is the unique identifier to the address table |
| MAIL_TO_ADDRESS_TYPE_CD | NUMBER | N | mail to address type code |
| MAIL_TO_ADDRESS_TYPE_SEQ | NUMBER | N | mail to address type sequence |
| MAIL_TO_FAX_ID | NUMBER | Y | This is the fax phone number associated with the mail to address. This is the unique identifier to the phone table |
| MAIL_TO_PHONE_ID | NUMBER | Y | This is the phone number that is associated with the mail to address. It is the unique identifier to the Phone table. |
| NAME_FIRST | VC2(100) | Y | This column is the first name for a requester or if the requester is an organization then it is the organization name. |
| NAME_FIRST_KEY | VC2(100) | Y | This column is the first name for a requester all capitals with punctuation removed. This field is used for indexing and searching for a requester by name. |
| NAME_FIRST_KEY_A_NLS | VC2(400) | Y | NAME_FIRST_KEY_A_NLS column |
| NAME_FIRST_KEY_NLS | VC2(202) | Y | name first key nls |
| NAME_FULL_FORMATTED | VC2(200) | Y | This is the complete person name including punctuation and formatting. |
| NAME_LAST | VC2(100) | Y | This column is the last name for a requester or if the requester is an organization then it is the organization name. |
| NAME_LAST_KEY | VC2(100) | Y | This column is the last name for a requester or if the requester is an organization then it is the organization name. All capitals with punctuation have been removed. This field is used for indexing and searching for a requester by name. |
| NAME_LAST_KEY_A_NLS | VC2(400) | Y | NAME_LAST_KEY_A_NLS column |
| NAME_LAST_KEY_NLS | VC2(202) | Y | name last key nls |
| PARENT_ENTITY_ID | NUMBER | N | Unique identifier of parent entity table |
| PARENT_ENTITY_NAME | VC2(40) | Y | Name of the parent entity table |
| PREBILL_IND | NUMBER | Y | This indicate if the request need to be pre-billed |
| PREBILL_OVER_IND | NUMBER | Y | Pre-bill if request bill is over this amount |
| REQUESTER_ID | NUMBER | N | This is the value of the unique primary identifier of the requester table. It is an internal system assigned number |
| REQUESTER_SOURCE_CD | NUMBER | Y | This is the type of requester(i.e. Attorneys, Insurance Company) |
| REQUEST_REASON_CD | NUMBER | Y | The reason the request was made |
| SELECTION_CRITERIA_IND | NUMBER | Y | This is the select criteria Indicator |
| UPDT_APPLCTX | NUMBER | N | The application context number from the record info block. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_CNT | NUMBER | N | Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_DT_TM | DATE | N | The date and time the row was last inserted or updated. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_ID | NUMBER | N | The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
| UPDT_TASK | NUMBER | N | The registered (assigned) task number for the process that inserted or updated the row. The UPDT family of columns are typically used for housekeeping and external system process and should never be depended on for solution specific logic. |
Relationship Detail - REQUESTER
| Child Column in REQUESTER(FK) | Parent Table Name | Parent Column Name | |
|---|---|---|---|
| Parents: | BILL_TO_ADDRESS_ID | ADDRESS | ADDRESS_ID |
| MAIL_TO_ADDRESS_ID | ADDRESS | ADDRESS_ID | |
| LOGICAL_DOMAIN_ID | LOGICAL_DOMAIN | LOGICAL_DOMAIN_ID | |
| BILL_TO_FAX_ID | PHONE | PHONE_ID | |
| BILL_TO_PHONE_ID | PHONE | PHONE_ID | |
| MAIL_TO_FAX_ID | PHONE | PHONE_ID | |
| MAIL_TO_PHONE_ID | PHONE | PHONE_ID |
| Parent Column in REQUESTER (PK) | Child Table Name | Child Column Name | |
|---|---|---|---|
| Children: | REQUESTER_ID | ROI_REQUEST | REQUESTER_ID |
| ROI_REQUEST | REQUEST_PARENT_ID | ||
| ROI_REQUEST | ROI_REQUESTER_ID |
REQUESTER_DEFAULTS
| Column Section | Top of Page |
Table-level Detail
| Description: | Requester Defaults table |
| Definition: | This table contains default values for HIM ROI Requesters and Requester Source. |
| Table Type: | REFERENCE |
Column Detail - REQUESTER_DEFAULTS
| Column Name | Type | Null? | Definition |
|---|---|---|---|
| ACTIVE_IND | NUMBER | N | The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc. |
| ACTIVE_STATUS_CD | NUMBER | N | Indicates the status of the row itself (not the data in the row) such as active, inactive, combined away, pending purge, etc. |
| ACTIVE_STATUS_DT_TM | DATE | N | The date and time that the active_status_cd was set. |
| ACTIVE_STATUS_PRSNL_ID | NUMBER | N | The person who caused the active_status_cd to be set or change. |
| AUTHORIZATION_NEEDED_IND | NUMBER | N | Authorization needed indicator |
| BEG_EFFECTIVE_DT_TM | DATE | Y | The date and time for which this table row becomes effective. Normally, this will be the date and time the row is added, but could be a past or future date and time. |
| BILLABLE_IND | NUMBER | N | This indicates if the request is billable |
| DELIVERY_METHOD_CD | NUMBER | N | This is the delivery method |
| END_EFFECTIVE_DT_TM | DATE | Y | The date/time after which the row is no longer valid as active current data. This may be valued with the date that the row became inactive. |
| EXPECTED_TURN_AROUND | NUMBER | N | This is the expected turn around time |
| INVOICE_COMMENTS | VC2(255) | Y | These are comments to be included on invoices. |
| PREBILL_IND | NUMBER | N | This indicate if the request need to be pre-billed |
| PRINT_INV_COMMENTS_IND | NUMBER | N | Indicates if invoice comments should be printed. |
| REQUESTER_DEFAULTS_ID | NUMBER | N | Unique identifier for Requester Defaults table. |
| REQUESTER_ID | NUMBER | N | This is the value of the unique primary identifier of the requester table. It is an internal system assigned number. |
| REQUESTER_SOURCE_CD | NUMBER | N | This is the type of requester(i.e. attorneys, insurance company) |
| REQUEST_REASON_CD | NUMBER | N | The reason the request was made. |
| UPDT_APPLCTX | NUMBER | N | The application context number from the record info block. |
| UPDT_CNT | NUMBER | N | Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. |
| UPDT_DT_TM | DATE | N | The date and time the row was last inserted or updated. |
| UPDT_ID | NUMBER | N | The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. |
| UPDT_TASK | NUMBER | N | The registered (assigned) task number for the process that inserted or updated the row. |
REQUESTER_EVENT_RELTN
| Column Section | Top of Page |
Table-level Detail
| Description: | Requester event relation |
| Definition: | Store the default events(i.e. documents) for a requester |
| Table Type: | REFERENCE |
Column Detail - REQUESTER_EVENT_RELTN
| Column Name | Type | Null? | Definition |
|---|---|---|---|
| ACTIVE_IND | NUMBER | Y | The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc. |
| ACTIVE_STATUS_CD | NUMBER | Y | Indicates the status of the row itself (not the data in the row) such as active, inactive, combined away, pending purge, etc. |
| ACTIVE_STATUS_DT_TM | DATE | Y | The date and time that the active_status_cd was set. |
| ACTIVE_STATUS_PRSNL_ID | NUMBER | Y | The person who caused the active_status_cd to be set or change. |
| BEG_EFFECTIVE_DT_TM | DATE | Y | The date and time for which this table row becomes effective. Normally, this will be the date and time the row is added, but could be a past or future date and time. |
| END_EFFECTIVE_DT_TM | DATE | Y | The date/time after which the row is no longer valid as active current data. This may be valued with the date that the row became inactive. |
| EVENT_CD | NUMBER | Y | Default documents the requester is requesting |
| EVENT_CD_DISP | VC2(40) | Y | This is the display value for the event code |
| REQUESTER_EVENT_RELTN_ID | NUMBER | N | Unique identifier for this table |
| REQUESTER_ID | NUMBER | Y | A unique requester identifier |
| UPDT_APPLCTX | NUMBER | N | The application context number from the record info block. |
| UPDT_CNT | NUMBER | N | Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. |
| UPDT_DT_TM | DATE | N | The date and time the row was last inserted or updated. |
| UPDT_ID | NUMBER | N | The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. |
| UPDT_TASK | NUMBER | N | The registered (assigned) task number for the process that inserted or updated the row. |
REQUEST_EVENT_RELTN
| Column Section | Relationship Section | Top of Page |
Table-level Detail
| Description: | Request Event reltn stores the event codes that are tied to a request |
| Definition: | Requester event reltn ties event_cd to a roi_request |
| Table Type: | ACTIVITY |
Column Detail - REQUEST_EVENT_RELTN
| Column Name | Type | Null? | Definition |
|---|---|---|---|
| ACTIVE_IND | NUMBER | Y | The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc. |
| ACTIVE_STATUS_CD | NUMBER | N | Indicates the status of the row itself (not the data in the row) such as active, inactive, combined away, pending purge, etc. |
| ACTIVE_STATUS_DT_TM | DATE | Y | The date and time that the active_status_cd was set. |
| ACTIVE_STATUS_PRSNL_ID | NUMBER | N | The person who caused the active_status_cd to be set or change. |
| BEG_EFFECTIVE_DT_TM | DATE | Y | The date and time for which this table row becomes effective. Normally, this will be the date and time the row is added, but could be a past or future date and time. |
| END_EFFECTIVE_DT_TM | DATE | Y | The date/time after which the row is no longer valid as active current data. This may be valued with the date that the row became inactive. |
| EVENT_CD | NUMBER | N | This is the event code that is tied to a request |
| EVENT_CD_DISP | VC2(40) | Y | This is the display value for the event code |
| EVENT_CD_DISP_KEY | VC2(40) | Y | The display key for event cd |
| HIM_REQUEST_ID | NUMBER | N | The primary key of him_request table |
| REQUEST_EVENT_RELTN_ID | NUMBER | N | This is the unique identifier to the request event_reltn table, it is a internal system assigned number. |
| REQUEST_STATUS_CD | NUMBER | N | This is the status of the requested event reltn row. |
| REQUEST_STATUS_DT_TM | DATE | Y | This is the date and time that the request was last updated |
| REQUEST_STATUS_PRSNL_ID | NUMBER | N | This is the unique identifier to the person who last updated the status. |
| ROI_REQUEST_ID | NUMBER | N | This is the unique identifier to the roi_request table It is not being used any more. It was replaced by him_request_id |
| UPDT_APPLCTX | NUMBER | N | The application context number from the record info block. |
| UPDT_CNT | NUMBER | N | Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. |
| UPDT_DT_TM | DATE | N | The date and time the row was last inserted or updated. |
| UPDT_ID | NUMBER | N | The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. |
| UPDT_TASK | NUMBER | N | The registered (assigned) task number for the process that inserted or updated the row. |
Relationship Detail - REQUEST_EVENT_RELTN
| Child Column in REQUEST_EVENT_RELTN(FK) | Parent Table Name | Parent Column Name | |
|---|---|---|---|
| Parents: | HIM_REQUEST_ID | HIM_REQUEST | HIM_REQUEST_ID |
| ROI_REQUEST_ID | ROI_REQUEST | ROI_REQUEST_ID |
ROI_INVOICE
| Column Section | Top of Page |
Table-level Detail
| Description: | ROI INVOICE TABLE |
| Definition: | This table hold fields like invoice number and total charges |
| Table Type: | ACTIVITY |
Column Detail - ROI_INVOICE
| Column Name | Type | Null? | Definition |
|---|---|---|---|
| ACTIVE_IND | NUMBER | Y | The table row is active or inactive. A row is generally active unless it is in an inactive state such as logically deleted, combined away, pending purge, etc. |
| ACTIVE_STATUS_CD | NUMBER | N | Indicates the status of the row itself (not the data in the row) such as active, inactive, combined away, pending purge, etc. |
| ACTIVE_STATUS_DT_TM | DATE | Y | The date and time that the active_status_cd was set. |
| ACTIVE_STATUS_PRSNL_ID | NUMBER | N | The person who caused the active_status_cd to be set or change. |
| BALANCE | FLOAT | Y | This is the balance due for this invoice |
| BEG_EFFECTIVE_DT_TM | DATE | Y | The date and time for which this table row becomes effective. Normally, this will be the date and time the row is added, but could be a past or future date and time. |
| CHARGE_COMMENT | VC2(255) | Y | This includes any comments for charge adjustments. |
| COST_PER_PAGE | FLOAT | Y | This is the cost per page charged on this invoice |
| END_EFFECTIVE_DT_TM | DATE | Y | The date/time after which the row is no longer valid as active current data. This may be valued with the date that the row became inactive. |
| INITIAL_BILL_DT_TM | DATE | Y | This is the date and time of the first billing. |
| INVOICE_COMMENTS | VC2(255) | Y | These are comments to be included on invoices. |
| INVOICE_NUMBER | NUMBER | Y | This is a number assigned to this invoice |
| NUM_PAGES_COPIED | NUMBER | Y | This is the number of pages copied |
| PRINT_CHARGE_COMMENT_IND | NUMBER | N | Indicates if charge comments should be printed on invoice. |
| PRINT_INVOICE_COMMENTS_IND | NUMBER | N | Indicates if invoice comments should be printed. |
| REQUESTER_ID | NUMBER | N | This is the value of the unique primary identifier of the Requester table. It is an internal system assigned number. |
| REQUESTER_SOURCE_CD | NUMBER | N | requester source code |
| REQUEST_ID | NUMBER | N | This is the value of the unique primary identifier of the roi_request table. It is an internal system assigned number. |
| REQUEST_NUMBER | FLOAT | N | Request number |
| ROI_INVOICE_ID | NUMBER | N | This is the value of the unique primary identifier of the roi_invoice table. It is an internal system assigned number. |
| TOTAL_ADJUSTED_CHARGES | FLOAT | Y | This is the actual total of charges for the invoice including any adjustments. |
| TOTAL_ADJUSTED_IND | NUMBER | N | Indicates if the total adjusted charges has been modified from the total charges |
| TOTAL_CHARGES | FLOAT | Y | This is the total Charges for this invoice |
| TOTAL_ELECTRONIC_PAGES | NUMBER | N | This is the total number of electronic pages retrieved for the invoice. |
| TOTAL_MICROFILM_PAGES | NUMBER | N | This is the total number of microfilm pages retrieved for the invoice. |
| TOTAL_PAID | FLOAT | N | this is the total paid on this invoice |
| TOTAL_PAPER_PAGES | NUMBER | Y | This is the total number of paper pages retrieved for the invoice. |
| UPDT_APPLCTX | NUMBER | N | The application context number from the record info block. |
| UPDT_CNT | NUMBER | N | Set to 0 on insert. Incremented by 1 on update. Used to recognize update conflict where data in a row updated by one application is at risk of being lost by a second application attempting to update the row. |
| UPDT_DT_TM | DATE | N | The date and time the row was last inserted or updated. |
| UPDT_ID | NUMBER | N | The person_id of the person from the personnel table (prsnl) that caused the last insert or update of the row in the table. |
| UPDT_TASK | NUMBER | N | The registered (assigned) task number for the process that inserted or updated the row. |