Skip Headers
Oracle® Healthcare Master Person Index Relationship Management User's Guide
Release 4.0

E71323-02
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

4 Relationship Management Databases

This release of OHMPI RM supports Oracle Database 11gR2 and later versions for backend storage of data. For the RM service API and RM UI to work properly, you must set up the database correctly.

4.1 Database Requirements

When configuring the relationship management database, there are several factors to consider, including basic software requirements, operating systems, and disk space. This section provides a summary of requirements for the database. For more detailed information about designing and implementing the database, refer to the appropriate database platform documentation. A database administrator is responsible for configuring database. Database administrator must be familiar with your data processing requirements and OHMPI RM database.

4.1.1 Database Platform Requirements

The OHMPI RM database can be run on Oracle 11gR2 or higher. You must have this software installed before beginning the database installation. Make sure you also install the latest patches for the version you are using.

4.1.2 Operating System Requirements

The database can be installed on any operating system supported by the database platform you are using. For more information, see the documentation that came with your database server.

4.1.3 Hardware Requirements

This section describes the minimum recommended hardware configuration for a database installation. These requirements are based on the minimum requirements recommended by Oracle database for a typical installation. Depending on the size of the database and expected volume, you should increase these recommendations as needed. For more information on the database and for supported operating systems, see the documentation that came with the hardware.

4.1.4 Oracle Database

For a Windows database server, Oracle recommends the following configuration as a minimal installation:

  • Windows 2008, 7, Vista SP1+, XP SP2+, 2003 R2 SP2, 2008 R2 on 64 bit

  • Pentium 266 or later

  • 1 GB RAM (increase this based on the number of users, connections to the database, and volume)

  • Virtual memory must be double the amount of RAM

  • 3 GB disk space plus an additional 2 KB for each system record to be stored in the database.

    Note:

    This is a conservative estimate per system record, assuming that most records do not contain complete data.

    This depends on the Oracle environment you install. Enterprise Edition can take up to 5 GB.

  • 256-color video

For a UNIX database server, Oracle recommends the following configuration as a minimal installation:

  • 256 MB RAM (increase this based on the number of users and connections to the database)

  • 2 GB disk space plus an additional 2 KB for each system record to be stored in the database.

    Note:

    This is a conservative estimate per system record, assuming that most records do not contain complete data.
  • Swap space must be a minimum of twice the amount of RAM

Note:

Disk space recommendations do not take into account the volume and processing requirements or the number of users. These are minimal requirements to install a generic database. At a minimum, the empty database and the database software requires 2.5 GB of disk space.

4.2 Setting Up the Database Tables

For information, see Section 2.4, "Creating the Relationship Management Databases".

4.3 Defining the JDBC Connection Pool

OHMPI RM requires one database connection pool. This section provides general instructions for setting up the connection pool. For more information about the procedures, see the online help provided with your server's Administrator Console.

4.3.1 Creating the JDBC Connection Pool and Resource

The JDBC connection pools provide connections to the OHMPI-RM database. A JDBC resource (also known as a data source) gives the RM application the ability to connect to the database.

Before proceeding, make sure you have the relevant information about the OHMPI RM database (such as the database name, URL, database user credentials, and administrator login credentials).

  1. Start and stop the Oracle WebLogic Server. For instructions, see Oracle Fusion Middleware Online Documentation 12c Release 1 (12.1.3).

  2. Launch the Oracle WebLogic Server Administration Console.

  3. Log in using the default user name (weblogic) and password (welcome1).

    The Oracle WebLogic Administration Console appears.

  4. On the left panel, under Domain Structure, expand Services, select JDBC > Data Sources.

    A Summary of JDBC Data Sources appears in the right panel.

  5. To create a new JDBC Data Source, click New at the bottom of the right panel.

    The Settings for a new JDBC Data Source page appears in the right panel of the page.

  6. In the Name field, type RMDataSource.

  7. In the JNDI Name field, type jdbc/RMDataSource.

  8. Click Save.

    A new page appears in the right panel for setting the Database Type.

  9. In the Database Type drop-down list, select the appropriate type (for example, Oracle).

  10. In the Database Driver drop-down list, select the appropriate driver. For example, Oracle's Driver (Thin XA) for Instance Connections; Versions: 9.0.1; 9.2.0; 10, 11.

  11. Click Next.

  12. Click Next.

    Connection Properties appears on the Create a New JDBC Data Source panel.

  13. In the Database Name field, type a name for the database to which you want to connect (for example, orcl).

  14. In the Host Name field, type the name or the IP address of the database server (for example, localhost).

  15. In the Port field, type the port on the database server that is used to connect to the database (for example, 1521, the default for Oracle).

  16. In the Database User Name field, type the database account user name you want to use to create database connections (for example, root).

  17. In the Password field, type a password for your database account to use to create database connections.

  18. In the Confirm Password field, re-type the password to confirm it.

  19. Click Next.

    The Settings for RMDataSource page appear in the right panel.

  20. Click the Connection Pool tab, click Test Configuration, and then click Next.

    Select Targets appears on the Create a New JDBC Data Source page in the right panel. Here you select one or more targets to deploy the new JDBC data source.

  21. In the Servers check box list, select one or more target servers.

    Note:

    If you do not select a target, the data source will be created but not deployed. You will need to deploy the data source at a later time.
  22. Click Finish.

4.4 Dropping the Database Tables

Scripts are provided to drop the default database tables and indexes created in Section 4.2, "Setting Up the Database Tables".

4.4.1 Deleting the Database Tables

  1. Open SQL editor and connect to the OHMPI RM database using the user you created in Section 4.2, "Setting Up the Database Tables".

  2. Open the NetBeans editor and open the following scripts from the <Project_Name>/Database Script directory:

    • drop-ohmpi-rm-audit.sql

    • drop-ohmpi-rm.sql

  3. Copy the entire text from drop-ohmpi-rm-audit.sql and paste into the SQL editor.

  4. Execute the script against the database.

  5. Repeat steps 3 and 4 for drop-ohmpi-rm.sql.

  6. Execute the following command:

    PURGE RECYCLEBIN;
    

4.4.2 Dropping the Text-Indexes

If you had run the text index-search related scripts in Section 4.2, "Setting Up the Database Tables", you must drop them when the OHMPI RM tables are dropped as well.

  1. Open SQL editor and connect to the OHMPI RM database using the user you created in Section 4.2, "Setting Up the Database Tables".

  2. Open the NetBeans editor and open the drop-ohmpi-rm-text-index.sql script from the <Project_Name>/Database Script directory.

  3. Copy the entire text from drop-ohmpi-rm-text-index.sql and paste into the SQL editor.

  4. Execute the script against the database.

  5. Execute the following command:

    PURGE RECYCLEBIN;
    

4.5 Database Structure

This section provides information about the OHMPI Relationship Management database, including description of each table. The relationship management database is the metadata-driven architecture and allowed users to create and modify the relationship metadata on fly. The metadata of the OHMPI relationship management defines the underlying data tables and indexes, the abstract constructs for all the relationship types and relationships. When you create a new relationship type or a new entity type with the built-in default attributes and customer-defined attributes, the OHMPI relationship management does not need to add any additional table in the database.

The relationship management database is composed of the metadata tables, data tables and attributes extension tables. The database includes the tables listed in Table 4-1.

Table 4-1 OHMPI Relationship Management Database Tables

Table Name Description

RM_ENTITY_TYPE

Stores information about the entity types and the default system attributes of the entity types.

RM_RELATIONSHIP_TYPE

Stores information about the relationship types and the default system attributes of the relationship types.

RM_ATTRIBUTE_TYPE

Stores information about the customer-defined attributes for the entity types or the relationship types.

RM_ENTITY

Stores information about the entity instances and the default system attributes of the entity instances.

RM_ENTITY_ATTRIBUTE

Stores information about the customer-defined attributes of entity instances.

RM_RELATIONSHIP

Stores information about the relationship instances and the default system attributes of the relationship instances.

RM_ RELATIONSHIP _ATTRIBUTE

Stores information about the customer-defined attributes of relationship instances.

RM_DOMAIN

Stores information about the OHMPI domains.

RM_RULESET

Stores information about the rulesets for discovering relationships.

RM_TASK

Stores information about the groovy task for the rules, update and event policies.

RM_AUDIT_EVENT

Stores information about the audit events.

RM_AUDIT_SOURCE

Stores information about the sources of the audit events.

RM_AUDIT_OBJECT

Stores information about the objects of the audit events.

RM_RELATIONSHIP_MERGE

Stores information about merging two entities.

RM_CATEGORY

Stores information about the categories of the relationship types. It is not required for this release.


4.5.1 Understanding Database Tables Details

This section describes the detail of each of the OHMPI RM database tables as listed in Table 4-1.

4.5.1.1 RM_ENTITY_TYPE

Table 4-2 Relationship Management Entity Type Database Table

Column Name Data Type Description

ENTITY_TYPE_ID

NUMBER(10)

The primary unique key of the entity type object.

NAME

VARCHAR2(128)

The unique name of the entity type.

DESCRIPTION

VARCHAR2(255)

The description of the entity type.

ID

VARCHAR2(20)

The type of the global unique identifier. It can be EUID of the OHMPI, NPI, MRN, and so on. It is determined by the business needs.

STATUS

VARCHAR2(10)

The status of the entity type. It can be Active or Inactive.


4.5.1.2 RM_RELATIONSHIP_TYPE

Table 4-3 Relationship Management Relationship Type Database Table

Column Name Data Type Description

RELATIONSHIP_TYPE_ID

NUMBER(10)

The primary unique key of the relationship type object.

NAME

VARCHAR2(128)

The unique name of the relationship type.

CATEGORY_ID

NUMBER(10)

The foreign key of the category that this relationship type belongs.

TASK_ID

NUMBER(10)

The foreign key of the task for the relationship update policy for this relationship type.

DESCRIPTION

VARCHAR2(255)

The description of the relationship type.

SOURCE_NAME

VARCHAR2(128)

The name of the source entity type of the relationship type.

TARGET_NAME

VARCHAR2(128)

The name of the target entity type of the relationship type.

DIRECTION

VARCHAR2(20)

The direction of the relationship type. It can be UNIDIRECTIONAL or BIDIRECTIONAL.

MULTIPLICITY

VARCHAR2(20)

The multiplicity of the relationship type. It can be ONETOONE, ONETOMANY, MANYTOONE, or MANYTOMANY.

CREATED_DATE

DATE

The date when the relationship type is created. The date format is configurable.

CREATED_BY

VARCHAR2(32)

The user name that creates the relationship type. It is signed-in user.

MODIFIED_DATE

DATE

The date when the relationship type is updated. The date format is configurable.

MODIFIED_BY

VARCHAR2(32)

The user name that updates the relationship type. It is signed-in user.

EXPIRATION_DATE

DATE

The expiration date of the relationship type. If the relationship type expires, no relationship instance of the relationship type can be created.

EFFECTIVE_DATE

DATE

The effective date of the relationship type. If the relationship type is not effective, no relationship instance can be created.

STATUS

VARCHAR2(10)

The status of the relationship type. It can be Active or Inactive.


4.5.1.3 RM_ATTRIBUTE_TYPE

Table 4-4 Relationship Management Customer-Defined Attribute Type Database Table

Column Name Data Type Description

ATTRIBUTE_TYPE_ID

NUMBER(10)

The primary unique key of the attribute type.

RELATIONSHIP_TYPE_ID

NUMBER(10)

The foreign key of the relationship type for this attribute.

ENTITY_TYPE_ID

NUMBER(10)

The foreign key of the entity type for this attribute.

NAME

VARCHAR2(128)

The unique name of the attribute type.

DATA_TYPE

VARCHAR2(10)

The name of the data type. The supported data types are: String, Char, Float, Double, Date, Boolean, and Timestamp.

DESCRIPTION

VARCHAR2(255)

The description of the attribute type.

SIZE_VALUE

NUMBER(10)

The maximum length of the attribute.

DEFAULT_VALUE

VARCHAR2(128)

The default value of the attribute.

MIN_VALUE

VARCHAR2(128)

The minimum value of the attribute.

MAX_VALUE

VARCHAR2(128)

The maximum value of the attribute.

MANDATORY

CHAR(1)

The mandatory attribute requires value. It can be Y or N.

READ_ONLY

CHAR(1)

Once initialized, it cannot be updated. It can be Y or N.

INDEXED

CHAR(1)

Only indexed attribute is searchable. It can be Y or N.

STATUS

VARCHAR2(10)

The status of the entity type. It can be Active or Inactive.


4.5.1.4 RM_ENTITY

Table 4-5 Relationship Management Entity Database Table

Column Name Data Type Description

ENTITY_ID

NUMBER(20)

The primary unique key of the entity record.

ENTITY_TYPE_ID

NUMBER(10)

The foreign key of the entity type for the entity record.

ID

VARCHAR2(20)

The unique global entity identifier. The ID type is defined by the ID of the entity type.

STATUS

VARCHAR2(10)

The status of the entity type. It can be Active or Inactive.

DOCS_INDEX

VARCHAR2(1024)

The text index is used for Oracle text index internally.


4.5.1.5 RM_ENTITY_ATTRIBUTE

Table 4-6 Relationship Management Entity Customer-Defined Attribute Database Table

Column Name Data Type Description

ENTITY_ATTRIBUTE_ID

NUMBER(20)

The primary unique key of the entity customer-defined attribute.

ENTITY_ID

NUMBER(20)

The foreign key of the entity associated with the attribute.

NAME

VARCHAR2(128)

The name of the attribute.

VALUE

VARCHAR2(128)

The value of the attribute.


4.5.1.6 RM_RELATIONSHIP

Table 4-7 Relationship Management Relationship Database Table

Column Name Data Type Description

RELATIONSHIP_ID

NUMBER(20)

The primary unique key of the relationship record.

RELATIONSHIP _TYPE_ID

NUMBER(10)

The foreign key of the relationship type for the relationship record.

SOURCE_ENTITY_ID

NUMBER(20)

The foreign key of the source entity of the relationship.

TARGET_ENTITY_ID

NUMBER(20)

The foreign key of the target entity of the relationship.

CREATED_DATE

DATE

The date when the relationship is created. The date format is configurable.

CREATED_BY

VARCHAR2(32)

The user name that creates the relationship. It's signed-in user.

MODIFIED_DATE

DATE

The date when the relationship is modified. The date format is configurable.

MODIFIED_BY

VARCHAR2(32)

The user name that modifies the relationship. It's signed-in user.

EXPIRATION_DATE

DATE

The expiration date of the relationship.

EFFECTIVE_DATE

DATE

The effective date of the relationship.

STATUS

VARCHAR2(10)

The status of the entity type. It can be Active, Inactive, or Known. The only Potential relationship is Known.

VALIDITY

VARCHAR2(10)

The validity of the relationship. It can be Potential or Resolved.

DOCS_INDEX

VARCHAR2(1024)

The text index is used for Oracle text index internally.


4.5.1.7 RM_RELATIONSHIP_ATTRIBUTE

Table 4-8 Relationship Management Relationship Customer-Defined Attribute Database Table

Column Name Data Type Description

RELATIONSHIP_ATTRIBUTE_ID

NUMBER(20)

The primary unique key of the relationship customer-defined attribute.

RELATIONSHIP _ID

NUMBER(20)

The foreign key of the relationship associated with the attribute.

NAME

VARCHAR2(128)

The name of the attribute.

VALUE

VARCHAR2(128)

The value of the attribute.


4.5.1.8 RM_DOMAIN

Table 4-9 Relationship Management Domain Database Table

Column Name Data Type Description

DOMAIN_ID

NUMBER(10)

The primary unique key of the domain record.

NAME

VARCHAR2(128)

The unique name of the MPI domain.

URL

VARCHAR2(128)

The Oracle WebLogic JNDI URL of the MPI domain.

USERID

VARCHAR2(128)

The user name of accessing to the Oracle WebLogic JNDI.

PASSWORD

VARCHAR2(128)

The wallet file alias name. Currently, not in use.

JNDINAME

VARCHAR2(128)

JNDI name

OBJECT_XML

CLOB

The OHMPI domain object definition in XML.


4.5.1.9 RM_RULESET

Table 4-10 Relationship Management Ruleset Database Table

Column Name Data Type Description

RULESET_ID

NUMBER(10)

The primary unique key of the ruleset record.

NAME

VARCHAR2(128)

The unique name of the ruleset.

DESCRIPTION

VARCHAR2(255)

The description of the ruleset.

SOURCE

VARCHAR2(128)

The source entity name of the ruleset.

TARGET

VARCHAR2(128)

The target entity name of the ruleset

CREATED_DATE

DATE

The date when the ruleset is created. The date format is configurable.

CREATED_BY

VARCHAR2(32)

The user name that creates the ruleset. It is the signed-in user.

MODIFIED_DATE

DATE

The date when the ruleset is modified. The date format is configurable.

MODIFIED_BY

VARCHAR2(32)

The user name that modifies the relationship. It is the signed-in user.

STATUS

VARCHAR2(10)

The status of the ruleset. It can be Active or Inactive.

RULE_XML

CLOB

The ruleset file in XML format.


4.5.1.10 RM_TASK

Table 4-11 Relationship Management Task Database Table

Column Name Data Type Description

TASK_ID

NUMBER(10)

The primary unique key of the task record.

NAME

VARCHAR2(128)

The unique name of the task.

DESCRIPTION

VARCHAR2(255)

The description of the task.

STATUS

VARCHAR2(10)

The status of the task. It can be Active or Inactive.

TASK_SCRIPT

CLOB

The groovy task file in groovy file extension.


4.5.1.11 RM_AUDIT_EVENT

Table 4-12 Relationship Management Audit Event Database Table

Column Name Data Type Description

AUDIT_EVENT_ID

NUMBER(20)

The primary unique key of the audit event record.

AUDIT_SOURCE_ID

NUMBER(20)

Foreign key of the RM_AUDIT_SOURCE table linked with the audit event.

AUDIT_OBJECT_ID

NUMBER(20)

Foreign key of the RM_AUDIT_OBJECT table linked with the audit event.

EVENT_ACTION_CODE

VARCHAR2(2)

Event type of the REST API. For example, C for Create, U for Update, A for Activate, D for deactivate, R for Read.

EVENT_DATE_TIME

DATE

The date when the audit event is generated.

EVENT_OUTCOME_INDICATOR

VARCHAR2(20)

Indicates if the REST API that was invoked was SUCCESS or FAILURE.

EVENT_TYPE_CODE

VARCHAR2(256)

The type code of the audit event.


4.5.1.12 RM_AUDIT_SOURCE

Table 4-13 Relationship Management Audit Source Database Table

Column Name Data Type Description

AUDIT_SOURCE_ID

NUMBER(20)

The primary unique key of the audit source.

USER_ID

NUMBER(20)

User name of logged in user who invoked the REST API.

ALTERNATIVE_USER_ID

VARCHAR2(20)

The process ID of the local operating system.

ROLE_CODE

VARCHAR2(20)

The role assigned to the user who invoked the REST API.

NETWORK_ACCESS_POINT_TYPE

VARCHAR2(2)

The network access point type.

NETWORK_ACCESS_POINT_ID

VARCHAR2(128)

The network access point ID.


4.5.1.13 RM_AUDIT_OBJECT

Table 4-14 Relationship Management Audit Object Database Table

Column Name Data Type Description

AUDIT_OBJECT_ID

NUMBER(20)

The primary unique key of the audit object record.

OBJECT_TYPE_CODE

VARCHAR2(20)

The object type whose REST API was invoked. For example, EntityType, Domain, and so on.

OBJECTID

VARCHAR2(20)

The object ID whose REST API was invoked.

OBJECT_NAME

CLOB

The object name whose REST API was invoked.

OBJECT_QUERY

VARCHAR2(1024)

Query string of the REST API invoked.

OBJECT_DETAIL

CLOB

Details of the object provided in REST API. Currently, not in use.

SOURCE_OBJECTID

CLOB

The source object ID whose REST API was invoked. Applicable for relationship type and relationship.

SOURCE_OBJECTNAME

CLOB

The source object name whose REST API was invoked. Applicable for relationship type and relationship.

SOURCE_OBJECT_DETAIL

CLOB

Details of the source object provided in REST API. Currently, not in use.

TARGET_OBJECTID

CLOB

The target object ID whose REST API was invoked. Applicable for relationship type and relationship.

TARGET _OBJECTNAME

CLOB

The target object name whose REST API was invoked. Applicable for relationship type and relationship.

TARGET _OBJECT_DETAIL

CLOB

Details of the target object provided in REST API. Currently, not in use.


4.5.1.14 RM_RELATIONSHIP_MERGE

Table 4-15 Relationship Management Merge Database Table

Column Name Data Type Description

RELATIONSHIP_MERGE_ID

NUMBER(20)

The primary unique key of the relationship merge record.

ENTITY_ID

NUMBER(20)

The unique entity ID that merged.

RELATIONSHIP_ID

NUMBER(20)

The relationship ID caused by the merged ID.

ACTION

VARCHAR2(20)

The action of the merge. It can be Create, Deactivate, or Update.


4.5.1.15 RM_CATEGORY

Table 4-16 Relationship Management Category Database Table

Column Name Data Type Description

CATEGORY_ID

NUMBER(10)

The primary unique key of the category record.

NAME

VARCHAR2(128)

The unique name of the category.

DESCRIPTION

VARCHAR2(255)

The description of the category.